com.google.analytics.data.v1beta

Class ResponseMetaData

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1beta.ResponseMetaData

All Implemented Interfaces:

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

public final class ResponseMetaData
extends com.google.protobuf.GeneratedMessageV3
implements ResponseMetaDataOrBuilder

 Response's metadata carrying additional information about the report content.
 

Protobuf type google.analytics.data.v1beta.ResponseMetaData

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponseMetaData.Builder Response's metadata carrying additional information about the report content.
static class	ResponseMetaData.SchemaRestrictionResponse The schema restrictions actively enforced in creating this report.
static interface	ResponseMetaData.SchemaRestrictionResponseOrBuilder

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	CURRENCY_CODE_FIELD_NUMBER
static int	DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER
static int	EMPTY_REASON_FIELD_NUMBER
static int	SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER
static int	SUBJECT_TO_THRESHOLDING_FIELD_NUMBER
static int	TIME_ZONE_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)
String	getCurrencyCode() The currency code used in this report.
com.google.protobuf.ByteString	getCurrencyCodeBytes() The currency code used in this report.
boolean	getDataLossFromOtherRow() If true, indicates some buckets of dimension combinations are rolled into "(other)" row.
static ResponseMetaData	getDefaultInstance()
ResponseMetaData	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEmptyReason() If empty reason is specified, the report is empty for this reason.
com.google.protobuf.ByteString	getEmptyReasonBytes() If empty reason is specified, the report is empty for this reason.
com.google.protobuf.Parser<ResponseMetaData>	getParserForType()
ResponseMetaData.SchemaRestrictionResponse	getSchemaRestrictionResponse() Describes the schema restrictions actively enforced in creating this report.
ResponseMetaData.SchemaRestrictionResponseOrBuilder	getSchemaRestrictionResponseOrBuilder() Describes the schema restrictions actively enforced in creating this report.
int	getSerializedSize()
boolean	getSubjectToThresholding() If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds.
String	getTimeZone() The property's current timezone.
com.google.protobuf.ByteString	getTimeZoneBytes() The property's current timezone.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCurrencyCode() The currency code used in this report.
boolean	hasEmptyReason() If empty reason is specified, the report is empty for this reason.
int	hashCode()
boolean	hasSchemaRestrictionResponse() Describes the schema restrictions actively enforced in creating this report.
boolean	hasSubjectToThresholding() If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds.
boolean	hasTimeZone() The property's current timezone.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ResponseMetaData.Builder	newBuilder()
static ResponseMetaData.Builder	newBuilder(ResponseMetaData prototype)
ResponseMetaData.Builder	newBuilderForType()
protected ResponseMetaData.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ResponseMetaData	parseDelimitedFrom(InputStream input)
static ResponseMetaData	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResponseMetaData	parseFrom(byte[] data)
static ResponseMetaData	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResponseMetaData	parseFrom(ByteBuffer data)
static ResponseMetaData	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResponseMetaData	parseFrom(com.google.protobuf.ByteString data)
static ResponseMetaData	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResponseMetaData	parseFrom(com.google.protobuf.CodedInputStream input)
static ResponseMetaData	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResponseMetaData	parseFrom(InputStream input)
static ResponseMetaData	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ResponseMetaData>	parser()
ResponseMetaData.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

DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER

public static final int DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER

See Also:

Constant Field Values

SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER

public static final int SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER

See Also:

Constant Field Values

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER

See Also:

Constant Field Values

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER

See Also:

Constant Field Values

EMPTY_REASON_FIELD_NUMBER

public static final int EMPTY_REASON_FIELD_NUMBER

See Also:

Constant Field Values

SUBJECT_TO_THRESHOLDING_FIELD_NUMBER

public static final int SUBJECT_TO_THRESHOLDING_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

getDataLossFromOtherRow

public boolean getDataLossFromOtherRow()

 If true, indicates some buckets of dimension combinations are rolled into
 "(other)" row. This can happen for high cardinality reports.
 

bool data_loss_from_other_row = 3;

Specified by:

getDataLossFromOtherRow in interface ResponseMetaDataOrBuilder

Returns:

The dataLossFromOtherRow.

hasSchemaRestrictionResponse

