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
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. |
↳ dimensions |
array<Google\Analytics\Data\V1beta\Dimension>
The dimensions in this report. |
↳ metrics |
array<Google\Analytics\Data\V1beta\Metric>
The metrics in this report. |
↳ dimension_filter |
Google\Analytics\Data\V1beta\FilterExpression
The filter clause of dimensions. |
↳ metric_filter |
Google\Analytics\Data\V1beta\FilterExpression
The filter clause of metrics. |
↳ compatibility_filter |
int
Filters the dimensions and metrics in the response to just this compatibility. Commonly used as |
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 | |