Struct google_adexchangebuyer1d4::CreativeListCall

pub struct CreativeListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

A builder for the list method supported by a creative resource. It is not used directly, but through a CreativeMethods 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.creatives().list()
             .page_token("et")
             .open_auction_status_filter("consetetur")
             .max_results(65)
             .deals_status_filter("ea")
             .add_buyer_creative_id("sed")
             .add_account_id(-3)
             .doit();

Methods

impl<'a, C, A> CreativeListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

fn doit(self) -> Result<(Response, CreativesList)>

Perform the operation you have build so far.

fn page_token(self, new_value: &str) -> CreativeListCall<'a, C, A>

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.

Sets the page token query property to the given value.

fn open_auction_status_filter(
    self,
    new_value: &str
) -> CreativeListCall<'a, C, A>

When specified, only creatives having the given open auction status are returned.

Sets the open auction status filter query property to the given value.

fn max_results(self, new_value: u32) -> CreativeListCall<'a, C, A>

Maximum number of entries returned on one result page. If not set, the default is 100. Optional.

Sets the max results query property to the given value.

fn deals_status_filter(self, new_value: &str) -> CreativeListCall<'a, C, A>

When specified, only creatives having the given deals status are returned.

Sets the deals status filter query property to the given value.

fn add_buyer_creative_id(self, new_value: &str) -> CreativeListCall<'a, C, A>

When specified, only creatives for the given buyer creative ids are returned.

Append the given value to the buyer creative id query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn add_account_id(self, new_value: i32) -> CreativeListCall<'a, C, A>

When specified, only creatives for the given account ids are returned.

Append the given value to the account id query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn delegate(self, new_value: &'a mut Delegate) -> CreativeListCall<'a, C, A>

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.

fn param<T>(self, name: T, value: T) -> CreativeListCall<'a, C, A> where
    T: AsRef<str>, 

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 paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• 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. Overrides userIp if both are provided.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

fn add_scope<T>(self, scope: T) -> CreativeListCall<'a, C, A> where
    T: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::AdexchangeBuyer.

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.

Trait Implementations

impl<'a, C, A> CallBuilder for CreativeListCall<'a, C, A>