public final class CheckCompatibilityRequest extends GeneratedMessageV3 implements CheckCompatibilityRequestOrBuilder
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.
Protobuf type google.analytics.data.v1beta.CheckCompatibilityRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
COMPATIBILITY_FILTER_FIELD_NUMBER
public static final int COMPATIBILITY_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIMENSION_FILTER_FIELD_NUMBER
public static final int DIMENSION_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_FILTER_FIELD_NUMBER
public static final int METRIC_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROPERTY_FIELD_NUMBER
public static final int PROPERTY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static CheckCompatibilityRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CheckCompatibilityRequest.Builder newBuilder()
newBuilder(CheckCompatibilityRequest prototype)
public static CheckCompatibilityRequest.Builder newBuilder(CheckCompatibilityRequest prototype)
public static CheckCompatibilityRequest parseDelimitedFrom(InputStream input)
public static CheckCompatibilityRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CheckCompatibilityRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CheckCompatibilityRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CheckCompatibilityRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CheckCompatibilityRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CheckCompatibilityRequest parseFrom(CodedInputStream input)
public static CheckCompatibilityRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CheckCompatibilityRequest parseFrom(InputStream input)
public static CheckCompatibilityRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CheckCompatibilityRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CheckCompatibilityRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CheckCompatibilityRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCompatibilityFilter()
public Compatibility getCompatibilityFilter()
Filters the dimensions and metrics in the response to just this
compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE”
to only return compatible dimensions & metrics.
.google.analytics.data.v1beta.Compatibility compatibility_filter = 6;
getCompatibilityFilterValue()
public int getCompatibilityFilterValue()
Filters the dimensions and metrics in the response to just this
compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE”
to only return compatible dimensions & metrics.
.google.analytics.data.v1beta.Compatibility compatibility_filter = 6;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for compatibilityFilter.
|
getDefaultInstanceForType()
public CheckCompatibilityRequest getDefaultInstanceForType()
getDimensionFilter()
public FilterExpression getDimensionFilter()
The filter clause of dimensions. dimensionFilter should be the same value
as in your runReport request.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;
getDimensionFilterOrBuilder()
public FilterExpressionOrBuilder getDimensionFilterOrBuilder()
The filter clause of dimensions. dimensionFilter should be the same value
as in your runReport request.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;
getDimensions(int index)
public Dimension getDimensions(int index)
The dimensions in this report. dimensions should be the same value as in
your runReport request.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getDimensionsCount()
public int getDimensionsCount()
The dimensions in this report. dimensions should be the same value as in
your runReport request.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
| Returns |
|---|
| Type | Description |
int | |
getDimensionsList()
public List<Dimension> getDimensionsList()
The dimensions in this report. dimensions should be the same value as in
your runReport request.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
getDimensionsOrBuilder(int index)
public DimensionOrBuilder getDimensionsOrBuilder(int index)
The dimensions in this report. dimensions should be the same value as in
your runReport request.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getDimensionsOrBuilderList()
public List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()
The dimensions in this report. dimensions should be the same value as in
your runReport request.
repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.DimensionOrBuilder> | |
getMetricFilter()
public FilterExpression getMetricFilter()
The filter clause of metrics. metricFilter should be the same value as in
your runReport request
.google.analytics.data.v1beta.FilterExpression metric_filter = 5;
getMetricFilterOrBuilder()
public FilterExpressionOrBuilder getMetricFilterOrBuilder()
The filter clause of metrics. metricFilter should be the same value as in
your runReport request
.google.analytics.data.v1beta.FilterExpression metric_filter = 5;
getMetrics(int index)
public Metric getMetrics(int index)
The metrics in this report. metrics should be the same value as in your
runReport request.
repeated .google.analytics.data.v1beta.Metric metrics = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getMetricsCount()
public int getMetricsCount()
The metrics in this report. metrics should be the same value as in your
runReport request.
repeated .google.analytics.data.v1beta.Metric metrics = 3;
| Returns |
|---|
| Type | Description |
int | |
getMetricsList()
public List<Metric> getMetricsList()
The metrics in this report. metrics should be the same value as in your
runReport request.
repeated .google.analytics.data.v1beta.Metric metrics = 3;
getMetricsOrBuilder(int index)
public MetricOrBuilder getMetricsOrBuilder(int index)
The metrics in this report. metrics should be the same value as in your
runReport request.
repeated .google.analytics.data.v1beta.Metric metrics = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getMetricsOrBuilderList()
public List<? extends MetricOrBuilder> getMetricsOrBuilderList()
The metrics in this report. metrics should be the same value as in your
runReport request.
repeated .google.analytics.data.v1beta.Metric metrics = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.MetricOrBuilder> | |
getParserForType()
public Parser<CheckCompatibilityRequest> getParserForType()
Overrides
getProperty()
public String 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.
string property = 1;
| Returns |
|---|
| Type | Description |
String | The property.
|
getPropertyBytes()
public ByteString getPropertyBytes()
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.
string property = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for property.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hasDimensionFilter()
public boolean hasDimensionFilter()
The filter clause of dimensions. dimensionFilter should be the same value
as in your runReport request.
.google.analytics.data.v1beta.FilterExpression dimension_filter = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the dimensionFilter field is set.
|
hasMetricFilter()
public boolean hasMetricFilter()
The filter clause of metrics. metricFilter should be the same value as in
your runReport request
.google.analytics.data.v1beta.FilterExpression metric_filter = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the metricFilter field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CheckCompatibilityRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CheckCompatibilityRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public CheckCompatibilityRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
