Struct google_localservices1::api::AccountReportSearchCall

source · [−]

pub struct AccountReportSearchCall<'a> { /* private fields */ }

Expand description

Get account reports containing aggregate account data of all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.

A builder for the search method supported by a accountReport resource. It is not used directly, but through a AccountReportMethods 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.account_reports().search()
             .start_date_year(-16)
             .start_date_month(-57)
             .start_date_day(-50)
             .query("ipsum")
             .page_token("est")
             .page_size(-62)
             .end_date_year(-17)
             .end_date_month(-99)
             .end_date_day(-56)
             .doit().await;

Implementations

source

impl<'a> AccountReportSearchCall<'a>

source

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

Perform the operation you have build so far.

source

pub fn start_date_year(self, new_value: i32) -> AccountReportSearchCall<'a>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

source

pub fn start_date_month(self, new_value: i32) -> AccountReportSearchCall<'a>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

source

pub fn start_date_day(self, new_value: i32) -> AccountReportSearchCall<'a>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn’t significant.

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

source

pub fn query(self, new_value: &str) -> AccountReportSearchCall<'a>

A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |———————––|———————————————–| | manager_customer_id:123 | Get Account Report for Manager with id 123. | Required.

Sets the query query property to the given value.

source

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

The next_page_token value returned from a previous request to SearchAccountReports that indicates where listing should continue. Optional.

Sets the page token query property to the given value.

source

pub fn page_size(self, new_value: i32) -> AccountReportSearchCall<'a>

The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.

Sets the page size query property to the given value.

source

pub fn end_date_year(self, new_value: i32) -> AccountReportSearchCall<'a>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Sets the end date.year query property to the given value.

source

pub fn end_date_month(self, new_value: i32) -> AccountReportSearchCall<'a>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

Sets the end date.month query property to the given value.

source

pub fn end_date_day(self, new_value: i32) -> AccountReportSearchCall<'a>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn’t significant.

Sets the end date.day query property to the given value.

source

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

source

pub fn param<T>(self, name: T, value: T) -> AccountReportSearchCall<'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 parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

$.xgafv (query-string) - V1 error format.
access_token (query-string) - OAuth access token.
alt (query-string) - Data format for response.
callback (query-string) - JSONP
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.
uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

source

pub fn add_scope<T, S>(self, scope: T) -> AccountReportSearchCall<'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::Adword.

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.