Struct google_api_proto::google::analytics::data::v1beta::ResponseMetaData

pub struct ResponseMetaData {
    pub data_loss_from_other_row: bool,
    pub schema_restriction_response: Option<SchemaRestrictionResponse>,
    pub currency_code: Option<String>,
    pub time_zone: Option<String>,
    pub empty_reason: Option<String>,
    pub subject_to_thresholding: Option<bool>,
    pub sampling_metadatas: Vec<SamplingMetadata>,
}

Response’s metadata carrying additional information about the report content.

Fields

data_loss_from_other_row: bool

If true, indicates some buckets of dimension combinations are rolled into “(other)” row. This can happen for high cardinality reports.

The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

To learn more, see About the (other) row and data sampling.

schema_restriction_response: Option<SchemaRestrictionResponse>

Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

currency_code: Option<String>

The currency code used in this report. Intended to be used in formatting currency metrics like purchaseRevenue for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property’s current currency_code.

Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example “USD”, “EUR”, “JPY”. To learn more, see https://support.google.com/analytics/answer/9796179.

time_zone: Option<String>

The property’s current timezone. Intended to be used to interpret time-based dimensions like hour and minute. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example “America/New_York” or “Asia/Tokyo”.

empty_reason: Option<String>

If empty reason is specified, the report is empty for this reason.

subject_to_thresholding: Option<bool>

If subjectToThresholding is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see Data thresholds.

sampling_metadatas: Vec<SamplingMetadata>

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

Implementations

impl ResponseMetaData

pub fn currency_code(&self) -> &str

Returns the value of currency_code, or the default value if currency_code is unset.

pub fn time_zone(&self) -> &str

Returns the value of time_zone, or the default value if time_zone is unset.

pub fn empty_reason(&self) -> &str

Returns the value of empty_reason, or the default value if empty_reason is unset.

pub fn subject_to_thresholding(&self) -> bool

Returns the value of subject_to_thresholding, or the default value if subject_to_thresholding is unset.

Trait Implementations

impl Clone for ResponseMetaData

fn clone(&self) -> ResponseMetaData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseMetaData

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

Formats the value using the given formatter.

impl Default for ResponseMetaData

fn default() -> Self

Returns the “default value” for a type.

impl Message for ResponseMetaData

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 ResponseMetaData

fn eq(&self, other: &ResponseMetaData) -> 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 ResponseMetaData