Google Analytics Data V1beta API - Class Google::Analytics::Data::V1beta::CheckCompatibilityRequest (v0.4.3)

Version latest

• 0.4.3 (latest)
• 0.4.2

Reference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::CheckCompatibilityRequest.

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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#compatibility_filter

def compatibility_filter() -> ::Google::Analytics::Data::V1beta::Compatibility

Returns

• (::Google::Analytics::Data::V1beta::Compatibility) — Filters the dimensions and metrics in the response to just this compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE” to only return compatible dimensions & metrics.

#compatibility_filter=

def compatibility_filter=(value) -> ::Google::Analytics::Data::V1beta::Compatibility

Parameter

• value (::Google::Analytics::Data::V1beta::Compatibility) — Filters the dimensions and metrics in the response to just this compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE” to only return compatible dimensions & metrics.

Returns

• (::Google::Analytics::Data::V1beta::Compatibility) — Filters the dimensions and metrics in the response to just this compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE” to only return compatible dimensions & metrics.

#dimension_filter

def dimension_filter() -> ::Google::Analytics::Data::V1beta::FilterExpression

Returns

• (::Google::Analytics::Data::V1beta::FilterExpression) — The filter clause of dimensions. dimensionFilter should be the same value as in your runReport request.

#dimension_filter=

def dimension_filter=(value) -> ::Google::Analytics::Data::V1beta::FilterExpression

Parameter

• value (::Google::Analytics::Data::V1beta::FilterExpression) — The filter clause of dimensions. dimensionFilter should be the same value as in your runReport request.

Returns

• (::Google::Analytics::Data::V1beta::FilterExpression) — The filter clause of dimensions. dimensionFilter should be the same value as in your runReport request.

#dimensions

def dimensions() -> ::Array<::Google::Analytics::Data::V1beta::Dimension>

Returns

• (::Array<::Google::Analytics::Data::V1beta::Dimension>) — The dimensions in this report. dimensions should be the same value as in your runReport request.

#dimensions=

def dimensions=(value) -> ::Array<::Google::Analytics::Data::V1beta::Dimension>

Parameter

• value (::Array<::Google::Analytics::Data::V1beta::Dimension>) — The dimensions in this report. dimensions should be the same value as in your runReport request.

Returns

• (::Array<::Google::Analytics::Data::V1beta::Dimension>) — The dimensions in this report. dimensions should be the same value as in your runReport request.

#metric_filter

def metric_filter() -> ::Google::Analytics::Data::V1beta::FilterExpression

Returns

• (::Google::Analytics::Data::V1beta::FilterExpression) — The filter clause of metrics. metricFilter should be the same value as in your runReport request

#metric_filter=

def metric_filter=(value) -> ::Google::Analytics::Data::V1beta::FilterExpression

Parameter

• value (::Google::Analytics::Data::V1beta::FilterExpression) — The filter clause of metrics. metricFilter should be the same value as in your runReport request

Returns

• (::Google::Analytics::Data::V1beta::FilterExpression) — The filter clause of metrics. metricFilter should be the same value as in your runReport request

#metrics

def metrics() -> ::Array<::Google::Analytics::Data::V1beta::Metric>

Returns

• (::Array<::Google::Analytics::Data::V1beta::Metric>) — The metrics in this report. metrics should be the same value as in your runReport request.

#metrics=

def metrics=(value) -> ::Array<::Google::Analytics::Data::V1beta::Metric>

Parameter

• value (::Array<::Google::Analytics::Data::V1beta::Metric>) — The metrics in this report. metrics should be the same value as in your runReport request.

Returns

• (::Array<::Google::Analytics::Data::V1beta::Metric>) — The metrics in this report. metrics should be the same value as in your runReport request.

#property

def property() -> ::String

Returns

• (::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.

#property=

def property=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.