Display & Video 360 API . advertisers . negativeKeywordLists

Instance Methods

get(advertiserId, negativeKeywordListId, x__xgafv=None)

Gets a negative keyword list given an advertiser ID and a negative keyword

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

Lists negative keyword lists based on a given advertiser id.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(advertiserId, negativeKeywordListId, x__xgafv=None)
Gets a negative keyword list given an advertiser ID and a negative keyword
list ID.

Args:
  advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched negative keyword list
belongs. (required)
  negativeKeywordListId: string, Required. The ID of the negative keyword list to fetch. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of negative keywords used for targeting.
    "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
    "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
    "name": "A String", # Output only. The resource name of the negative keyword list.
    "displayName": "A String", # Required. The display name of the negative keyword list.
        # Must be UTF-8 encoded with a maximum size of 255 bytes.
  }
list(advertiserId, pageToken=None, pageSize=None, x__xgafv=None)
Lists negative keyword lists based on a given advertiser id.

Args:
  advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched negative keyword lists
belong. (required)
  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 `ListNegativeKeywordLists` method.
If not specified, the first page of results will be returned.
  pageSize: integer, Requested page size. Must be between `1` and `100`.
Defaults to `100` if not set. 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:

    { # Response message for NegativeKeywordListService.ListNegativeKeywordLists.
    "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 `ListNegativeKeywordLists` method to
        # retrieve the next page of results.
    "negativeKeywordLists": [ # The list of negative keyword lists.
        #
        # This list will be absent if empty.
      { # A list of negative keywords used for targeting.
        "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system.
        "advertiserId": "A String", # Output only. The unique ID of the advertiser the negative keyword list belongs to.
        "name": "A String", # Output only. The resource name of the negative keyword list.
        "displayName": "A String", # Required. The display name of the negative keyword list.
            # Must be UTF-8 encoded with a maximum size of 255 bytes.
      },
    ],
  }
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.