Class CheckCompatibilityRequest (0.24.0)

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

Static Fields

COMPATIBILITY_FILTER_FIELD_NUMBER

public static final int COMPATIBILITY_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSION_FILTER_FIELD_NUMBER

public static final int DIMENSION_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_FILTER_FIELD_NUMBER

public static final int METRIC_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CheckCompatibilityRequest getDefaultInstance()
Returns
TypeDescription
CheckCompatibilityRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CheckCompatibilityRequest.Builder newBuilder()
Returns
TypeDescription
CheckCompatibilityRequest.Builder

newBuilder(CheckCompatibilityRequest prototype)

public static CheckCompatibilityRequest.Builder newBuilder(CheckCompatibilityRequest prototype)
Parameter
NameDescription
prototypeCheckCompatibilityRequest
Returns
TypeDescription
CheckCompatibilityRequest.Builder

parseDelimitedFrom(InputStream input)

public static CheckCompatibilityRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckCompatibilityRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CheckCompatibilityRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CheckCompatibilityRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CheckCompatibilityRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CheckCompatibilityRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CheckCompatibilityRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckCompatibilityRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CheckCompatibilityRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckCompatibilityRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CheckCompatibilityRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CheckCompatibilityRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckCompatibilityRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CheckCompatibilityRequest> parser()
Returns
TypeDescription
Parser<CheckCompatibilityRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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;

Returns
TypeDescription
Compatibility

The compatibilityFilter.

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
TypeDescription
int

The enum numeric value on the wire for compatibilityFilter.

getDefaultInstanceForType()

public CheckCompatibilityRequest getDefaultInstanceForType()
Returns
TypeDescription
CheckCompatibilityRequest

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;

Returns
TypeDescription
FilterExpression

The dimensionFilter.

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;

Returns
TypeDescription
FilterExpressionOrBuilder

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
NameDescription
indexint
Returns
TypeDescription
Dimension

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
TypeDescription
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;

Returns
TypeDescription
List<Dimension>

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
NameDescription
indexint
Returns
TypeDescription
DimensionOrBuilder

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
TypeDescription
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;

Returns
TypeDescription
FilterExpression

The metricFilter.

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;

Returns
TypeDescription
FilterExpressionOrBuilder

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
NameDescription
indexint
Returns
TypeDescription
Metric

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
TypeDescription
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;

Returns
TypeDescription
List<Metric>

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
NameDescription
indexint
Returns
TypeDescription
MetricOrBuilder

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
TypeDescription
List<? extends com.google.analytics.data.v1beta.MetricOrBuilder>

getParserForType()

public Parser<CheckCompatibilityRequest> getParserForType()
Returns
TypeDescription
Parser<CheckCompatibilityRequest>
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
TypeDescription
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
TypeDescription
ByteString

The bytes for property.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
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
TypeDescription
boolean

Whether the metricFilter field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CheckCompatibilityRequest.Builder newBuilderForType()
Returns
TypeDescription
CheckCompatibilityRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CheckCompatibilityRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CheckCompatibilityRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CheckCompatibilityRequest.Builder toBuilder()
Returns
TypeDescription
CheckCompatibilityRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException