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.
Scopes
You will need authorization for the https://www.googleapis.com/auth/realtime-bidding scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/realtime-bidding.
You can set the scope for this method like this: realtimebidding1 --scope <scope> bidders creatives-list ...
Required Scalar Argument
- <parent> (string)
- Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either
buyers/{buyerAccountId}
orbidders/{bidderAccountId}
. Forbuyers/{buyerAccountId}
, thebuyerAccountId
can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (456
) under bidder account (123
), you would use the pattern:buyers/456
. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (123
), you would usebuyers/123
. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would usebidders/{bidderAccountId}
, for example, for all creatives pertaining to bidder (123
), usebidders/123
.
- Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p filter=string
- 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'
-
-p page-size=integer
- 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.
-
-p page-token=string
- 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.
-
-p view=string
- 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".
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").