Struct AccountReportGenerateCall

Source

pub struct AccountReportGenerateCall<'a, C>where
    C: 'a,
{ /* private fields */ }

Expand description

Generates an ad hoc report.

A builder for the reports.generate method supported by a account resource. It is not used directly, but through a AccountMethods 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.accounts().reports_generate("account")
             .start_date_year(-56)
             .start_date_month(-7)
             .start_date_day(-30)
             .reporting_time_zone("diam")
             .add_order_by("dolores")
             .add_metrics("dolores")
             .limit(-68)
             .language_code("sed")
             .add_filters("no")
             .end_date_year(-85)
             .end_date_month(-94)
             .end_date_day(-80)
             .add_dimensions("no")
             .date_range("nonumy")
             .currency_code("At")
             .doit().await;

Implementations§

Source §

impl<'a, C> AccountReportGenerateCall<'a, C>
where C: Connector,

Source

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

Perform the operation you have build so far.

Source

pub fn account(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

Required. The account which owns the collection of reports. Format: accounts/{account}

Sets the account 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_year(self, new_value: i32) -> AccountReportGenerateCall<'a, C>

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, ) -> AccountReportGenerateCall<'a, C>

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) -> AccountReportGenerateCall<'a, C>

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 reporting_time_zone( self, new_value: &str, ) -> AccountReportGenerateCall<'a, C>

Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.

Sets the reporting time zone query property to the given value.

Source

pub fn add_order_by(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

The name of a dimension or metric to sort the resulting report on, can be prefixed with “+” to sort ascending or “-” to sort descending. If no prefix is specified, the column is sorted ascending.

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

Source

pub fn add_metrics(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

Required. Reporting metrics.

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

Source

pub fn limit(self, new_value: i32) -> AccountReportGenerateCall<'a, C>

The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports.GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.

Sets the limit query property to the given value.

Source

pub fn language_code(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

The language to use for translating report output. If unspecified, this defaults to English (“en”). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.

Sets the language code query property to the given value.

Source

pub fn add_filters(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

A list of filters to apply to the report. All provided filters must match in order for the data to be included in the report.

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

Source

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

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) -> AccountReportGenerateCall<'a, C>

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) -> AccountReportGenerateCall<'a, C>

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 add_dimensions(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

Dimensions to base the report on.

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

Source

pub fn date_range(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

Date range of the report, if unset the range will be considered CUSTOM.

Sets the date range query property to the given value.

Source

pub fn currency_code(self, new_value: &str) -> AccountReportGenerateCall<'a, C>

The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account’s currency if not set.

Sets the currency code query property to the given value.

Source

pub fn delegate( self, new_value: &'a mut dyn Delegate, ) -> AccountReportGenerateCall<'a, C>

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) -> AccountReportGenerateCall<'a, C>
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<St>(self, scope: St) -> AccountReportGenerateCall<'a, C>
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::Readonly.

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) -> AccountReportGenerateCall<'a, C>
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) -> AccountReportGenerateCall<'a, C>

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