Display & Video 360 API . customLists

Instance Methods

get(customListId, advertiserId=None, x__xgafv=None)

Gets a custom list.

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

Lists custom lists.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(customListId, advertiserId=None, x__xgafv=None)
Gets a custom list.

Args:
  customListId: string, Required. The ID of the custom list to fetch. (required)
  advertiserId: string, The ID of the DV360 advertiser that has access to the fetched custom
lists.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a custom list entity, such as a custom affinity or custom intent
      # audience list.
    "name": "A String", # Output only. The resource name of the custom list.
    "displayName": "A String", # Output only. The display name of the custom list.
        # .
    "customListId": "A String", # Output only. The unique ID of the custom list. Assigned by the system.
  }
list(filter=None, advertiserId=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)
Lists custom lists.

The order is defined by the order_by
parameter.

Args:
  filter: string, Allows filtering by custom list fields.

Supported syntax:

* Filter expressions for custom lists 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 custom lists for which the display name contains "Google":
`displayName : "Google"`.

The length of this field should be no more than 500 characters.
  advertiserId: string, The ID of the DV360 advertiser that has access to the fetched custom
lists.
  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 `ListCustomLists` method.
If not specified, the first page of results will be returned.
  orderBy: string, Field by which to sort the list.
Acceptable values are:

* `customListId` (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`.
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "customLists": [ # The list of custom lists.
        #
        # This list will be absent if empty.
      { # Describes a custom list entity, such as a custom affinity or custom intent
          # audience list.
        "name": "A String", # Output only. The resource name of the custom list.
        "displayName": "A String", # Output only. The display name of the custom list.
            # .
        "customListId": "A String", # Output only. The unique ID of the custom list. Assigned by the system.
      },
    ],
    "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 `ListCustomLists` 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.