public boolean hasSchemaRestrictionResponse()

 Describes the schema restrictions actively enforced in creating this
 report. To learn more, see [Access and data-restriction
 management](https://support.google.com/analytics/answer/10851388).
 

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Specified by:

hasSchemaRestrictionResponse in interface ResponseMetaDataOrBuilder

Returns:

Whether the schemaRestrictionResponse field is set.

getSchemaRestrictionResponse

public ResponseMetaData.SchemaRestrictionResponse getSchemaRestrictionResponse()

 Describes the schema restrictions actively enforced in creating this
 report. To learn more, see [Access and data-restriction
 management](https://support.google.com/analytics/answer/10851388).
 

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Specified by:

getSchemaRestrictionResponse in interface ResponseMetaDataOrBuilder

Returns:

The schemaRestrictionResponse.

getSchemaRestrictionResponseOrBuilder

public ResponseMetaData.SchemaRestrictionResponseOrBuilder getSchemaRestrictionResponseOrBuilder()

 Describes the schema restrictions actively enforced in creating this
 report. To learn more, see [Access and data-restriction
 management](https://support.google.com/analytics/answer/10851388).
 

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Specified by:

getSchemaRestrictionResponseOrBuilder in interface ResponseMetaDataOrBuilder

hasCurrencyCode

public boolean hasCurrencyCode()

 The currency code used in this report. Intended to be used in formatting
 currency metrics like `purchaseRevenue` for visualization. If currency_code
 was specified in the request, this response parameter will echo the request
 parameter; otherwise, this response parameter is the property's current
 currency_code.
 Currency codes are string encodings of currency types from the ISO 4217
 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD",
 "EUR", "JPY". To learn more, see
 https://support.google.com/analytics/answer/9796179.
 

optional string currency_code = 5;

Specified by:

hasCurrencyCode in interface ResponseMetaDataOrBuilder

Returns:

Whether the currencyCode field is set.

getCurrencyCode

public String getCurrencyCode()

 The currency code used in this report. Intended to be used in formatting
 currency metrics like `purchaseRevenue` for visualization. If currency_code
 was specified in the request, this response parameter will echo the request
 parameter; otherwise, this response parameter is the property's current
 currency_code.
 Currency codes are string encodings of currency types from the ISO 4217
 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD",
 "EUR", "JPY". To learn more, see
 https://support.google.com/analytics/answer/9796179.
 

optional string currency_code = 5;

Specified by:

getCurrencyCode in interface ResponseMetaDataOrBuilder

Returns:

The currencyCode.

getCurrencyCodeBytes

public com.google.protobuf.ByteString getCurrencyCodeBytes()

 The currency code used in this report. Intended to be used in formatting
 currency metrics like `purchaseRevenue` for visualization. If currency_code
 was specified in the request, this response parameter will echo the request
 parameter; otherwise, this response parameter is the property's current
 currency_code.
 Currency codes are string encodings of currency types from the ISO 4217
 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD",
 "EUR", "JPY". To learn more, see
 https://support.google.com/analytics/answer/9796179.
 

optional string currency_code = 5;

Specified by:

getCurrencyCodeBytes in interface ResponseMetaDataOrBuilder

Returns:

The bytes for currencyCode.

hasTimeZone

public boolean hasTimeZone()

 The property's current timezone. Intended to be used to interpret
 time-based dimensions like `hour` and `minute`. Formatted as strings from
 the IANA Time Zone database (https://www.iana.org/time-zones); for example
 "America/New_York" or "Asia/Tokyo".
 

optional string time_zone = 6;

Specified by:

hasTimeZone in interface ResponseMetaDataOrBuilder

Returns:

Whether the timeZone field is set.

getTimeZone

public String getTimeZone()

 The property's current timezone. Intended to be used to interpret
 time-based dimensions like `hour` and `minute`. Formatted as strings from
 the IANA Time Zone database (https://www.iana.org/time-zones); for example
 "America/New_York" or "Asia/Tokyo".
 

optional string time_zone = 6;

Specified by:

getTimeZone in interface ResponseMetaDataOrBuilder

Returns:

The timeZone.

getTimeZoneBytes

public com.google.protobuf.ByteString getTimeZoneBytes()

 The property's current timezone. Intended to be used to interpret
 time-based dimensions like `hour` and `minute`. Formatted as strings from
 the IANA Time Zone database (https://www.iana.org/time-zones); for example
 "America/New_York" or "Asia/Tokyo".
 

optional string time_zone = 6;

Specified by:

getTimeZoneBytes in interface ResponseMetaDataOrBuilder

Returns:

The bytes for timeZone.

hasEmptyReason

public boolean hasEmptyReason()

 If empty reason is specified, the report is empty for this reason.
 

optional string empty_reason = 7;

Specified by:

hasEmptyReason in interface ResponseMetaDataOrBuilder

Returns:

Whether the emptyReason field is set.

getEmptyReason

public String getEmptyReason()

 If empty reason is specified, the report is empty for this reason.
 

optional string empty_reason = 7;

Specified by:

getEmptyReason in interface ResponseMetaDataOrBuilder

Returns:

The emptyReason.

getEmptyReasonBytes

public com.google.protobuf.ByteString getEmptyReasonBytes()

 If empty reason is specified, the report is empty for this reason.
 

optional string empty_reason = 7;

Specified by:

getEmptyReasonBytes in interface ResponseMetaDataOrBuilder

Returns:

The bytes for emptyReason.

hasSubjectToThresholding

public boolean hasSubjectToThresholding()

 If `subjectToThresholding` is true, this report is subject to thresholding
 and only returns data that meets the minimum aggregation thresholds. It is
 possible for a request to be subject to thresholding thresholding and no
 data is absent from the report, and this happens when all data is above the
 thresholds. To learn more, see [Data
 thresholds](https://support.google.com/analytics/answer/9383630) and [About
 Demographics and
 Interests](https://support.google.com/analytics/answer/2799357).
 

optional bool subject_to_thresholding = 8;

Specified by:

hasSubjectToThresholding in interface ResponseMetaDataOrBuilder

Returns:

Whether the subjectToThresholding field is set.

getSubjectToThresholding

public boolean getSubjectToThresholding()

 If `subjectToThresholding` is true, this report is subject to thresholding
 and only returns data that meets the minimum aggregation thresholds. It is
 possible for a request to be subject to thresholding thresholding and no
 data is absent from the report, and this happens when all data is above the
 thresholds. To learn more, see [Data
 thresholds](https://support.google.com/analytics/answer/9383630) and [About
 Demographics and
 Interests](https://support.google.com/analytics/answer/2799357).
 

optional bool subject_to_thresholding = 8;

Specified by:

getSubjectToThresholding in interface ResponseMetaDataOrBuilder

Returns:

The subjectToThresholding.

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 ResponseMetaData parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResponseMetaData parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ResponseMetaData parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ResponseMetaData.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ResponseMetaData.Builder newBuilder()

newBuilder

public static ResponseMetaData.Builder newBuilder(ResponseMetaData prototype)

toBuilder

public ResponseMetaData.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ResponseMetaData getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ResponseMetaData> 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 ResponseMetaData getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder