Struct google_gan1_beta1::api::LinkListCall

source ·

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

Expand description

Retrieves all links that match the query parameters.

A builder for the list method supported by a link resource. It is not used directly, but through a LinkMethods 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.links().list("role", "roleId")
             .start_date_min("dolores")
             .start_date_max("gubergren")
             .search_text("et")
             .relationship_status("accusam")
             .add_promotion_type("voluptua.")
             .page_token("dolore")
             .max_results(67)
             .link_type("dolore")
             .create_date_min("voluptua.")
             .create_date_max("amet.")
             .authorship("ea")
             .add_asset_size("sadipscing")
             .add_advertiser_id(-6)
             .doit().await;

Implementations§

source §

impl<'a, S> LinkListCall<'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>, Links)>

Perform the operation you have build so far.

source

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

The role of the requester. Valid values: ‘advertisers’ or ‘publishers’.

Sets the role 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 role_id(self, new_value: &str) -> LinkListCall<'a, S>

The ID of the requesting advertiser or publisher.

Sets the role 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 start_date_min(self, new_value: &str) -> LinkListCall<'a, S>

The beginning of the start date range.

Sets the start date min query property to the given value.

source

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

The end of the start date range.

Sets the start date max query property to the given value.

source

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

Field for full text search across title and merchandising text, supports link id search.

Sets the search text query property to the given value.

source

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

The status of the relationship.

Sets the relationship status query property to the given value.

source

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

The promotion type.

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

source

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

The value of ‘nextPageToken’ from the previous page. Optional.

Sets the page token query property to the given value.

source

pub fn max_results(self, new_value: u32) -> LinkListCall<'a, S>

Max number of items to return in this page. Optional. Defaults to 20.

Sets the max results query property to the given value.

source

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

The type of the link.

Sets the link type query property to the given value.

source

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

The beginning of the create date range.

Sets the create date min query property to the given value.

source

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

The end of the create date range.

Sets the create date max query property to the given value.

source

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

The role of the author of the link.

Sets the authorship query property to the given value.

source

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

The size of the given asset.

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

source

pub fn add_advertiser_id(self, new_value: i64) -> LinkListCall<'a, S>

Limits the resulting links to the ones belonging to the listed advertisers.

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

source

pub fn delegate(self, new_value: &'a mut dyn Delegate) -> LinkListCall<'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) -> LinkListCall<'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) - 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.
userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.