pub struct EventTagListCall<'a, S>
where S: 'a,
{ /* private fields */ }
Expand description

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(-70)
             .sort_order("elitr")
             .sort_field("aliquyam")
             .search_string("erat")
             .add_ids(-87)
             .add_event_tag_types("et")
             .enabled(true)
             .definitions_only(true)
             .campaign_id(-35)
             .advertiser_id(-30)
             .ad_id(-65)
             .doit().await;

Implementations§

source§

impl<'a, S> EventTagListCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

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

Perform the operation you have build so far.

source

pub fn profile_id(self, new_value: i64) -> EventTagListCall<'a, S>

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.

source

pub fn sort_order(self, new_value: &str) -> EventTagListCall<'a, S>

Order of sorted results.

Sets the sort order query property to the given value.

source

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

Field by which to sort the list.

Sets the sort field query property to the given value.

source

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

Allows searching for objects by name or ID. Wildcards () are allowed. For example, “eventtag2015” 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.

source

pub fn add_ids(self, new_value: i64) -> EventTagListCall<'a, S>

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.

source

pub fn add_event_tag_types(self, new_value: &str) -> EventTagListCall<'a, S>

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.

source

pub fn enabled(self, new_value: bool) -> EventTagListCall<'a, S>

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.

source

pub fn definitions_only(self, new_value: bool) -> EventTagListCall<'a, S>

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.

source

pub fn campaign_id(self, new_value: i64) -> EventTagListCall<'a, S>

Select only event tags that belong to this campaign.

Sets the campaign id query property to the given value.

source

pub fn advertiser_id(self, new_value: i64) -> EventTagListCall<'a, S>

Select only event tags that belong to this advertiser.

Sets the advertiser id query property to the given value.

source

pub fn ad_id(self, new_value: i64) -> EventTagListCall<'a, S>

Select only event tags that belong to this ad.

Sets the ad id query property to the given value.

source

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

source

pub fn param<T>(self, name: T, value: T) -> EventTagListCall<'a, S>
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
  • alt (query-string) - Data format for the response.
  • 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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  • userIp (query-string) - Deprecated. Please use quotaUser instead.
source

pub fn add_scope<St>(self, scope: St) -> EventTagListCall<'a, S>
where St: AsRef<str>,

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::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.

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.

source

pub fn add_scopes<I, St>(self, scopes: I) -> EventTagListCall<'a, S>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

source

pub fn clear_scopes(self) -> EventTagListCall<'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).

Trait Implementations§

source§

impl<'a, S> CallBuilder for EventTagListCall<'a, S>

Auto Trait Implementations§

§

impl<'a, S> !RefUnwindSafe for EventTagListCall<'a, S>

§

impl<'a, S> Send for EventTagListCall<'a, S>
where S: Sync,

§

impl<'a, S> !Sync for EventTagListCall<'a, S>

§

impl<'a, S> Unpin for EventTagListCall<'a, S>

§

impl<'a, S> !UnwindSafe for EventTagListCall<'a, S>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more