Google Analytics Data V1beta Client - Class CheckCompatibilityRequest (0.10.1)

Version 0.10.1

• 0.21.1 (latest)
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.4
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.2
• 0.10.1
• 0.9.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Analytics Data V1beta Client class 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.

Generated from protobuf message google.analytics.data.v1beta.CheckCompatibilityRequest

Namespace

Google \ Analytics \ Data \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ 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	array<Google\Analytics\Data\V1beta\Dimension> The dimensions in this report. dimensions should be the same value as in your runReport request.
↳ metrics	array<Google\Analytics\Data\V1beta\Metric> The metrics in this report. metrics should be the same value as in your runReport request.
↳ dimension_filter	Google\Analytics\Data\V1beta\FilterExpression The filter clause of dimensions. dimensionFilter should be the same value as in your runReport request.
↳ metric_filter	Google\Analytics\Data\V1beta\FilterExpression The filter clause of metrics. metricFilter should be the same value as in your runReport request
↳ compatibility_filter	int Filters the dimensions and metrics in the response to just this compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE” to only return compatible dimensions & metrics.

getProperty

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
Type	Description
string

setProperty

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDimensions

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDimensions

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

Parameter
Name	Description
var	array<Google\Analytics\Data\V1beta\Dimension>

Returns
Type	Description
$this

getMetrics

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setMetrics

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

Parameter
Name	Description
var	array<Google\Analytics\Data\V1beta\Metric>

Returns
Type	Description
$this

getDimensionFilter

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

Returns
Type	Description
Google\Analytics\Data\V1beta\FilterExpression|null

hasDimensionFilter

clearDimensionFilter

setDimensionFilter

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

Parameter
Name	Description
var	Google\Analytics\Data\V1beta\FilterExpression

Returns
Type	Description
$this

getMetricFilter

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

Returns
Type	Description
Google\Analytics\Data\V1beta\FilterExpression|null

hasMetricFilter

clearMetricFilter

setMetricFilter

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

Parameter
Name	Description
var	Google\Analytics\Data\V1beta\FilterExpression

Returns
Type	Description
$this

getCompatibilityFilter

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

Returns
Type	Description
int

setCompatibilityFilter

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this