com.google.analytics.data.v1beta

Class CheckCompatibilityRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1beta.CheckCompatibilityRequest

All Implemented Interfaces:

CheckCompatibilityRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CheckCompatibilityRequest
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckCompatibilityRequest.Builder The request for compatibility information for a report's dimensions and metrics.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPATIBILITY_FILTER_FIELD_NUMBER
static int	DIMENSION_FILTER_FIELD_NUMBER
static int	DIMENSIONS_FIELD_NUMBER
static int	METRIC_FILTER_FIELD_NUMBER
static int	METRICS_FIELD_NUMBER
static int	PROPERTY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Compatibility	getCompatibilityFilter() Filters the dimensions and metrics in the response to just this compatibility.
int	getCompatibilityFilterValue() Filters the dimensions and metrics in the response to just this compatibility.
static CheckCompatibilityRequest	getDefaultInstance()
CheckCompatibilityRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
FilterExpression	getDimensionFilter() The filter clause of dimensions.
FilterExpressionOrBuilder	getDimensionFilterOrBuilder() The filter clause of dimensions.
Dimension	getDimensions(int index) The dimensions in this report.
int	getDimensionsCount() The dimensions in this report.
List<Dimension>	getDimensionsList() The dimensions in this report.
DimensionOrBuilder	getDimensionsOrBuilder(int index) The dimensions in this report.
List<? extends DimensionOrBuilder>	getDimensionsOrBuilderList() The dimensions in this report.
FilterExpression	getMetricFilter() The filter clause of metrics.
FilterExpressionOrBuilder	getMetricFilterOrBuilder() The filter clause of metrics.
Metric	getMetrics(int index) The metrics in this report.
int	getMetricsCount() The metrics in this report.
List<Metric>	getMetricsList() The metrics in this report.
MetricOrBuilder	getMetricsOrBuilder(int index) The metrics in this report.
List<? extends MetricOrBuilder>	getMetricsOrBuilderList() The metrics in this report.
com.google.protobuf.Parser<CheckCompatibilityRequest>	getParserForType()
String	getProperty() A Google Analytics GA4 property identifier whose events are tracked.
com.google.protobuf.ByteString	getPropertyBytes() A Google Analytics GA4 property identifier whose events are tracked.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDimensionFilter() The filter clause of dimensions.
int	hashCode()
boolean	hasMetricFilter() The filter clause of metrics.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CheckCompatibilityRequest.Builder	newBuilder()
static CheckCompatibilityRequest.Builder	newBuilder(CheckCompatibilityRequest prototype)
CheckCompatibilityRequest.Builder	newBuilderForType()
protected CheckCompatibilityRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CheckCompatibilityRequest	parseDelimitedFrom(InputStream input)
static CheckCompatibilityRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckCompatibilityRequest	parseFrom(byte[] data)
static CheckCompatibilityRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckCompatibilityRequest	parseFrom(ByteBuffer data)
static CheckCompatibilityRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckCompatibilityRequest	parseFrom(com.google.protobuf.ByteString data)
static CheckCompatibilityRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckCompatibilityRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static CheckCompatibilityRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckCompatibilityRequest	parseFrom(InputStream input)
static CheckCompatibilityRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CheckCompatibilityRequest>	parser()
CheckCompatibilityRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER

See Also:

Constant Field Values

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

See Also:

Constant Field Values

DIMENSION_FILTER_FIELD_NUMBER

public static final int DIMENSION_FILTER_FIELD_NUMBER

See Also:

Constant Field Values

METRIC_FILTER_FIELD_NUMBER

public static final int METRIC_FILTER_FIELD_NUMBER

See Also:

Constant Field Values

COMPATIBILITY_FILTER_FIELD_NUMBER

public static final int COMPATIBILITY_FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProperty

public String getProperty()

 A Google Analytics GA4 property identifier whose events are tracked. To
 learn more, see [where to find your Property
 ID](https://developers.google.com/analytics/devguides/reporting/data/v1/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;

Specified by:

getProperty in interface CheckCompatibilityRequestOrBuilder

Returns:

The property.

getPropertyBytes

public com.google.protobuf.ByteString getPropertyBytes()

 A Google Analytics GA4 property identifier whose events are tracked. To
 learn more, see [where to find your Property
 ID](https://developers.google.com/analytics/devguides/reporting/data/v1/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;

Specified by:

getPropertyBytes in interface CheckCompatibilityRequestOrBuilder

Returns:

The bytes for property.

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;

Specified by:

getDimensionsList in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

getDimensionsOrBuilderList in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

getDimensionsCount in interface CheckCompatibilityRequestOrBuilder

getDimensions

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;

Specified by:

getDimensions in interface CheckCompatibilityRequestOrBuilder

getDimensionsOrBuilder

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;

Specified by:

getDimensionsOrBuilder in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

getMetricsList in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

getMetricsOrBuilderList in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

getMetricsCount in interface CheckCompatibilityRequestOrBuilder

getMetrics

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;

Specified by:

getMetrics in interface CheckCompatibilityRequestOrBuilder

getMetricsOrBuilder

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;

Specified by:

getMetricsOrBuilder in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

hasDimensionFilter in interface CheckCompatibilityRequestOrBuilder

Returns:

Whether the dimensionFilter field is set.

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;

Specified by:

getDimensionFilter in interface CheckCompatibilityRequestOrBuilder

Returns:

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;

Specified by:

getDimensionFilterOrBuilder in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

hasMetricFilter in interface CheckCompatibilityRequestOrBuilder

Returns:

Whether the metricFilter field is set.

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;

Specified by:

getMetricFilter in interface CheckCompatibilityRequestOrBuilder

Returns:

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;

Specified by:

getMetricFilterOrBuilder in interface CheckCompatibilityRequestOrBuilder

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;

Specified by:

getCompatibilityFilterValue in interface CheckCompatibilityRequestOrBuilder

Returns:

The enum numeric value on the wire for compatibilityFilter.

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;

Specified by:

getCompatibilityFilter in interface CheckCompatibilityRequestOrBuilder

Returns:

The compatibilityFilter.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CheckCompatibilityRequest parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckCompatibilityRequest parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckCompatibilityRequest parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckCompatibilityRequest parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckCompatibilityRequest parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckCompatibilityRequest parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckCompatibilityRequest parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static CheckCompatibilityRequest parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckCompatibilityRequest parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckCompatibilityRequest parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static CheckCompatibilityRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static CheckCompatibilityRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public CheckCompatibilityRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CheckCompatibilityRequest.Builder newBuilder()

newBuilder

public static CheckCompatibilityRequest.Builder newBuilder(CheckCompatibilityRequest prototype)

toBuilder

public CheckCompatibilityRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CheckCompatibilityRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CheckCompatibilityRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<CheckCompatibilityRequest> parser()

getParserForType

public com.google.protobuf.Parser<CheckCompatibilityRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CheckCompatibilityRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder