pub struct BuyerCreativeListCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
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.
A builder for the creatives.list method supported by a buyer resource.
It is not used directly, but through a BuyerMethods instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.buyers().creatives_list("parent")
.view("consetetur")
.page_token("diam")
.page_size(-49)
.filter("et")
.doit().await;Implementations§
source§impl<'a, S> BuyerCreativeListCall<'a, S>
impl<'a, S> BuyerCreativeListCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, ListCreativesResponse)>
pub async fn doit(self) -> Result<(Response<Body>, ListCreativesResponse)>
Perform the operation you have build so far.
sourcepub fn parent(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
pub fn parent(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
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.
Sets the parent path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn view(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
pub fn view(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
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”.
Sets the view query property to the given value.
sourcepub fn page_token(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
pub fn page_token(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
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.
Sets the page token query property to the given value.
sourcepub fn page_size(self, new_value: i32) -> BuyerCreativeListCall<'a, S>
pub fn page_size(self, new_value: i32) -> BuyerCreativeListCall<'a, S>
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.
Sets the page size query property to the given value.
sourcepub fn filter(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
pub fn filter(self, new_value: &str) -> BuyerCreativeListCall<'a, S>
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’
Sets the filter query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> BuyerCreativeListCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> BuyerCreativeListCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> BuyerCreativeListCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> BuyerCreativeListCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-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.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-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.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> BuyerCreativeListCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> BuyerCreativeListCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::RealtimeBidding.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> BuyerCreativeListCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> BuyerCreativeListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> BuyerCreativeListCall<'a, S>
pub fn clear_scopes(self) -> BuyerCreativeListCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).