Struct google_analytics3::DataGaGetCall

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

Returns Analytics data for a view (profile).

A builder for the ga.get method supported by a data resource. It is not used directly, but through a DataMethods 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.data().ga_get("ids", "start-date", "end-date", "metrics")
             .start_index(-5)
             .sort("sed")
             .segment("sit")
             .sampling_level("dolore")
             .output("et")
             .max_results(-26)
             .include_empty_rows(false)
             .filters("ut")
             .dimensions("diam")
             .doit();

Methods

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

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

Perform the operation you have build so far.

pub fn ids(self, new_value: &str) -> DataGaGetCall<'a, C, A>

Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

Sets the ids query property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn start_date(self, new_value: &str) -> DataGaGetCall<'a, C, A>

Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

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

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn end_date(self, new_value: &str) -> DataGaGetCall<'a, C, A>

End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.

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

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn metrics(self, new_value: &str) -> DataGaGetCall<'a, C, A>

A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.

Sets the metrics query property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn start_index(self, new_value: i32) -> DataGaGetCall<'a, C, A>

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Sets the start-index query property to the given value.

pub fn sort(self, new_value: &str) -> DataGaGetCall<'a, C, A>

A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.

Sets the sort query property to the given value.

pub fn segment(self, new_value: &str) -> DataGaGetCall<'a, C, A>

An Analytics segment to be applied to data.

Sets the segment query property to the given value.

pub fn sampling_level(self, new_value: &str) -> DataGaGetCall<'a, C, A>

The desired sampling level.

Sets the sampling level query property to the given value.

pub fn output(self, new_value: &str) -> DataGaGetCall<'a, C, A>

The selected format for the response. Default format is JSON.

Sets the output query property to the given value.

pub fn max_results(self, new_value: i32) -> DataGaGetCall<'a, C, A>

The maximum number of entries to include in this feed.

Sets the max-results query property to the given value.

pub fn include_empty_rows(self, new_value: bool) -> DataGaGetCall<'a, C, A>

The response will include empty rows if this parameter is set to true, the default is true

Sets the include-empty-rows query property to the given value.

pub fn filters(self, new_value: &str) -> DataGaGetCall<'a, C, A>

A comma-separated list of dimension or metric filters to be applied to Analytics data.

Sets the filters query property to the given value.

pub fn dimensions(self, new_value: &str) -> DataGaGetCall<'a, C, A>

A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

Sets the dimensions query property to the given value.

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

pub fn param<T>(self, name: T, value: T) -> DataGaGetCall<'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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• 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) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

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

Trait Implementations

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