Struct google_gan1_beta1::LinkListCall

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

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("et")
             .start_date_max("consetetur")
             .search_text("amet.")
             .relationship_status("voluptua.")
             .add_promotion_type("Lorem")
             .page_token("gubergren")
             .max_results(81)
             .link_type("sit")
             .create_date_min("vero")
             .create_date_max("diam")
             .authorship("rebum.")
             .add_asset_size("consetetur")
             .add_advertiser_id("sadipscing")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

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.

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

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.

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

The beginning of the start date range.

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

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

The end of the start date range.

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

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

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

Sets the search text query property to the given value.

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

The status of the relationship.

Sets the relationship status query property to the given value.

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

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.

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

The value of 'nextPageToken' from the previous page. Optional.

Sets the page token query property to the given value.

fn max_results(self, new_value: u32) -> LinkListCall<'a, C, A>

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

Sets the max results query property to the given value.

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

The type of the link.

Sets the link type query property to the given value.

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

The beginning of the create date range.

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

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

The end of the create date range.

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

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

The role of the author of the link.

Sets the authorship query property to the given value.

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

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.

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

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.

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

Trait Implementations

impl<'a, C, A> CallBuilder for LinkListCall<'a, C, A>