Display & Video 360 API . googleAudiences

Instance Methods

get(googleAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)

Gets a Google audience.

list(filter=None, pageToken=None, pageSize=None, advertiserId=None, orderBy=None, partnerId=None, x__xgafv=None)

Lists Google audiences.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(googleAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)
Gets a Google audience.

Args:
  googleAudienceId: string, Required. The ID of the Google audience to fetch. (required)
  advertiserId: string, The ID of the advertiser that has access to the fetched Google audience.
  partnerId: string, The ID of the partner that has access to the fetched Google audience.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a Google audience resource.
      # Includes Google audience lists.
    "googleAudienceType": "A String", # Output only. The type of Google audience.
        # .
    "googleAudienceId": "A String", # Output only. The unique ID of the Google audience. Assigned by the system.
    "name": "A String", # Output only. The resource name of the google audience.
    "displayName": "A String", # Output only. The display name of the Google audience.
        # .
  }
list(filter=None, pageToken=None, pageSize=None, advertiserId=None, orderBy=None, partnerId=None, x__xgafv=None)
Lists Google audiences.

The order is defined by the order_by
parameter.

Args:
  filter: string, Allows filtering by Google audience fields.

Supported syntax:

* Filter expressions for Google audiences currently can only contain at
most one restriction.
* A restriction has the form of `{field} {operator} {value}`.
* The operator must be `CONTAINS (:)`.
* Supported fields:
    - `displayName`

Examples:

* All Google audiences for which the display name contains "Google":
`displayName : "Google"`.

The length of this field should be no more than 500 characters.
  pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
next_page_token
returned from the previous call to `ListGoogleAudiences` method.
If not specified, the first page of results will be returned.
  pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
is specified.
  advertiserId: string, The ID of the advertiser that has access to the fetched Google audiences.
  orderBy: string, Field by which to sort the list.
Acceptable values are:

* `googleAudienceId` (default)
* `displayName`

The default sorting order is ascending. To specify descending order for
a field, a suffix "desc" should be added to the field name. Example:
`displayName desc`.
  partnerId: string, The ID of the partner that has access to the fetched Google audiences.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "googleAudiences": [ # The list of Google audiences.
        #
        # This list will be absent if empty.
      { # Describes a Google audience resource.
          # Includes Google audience lists.
        "googleAudienceType": "A String", # Output only. The type of Google audience.
            # .
        "googleAudienceId": "A String", # Output only. The unique ID of the Google audience. Assigned by the system.
        "name": "A String", # Output only. The resource name of the google audience.
        "displayName": "A String", # Output only. The display name of the Google audience.
            # .
      },
    ],
    "nextPageToken": "A String", # A token to retrieve the next page of results.
        # Pass this value in the
        # page_token
        # field in the subsequent call to `ListGoogleAudiences` method to retrieve
        # the next page of results.
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.