Struct google_api_proto::google::analytics::admin::v1beta::RunAccessReportRequest

pub struct RunAccessReportRequest {

    pub entity: String,
    pub dimensions: Vec<AccessDimension>,
    pub metrics: Vec<AccessMetric>,
    pub date_ranges: Vec<AccessDateRange>,
    pub dimension_filter: Option<AccessFilterExpression>,
    pub metric_filter: Option<AccessFilterExpression>,
    pub offset: i64,
    pub limit: i64,
    pub time_zone: String,
    pub order_bys: Vec<AccessOrderBy>,
    pub return_entity_quota: bool,
    pub include_all_users: bool,
    pub expand_groups: bool,
}

The request for a Data Access Record Report.

Fields

entity: String

The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.

To request at the property level, entity should be for example ‘properties/123’ if “123” is your GA4 property ID. To request at the account level, entity should be for example ‘accounts/1234’ if “1234” is your GA4 Account ID.

dimensions: Vec<AccessDimension>

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

metrics: Vec<AccessMetric>

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

date_ranges: Vec<AccessDateRange>

Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.

dimension_filter: Option<AccessFilterExpression>

Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.

metric_filter: Option<AccessFilterExpression>

Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report’s rows, similar to SQL having-clause. Dimensions cannot be used in this filter.

offset: i64

The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with limit entries.

To learn more about this pagination parameter, see Pagination.

limit: i64

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.

The API may return fewer rows than the requested limit, if there aren’t as many remaining rows as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can’t get more than 300 rows, even if you set limit to a higher value.

To learn more about this pagination parameter, see Pagination.

time_zone: String

This request’s time zone if specified. If unspecified, the property’s time zone is used. The request’s time zone is used to interpret the start & end dates of the report.

Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example “America/New_York” or “Asia/Tokyo”.

order_bys: Vec<AccessOrderBy>

Specifies how rows are ordered in the response.

return_entity_quota: bool

Toggles whether to return the current state of this Analytics Property’s quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

include_all_users: bool

Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.

expand_groups: bool

Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.

Trait Implementations

impl Clone for RunAccessReportRequest

fn clone(&self) -> RunAccessReportRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RunAccessReportRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RunAccessReportRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for RunAccessReportRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RunAccessReportRequest

fn eq(&self, other: &RunAccessReportRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RunAccessReportRequest