Struct googapis::google::analytics::data::v1beta::CheckCompatibilityRequest

pub struct CheckCompatibilityRequest {
    pub property: String,
    pub dimensions: Vec<Dimension>,
    pub metrics: Vec<Metric>,
    pub dimension_filter: Option<FilterExpression>,
    pub metric_filter: Option<FilterExpression>,
    pub compatibility_filter: i32,
}

The request for compatibility information for a report’s dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the runReport request should be the same values as in your runReport request.

Fields

property: String

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.

dimensions: Vec<Dimension>

The dimensions in this report. dimensions should be the same value as in your runReport request.

metrics: Vec<Metric>

The metrics in this report. metrics should be the same value as in your runReport request.

dimension_filter: Option<FilterExpression>

The filter clause of dimensions. dimensionFilter should be the same value as in your runReport request.

metric_filter: Option<FilterExpression>

The filter clause of metrics. metricFilter should be the same value as in your runReport request

compatibility_filter: i32

Filters the dimensions and metrics in the response to just this compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE” to only return compatible dimensions & metrics.

Implementations

impl CheckCompatibilityRequest

pub fn compatibility_filter(&self) -> Compatibility

Returns the enum value of compatibility_filter, or the default if the field is set to an invalid enum value.

pub fn set_compatibility_filter(&mut self, value: Compatibility)

Sets compatibility_filter to the provided enum value.

Trait Implementations

impl Clone for CheckCompatibilityRequest

fn clone(&self) -> CheckCompatibilityRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckCompatibilityRequest

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

Formats the value using the given formatter.

impl Default for CheckCompatibilityRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for CheckCompatibilityRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

Encodes the message to a newly allocated buffer.

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

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

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<CheckCompatibilityRequest> for CheckCompatibilityRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for CheckCompatibilityRequest