Struct google_dfareporting2d5::AdListCall

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

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

A builder for the list method supported by a ad resource. It is not used directly, but through a AdMethods 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.ads().list("profileId")
             .add_type("consetetur")
             .ssl_required(false)
             .ssl_compliant(true)
             .sort_order("gubergren")
             .sort_field("et")
             .add_size_ids("sadipscing")
             .search_string("accusam")
             .add_remarketing_list_ids("magna")
             .add_placement_ids("Lorem")
             .page_token("rebum.")
             .overridden_event_tag_id("et")
             .max_results(-64)
             .add_landing_page_ids("eos")
             .add_ids("dolores")
             .dynamic_click_tracker(true)
             .creative_type("consetetur")
             .add_creative_optimization_configuration_ids("vero")
             .add_creative_ids("consetetur")
             .compatibility("eos")
             .add_campaign_ids("justo")
             .add_audience_segment_ids("tempor")
             .archived(false)
             .advertiser_id("dolore")
             .active(false)
             .doit();

Methods

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

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

Perform the operation you have build so far.

fn profile_id(self, new_value: &str) -> AdListCall<'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.

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

Select only ads with these types.

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

fn ssl_required(self, new_value: bool) -> AdListCall<'a, C, A>

Select only ads that require SSL.

Sets the ssl required query property to the given value.

fn ssl_compliant(self, new_value: bool) -> AdListCall<'a, C, A>

Select only ads that are SSL-compliant.

Sets the ssl compliant query property to the given value.

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

Order of sorted results.

Sets the sort order query property to the given value.

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

Field by which to sort the list.

Sets the sort field query property to the given value.

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

Select only ads with these size IDs.

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

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

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".

Sets the search string query property to the given value.

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

Select only ads whose list targeting expression use these remarketing list IDs.

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

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

Select only ads with these placement IDs assigned.

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

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

Value of the nextPageToken from the previous result page.

Sets the page token query property to the given value.

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

Select only ads with this event tag override ID.

Sets the overridden event tag id query property to the given value.

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

Maximum number of results to return.

Sets the max results query property to the given value.

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

Select only ads with these landing page IDs.

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

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

Select only ads 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.

fn dynamic_click_tracker(self, new_value: bool) -> AdListCall<'a, C, A>

Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

Sets the dynamic click tracker query property to the given value.

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

Select only ads with the specified creativeType.

Sets the creative type query property to the given value.

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

Select only ads with these creative optimization configuration IDs.

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

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

Select only ads with these creative IDs assigned.

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

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

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.

Sets the compatibility query property to the given value.

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

Select only ads with these campaign IDs.

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

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

Select only ads with these audience segment IDs.

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

fn archived(self, new_value: bool) -> AdListCall<'a, C, A>

Select only archived ads.

Sets the archived query property to the given value.

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

Select only ads with this advertiser ID.

Sets the advertiser id query property to the given value.

fn active(self, new_value: bool) -> AdListCall<'a, C, A>

Select only active ads.

Sets the active query property to the given value.

fn delegate(self, new_value: &'a mut Delegate) -> AdListCall<'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) -> AdListCall<'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, S>(self, scope: T) -> AdListCall<'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 AdListCall<'a, C, A>