Struct google_dfareporting2d8::AdvertiserListCall

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

Retrieves a list of advertisers, possibly filtered. This method supports paging.

A builder for the list method supported by a advertiser resource. It is not used directly, but through a AdvertiserMethods 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.advertisers().list("profileId")
             .subaccount_id("At")
             .status("consetetur")
             .sort_order("et")
             .sort_field("sed")
             .search_string("sit")
             .page_token("takimata")
             .only_parent(true)
             .max_results(-91)
             .include_advertisers_without_groups_only(true)
             .add_ids("Lorem")
             .add_floodlight_configuration_ids("Lorem")
             .add_advertiser_group_ids("diam")
             .doit();

Methods

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

pub fn doit(self) -> Result<(Response, AdvertisersListResponse)>

Perform the operation you have build so far.

pub fn profile_id(self, new_value: &str) -> AdvertiserListCall<'a, C, A>

User profile ID associated with this request.

Sets the profile id 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.

pub fn subaccount_id(self, new_value: &str) -> AdvertiserListCall<'a, C, A>

Select only advertisers with these subaccount IDs.

Sets the subaccount id query property to the given value.

pub fn status(self, new_value: &str) -> AdvertiserListCall<'a, C, A>

Select only advertisers with the specified status.

Sets the status query property to the given value.

pub fn sort_order(self, new_value: &str) -> AdvertiserListCall<'a, C, A>

Order of sorted results.

Sets the sort order query property to the given value.

pub fn sort_field(self, new_value: &str) -> AdvertiserListCall<'a, C, A>

Field by which to sort the list.

Sets the sort field query property to the given value.

pub fn search_string(self, new_value: &str) -> AdvertiserListCall<'a, C, A>

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".

Sets the search string query property to the given value.

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

Value of the nextPageToken from the previous result page.

Sets the page token query property to the given value.

pub fn only_parent(self, new_value: bool) -> AdvertiserListCall<'a, C, A>

Select only advertisers which use another advertiser's floodlight configuration.

Sets the only parent query property to the given value.

pub fn max_results(self, new_value: i32) -> AdvertiserListCall<'a, C, A>

Maximum number of results to return.

Sets the max results query property to the given value.

pub fn include_advertisers_without_groups_only(
    self,
    new_value: bool
) -> AdvertiserListCall<'a, C, A>

Select only advertisers which do not belong to any advertiser group.

Sets the include advertisers without groups only query property to the given value.

pub fn add_ids(self, new_value: &str) -> AdvertiserListCall<'a, C, A>

Select only advertisers with these IDs.

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

pub fn add_floodlight_configuration_ids(
    self,
    new_value: &str
) -> AdvertiserListCall<'a, C, A>

Select only advertisers with these floodlight configuration IDs.

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

pub fn add_advertiser_group_ids(
    self,
    new_value: &str
) -> AdvertiserListCall<'a, C, A>

Select only advertisers with these advertiser group IDs.

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

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> AdvertiserListCall<'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.

pub fn param<T>(self, name: T, value: T) -> AdvertiserListCall<'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 parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• 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) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> AdvertiserListCall<'a, C, A> where
    T: Into<Option<S>>,
    S: 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::Dfatrafficking.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

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 AdvertiserListCall<'a, C, A>