Struct google_dfareporting2d2::EventTagListCall

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

Retrieves a list of event tags, possibly filtered.

A builder for the list method supported by a eventTag resource. It is not used directly, but through a EventTagMethods 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.event_tags().list("profileId")
             .sort_order("ut")
             .sort_field("magna")
             .search_string("amet.")
             .add_ids("eirmod")
             .add_event_tag_types("ea")
             .enabled(true)
             .definitions_only(true)
             .campaign_id("sanctus")
             .advertiser_id("diam")
             .ad_id("eos")
             .doit();

Methods

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

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

Perform the operation you have build so far.

fn profile_id(self, new_value: &str) -> EventTagListCall<'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 sort_order(self, new_value: &str) -> EventTagListCall<'a, C, A>

Order of sorted results, default is ASCENDING.

Sets the sort order query property to the given value.

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

Field by which to sort the list.

Sets the sort field query property to the given value.

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

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

Sets the search string query property to the given value.

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

Select only event tags 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 add_event_tag_types(self, new_value: &str) -> EventTagListCall<'a, C, A>

Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.

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

fn enabled(self, new_value: bool) -> EventTagListCall<'a, C, A>

Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.

Sets the enabled query property to the given value.

fn definitions_only(self, new_value: bool) -> EventTagListCall<'a, C, A>

Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

Sets the definitions only query property to the given value.

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

Select only event tags that belong to this campaign.

Sets the campaign id query property to the given value.

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

Select only event tags that belong to this advertiser.

Sets the advertiser id query property to the given value.

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

Select only event tags that belong to this ad.

Sets the ad id query property to the given value.

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