Struct google_gan1_beta1::api::ReportGetCall[−][src]

pub struct ReportGetCall<'a> { /* fields omitted */ }

Expand description

Retrieves a report of the specified type.

A builder for the get method supported by a report resource. It is not used directly, but through a ReportMethods 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.reports().get("role", "roleId", "reportType")
             .status("dolores")
             .start_index(32)
             .start_date("et")
             .add_publisher_id("sed")
             .add_order_id("no")
             .max_results(16)
             .add_link_id("elitr")
             .event_type("sed")
             .end_date("no")
             .calculate_totals(false)
             .add_advertiser_id("At")
             .doit().await;

Implementations

[src]

impl<'a> ReportGetCall<'a>

[src]

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

Perform the operation you have build so far.

[src]

pub fn role(self, new_value: &str) -> ReportGetCall<'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.

[src]

pub fn role_id(self, new_value: &str) -> ReportGetCall<'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.

[src]

pub fn report_type(self, new_value: &str) -> ReportGetCall<'a>

The type of report being requested. Valid values: ‘order_delta’. Required.

Sets the report type 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.

[src]

pub fn status(self, new_value: &str) -> ReportGetCall<'a>

Filters out all events that do not have the given status. Valid values: ‘active’, ‘canceled’, or ‘invalid’. Optional.

Sets the status query property to the given value.

[src]

pub fn start_index(self, new_value: u32) -> ReportGetCall<'a>

Offset on which to return results when paging. Optional.

Sets the start index query property to the given value.

[src]

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

The start date (inclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day before endDate, if that is given, or yesterday. Optional.

Sets the start date query property to the given value.

[src]

pub fn add_publisher_id(self, new_value: &str) -> ReportGetCall<'a>

The IDs of the publishers to look up, if applicable.

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

[src]

pub fn add_order_id(self, new_value: &str) -> ReportGetCall<'a>

Filters to capture one of the given order IDs. Optional.

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

[src]

pub fn max_results(self, new_value: u32) -> ReportGetCall<'a>

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

Sets the max results query property to the given value.

[src]

pub fn add_link_id(self, new_value: &str) -> ReportGetCall<'a>

Filters to capture one of given link IDs. Optional.

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

[src]

pub fn event_type(self, new_value: &str) -> ReportGetCall<'a>

Filters out all events that are not of the given type. Valid values: ‘action’, ‘transaction’, or ‘charge’. Optional.

Sets the event type query property to the given value.

[src]

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

The end date (exclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day after startDate, if that is given, or today. Optional.

Sets the end date query property to the given value.

[src]

pub fn calculate_totals(self, new_value: bool) -> ReportGetCall<'a>

Whether or not to calculate totals rows. Optional.

Sets the calculate totals query property to the given value.

[src]

pub fn add_advertiser_id(self, new_value: &str) -> ReportGetCall<'a>

The IDs of the advertisers to look up, if applicable.

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.

[src]

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

[src]

pub fn param<T>(self, name: T, value: T) -> ReportGetCall<'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

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.