Ad Exchange Buyer API . creatives

Instance Methods

get(accountId, buyerCreativeId)

Gets the status for a single creative.

insert(body)

Submit a new creative.

list(pageToken=None, maxResults=None, statusFilter=None)

Retrieves a list of the authenticated user's active creatives.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(accountId, buyerCreativeId)
Gets the status for a single creative.

Args:
  accountId: integer, The id for the account that will serve this creative. (required)
  buyerCreativeId: string, The buyer-specific id for this creative. (required)

Returns:
  An object of the form:

    { # A creative and its classification data.
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "kind": "adexchangebuyer#creative", # Resource type.
      "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
      "width": 42, # Ad width.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
        42,
      ],
      "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
        "A String",
      ],
      "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "accountId": 42, # Account id.
    }
insert(body)
Submit a new creative.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A creative and its classification data.
    "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
      42,
    ],
    "advertiserName": "A String", # The name of the company being advertised in the creative.
    "kind": "adexchangebuyer#creative", # Resource type.
    "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
    "width": 42, # Ad width.
    "attribute": [ # All attributes for the ads that may be shown from this snippet.
      42,
    ],
    "height": 42, # Ad height.
    "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
      "A String",
    ],
    "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
    "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
    "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
    "clickThroughUrl": [ # The set of destination urls for the snippet.
      "A String",
    ],
    "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
      42,
    ],
    "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
      "A String",
    ],
    "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
      42,
    ],
    "accountId": 42, # Account id.
  }


Returns:
  An object of the form:

    { # A creative and its classification data.
      "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "advertiserName": "A String", # The name of the company being advertised in the creative.
      "kind": "adexchangebuyer#creative", # Resource type.
      "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
      "width": 42, # Ad width.
      "attribute": [ # All attributes for the ads that may be shown from this snippet.
        42,
      ],
      "height": 42, # Ad height.
      "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
        "A String",
      ],
      "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
      "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
      "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
      "clickThroughUrl": [ # The set of destination urls for the snippet.
        "A String",
      ],
      "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
        42,
      ],
      "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
        "A String",
      ],
      "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
        42,
      ],
      "accountId": 42, # Account id.
    }
list(pageToken=None, maxResults=None, statusFilter=None)
Retrieves a list of the authenticated user's active creatives.

Args:
  pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
  maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
  statusFilter: string, When specified, only creatives having the given status are returned.
    Allowed values
      approved - Creatives which have been approved.
      disapproved - Creatives which have been disapproved.
      not_checked - Creatives whose status is not yet checked.

Returns:
  An object of the form:

    { # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
    "nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
    "items": [ # A list of creatives.
      { # A creative and its classification data.
          "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
            42,
          ],
          "advertiserName": "A String", # The name of the company being advertised in the creative.
          "kind": "adexchangebuyer#creative", # Resource type.
          "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
          "width": 42, # Ad width.
          "attribute": [ # All attributes for the ads that may be shown from this snippet.
            42,
          ],
          "height": 42, # Ad height.
          "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
            "A String",
          ],
          "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
          "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
          "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
          "clickThroughUrl": [ # The set of destination urls for the snippet.
            "A String",
          ],
          "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
            42,
          ],
          "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
            "A String",
          ],
          "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
            42,
          ],
          "accountId": 42, # Account id.
        },
    ],
    "kind": "adexchangebuyer#creativesList", # Resource type.
  }
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.