Class BiddersResource.CreativesResource.ListRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.RealTimeBidding.v1
Assembly: Google.Apis.RealTimeBidding.v1.dll
Syntax
public class BiddersResource.CreativesResource.ListRequest : RealTimeBiddingBaseServiceRequest<ListCreativesResponse>, IClientServiceRequest<ListCreativesResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
Filter
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'
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
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.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
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.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either
buyers/{buyerAccountId}
or bidders/{bidderAccountId}
. For buyers/{buyerAccountId}
, the
buyerAccountId
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 use buyers/123
. If you want to access all creatives pertaining to both the bidder and
all of its child seat accounts, you would use bidders/{bidderAccountId}
, for example, for all
creatives pertaining to bidder (123
), use bidders/123
.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
View
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".
Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual BiddersResource.CreativesResource.ListRequest.ViewEnum? View { get; set; }
Property Value
Type | Description |
---|---|
BiddersResource.CreativesResource.ListRequest.ViewEnum? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()