Struct google_analyticsdata1_beta::api::PropertyMethods

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

A builder providing access to all methods supported on property resources. It is not used directly, but through the AnalyticsData hub.

Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_analyticsdata1_beta as analyticsdata1_beta;
 
use std::default::Default;
use analyticsdata1_beta::{AnalyticsData, oauth2, hyper, hyper_rustls};
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = AnalyticsData::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().enable_http2().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `batch_run_pivot_reports(...)`, `batch_run_reports(...)`, `check_compatibility(...)`, `get_metadata(...)`, `run_pivot_report(...)`, `run_realtime_report(...)` and `run_report(...)`
// to build up your call.
let rb = hub.properties();

Implementations

impl<'a, S> PropertyMethods<'a, S>

pub fn batch_run_pivot_reports(
    &self,
    request: BatchRunPivotReportsRequest,
    property: &str
) -> PropertyBatchRunPivotReportCall<'a, S>

Create a builder to help you perform the following task:

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.

Arguments

• request - No description provided.
• property - A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234

pub fn batch_run_reports(
    &self,
    request: BatchRunReportsRequest,
    property: &str
) -> PropertyBatchRunReportCall<'a, S>

Create a builder to help you perform the following task:

Returns multiple reports in a batch. All reports must be for the same GA4 Property.

Arguments

• request - No description provided.
• property - A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234

pub fn check_compatibility(
    &self,
    request: CheckCompatibilityRequest,
    property: &str
) -> PropertyCheckCompatibilityCall<'a, S>

Create a builder to help you perform the following task:

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request’s dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

Arguments

• request - No description provided.
• property - A Google Analytics GA4 property identifier whose events are tracked. To learn more, see where to find your Property ID. property should be the same value as in your runReport request. Example: properties/1234 Set the Property ID to 0 for compatibility checking on dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

pub fn get_metadata(&self, name: &str) -> PropertyGetMetadataCall<'a, S>

Create a builder to help you perform the following task:

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked. Universal metadata are dimensions and metrics applicable to any property such as country and totalUsers.

Arguments

• name - Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID. Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

pub fn run_pivot_report(
    &self,
    request: RunPivotReportRequest,
    property: &str
) -> PropertyRunPivotReportCall<'a, S>

Create a builder to help you perform the following task:

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

Arguments

• request - No description provided.
• property - A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

pub fn run_realtime_report(
    &self,
    request: RunRealtimeReportRequest,
    property: &str
) -> PropertyRunRealtimeReportCall<'a, S>

Create a builder to help you perform the following task:

The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.

Arguments

• request - No description provided.
• property - A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Example: properties/1234

pub fn run_report(
    &self,
    request: RunReportRequest,
    property: &str
) -> PropertyRunReportCall<'a, S>

Create a builder to help you perform the following task:

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

Arguments

• request - No description provided.
• property - A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

Trait Implementations

impl<'a, S> MethodsBuilder for PropertyMethods<'a, S>