Struct google_gan1_beta1::api::PublisherListCall

source ·

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

Expand description

Retrieves data about all publishers that the requesting advertiser/publisher has access to.

A builder for the list method supported by a publisher resource. It is not used directly, but through a PublisherMethods 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.publishers().list("role", "roleId")
             .relationship_status("sit")
             .publisher_category("et")
             .page_token("tempor")
             .min_seven_day_epc(0.5423272308124675)
             .min_payout_rank(-18)
             .min_ninety_day_epc(0.728870793677753)
             .max_results(45)
             .doit().await;

Implementations§

source §

impl<'a, S> PublisherListCall<'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>, Publishers)>

Perform the operation you have build so far.

source

pub fn role(self, new_value: &str) -> PublisherListCall<'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) -> PublisherListCall<'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 relationship_status(self, new_value: &str) -> PublisherListCall<'a, S>

Filters out all publishers for which do not have the given relationship status with the requesting publisher.

Sets the relationship status query property to the given value.

source

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

Sets the publisher category query property to the given value.

source

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

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

Sets the page token query property to the given value.

source

pub fn min_seven_day_epc(self, new_value: f64) -> PublisherListCall<'a, S>

Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.

Sets the min seven day epc query property to the given value.

source

pub fn min_payout_rank(self, new_value: i32) -> PublisherListCall<'a, S>

A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.

Sets the min payout rank query property to the given value.

source

pub fn min_ninety_day_epc(self, new_value: f64) -> PublisherListCall<'a, S>

Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.

Sets the min ninety day epc query property to the given value.

source

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