buyers

GET /v1/buyers/{buyersId}/creatives

Changed on

Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.

Request

  • Base URL
    https://realtimebidding.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/realtime-bidding
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/realtime-bidding
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

buyersIdstring required

Query parameters

adCategoryTaxonomyOverride'AD_CATEGORY_TAXONOMY_UNSPECIFIED' | 'GOOGLE_AD_CATEGORY_TAXONOMY' | 'IAB_CONTENT_1_0' | 'IAB_CONTENT_2_2'

Optional. The category taxonomy to use for the response. Overrides the default category taxonomy for the bidder.

filterstring

Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'

pageSizeinteger

Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.

pageTokenstring

A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.

view'CREATIVE_VIEW_UNSPECIFIED' | 'SERVING_DECISION_ONLY' | 'FULL'

Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".

Response

Successful response

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.pageToken field in the subsequent call to the ListCreatives method to retrieve the next page of results.

Changes