Class ResponseMetaData (0.17.0)

public final class ResponseMetaData extends GeneratedMessageV3 implements ResponseMetaDataOrBuilder

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

Protobuf type google.analytics.data.v1beta.ResponseMetaData

Static Fields

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER

public static final int DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER
Field Value
TypeDescription
int

EMPTY_REASON_FIELD_NUMBER

public static final int EMPTY_REASON_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER

public static final int SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER
Field Value
TypeDescription
int

SUBJECT_TO_THRESHOLDING_FIELD_NUMBER

public static final int SUBJECT_TO_THRESHOLDING_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ResponseMetaData getDefaultInstance()
Returns
TypeDescription
ResponseMetaData

getDescriptor()

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

newBuilder()

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

newBuilder(ResponseMetaData prototype)

public static ResponseMetaData.Builder newBuilder(ResponseMetaData prototype)
Parameter
NameDescription
prototypeResponseMetaData
Returns
TypeDescription
ResponseMetaData.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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;

Returns
TypeDescription
String

The currencyCode.

getCurrencyCodeBytes()

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

Returns
TypeDescription
ByteString

The bytes for currencyCode.

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;

Returns
TypeDescription
boolean

The dataLossFromOtherRow.

getDefaultInstanceForType()

public ResponseMetaData getDefaultInstanceForType()
Returns
TypeDescription
ResponseMetaData

getEmptyReason()

public String getEmptyReason()

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

optional string empty_reason = 7;

Returns
TypeDescription
String

The emptyReason.

getEmptyReasonBytes()

public ByteString getEmptyReasonBytes()

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

optional string empty_reason = 7;

Returns
TypeDescription
ByteString

The bytes for emptyReason.

getParserForType()

public Parser<ResponseMetaData> getParserForType()
Returns
TypeDescription
Parser<ResponseMetaData>
Overrides

getSchemaRestrictionResponse()

public ResponseMetaData.SchemaRestrictionResponse getSchemaRestrictionResponse()

Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

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

Returns
TypeDescription
ResponseMetaData.SchemaRestrictionResponse

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.

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

Returns
TypeDescription
ResponseMetaData.SchemaRestrictionResponseOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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 and About Demographics and Interests.

optional bool subject_to_thresholding = 8;

Returns
TypeDescription
boolean

The subjectToThresholding.

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;

Returns
TypeDescription
String

The timeZone.

getTimeZoneBytes()

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

Returns
TypeDescription
ByteString

The bytes for timeZone.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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;

Returns
TypeDescription
boolean

Whether the currencyCode field is set.

hasEmptyReason()

public boolean hasEmptyReason()

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

optional string empty_reason = 7;

Returns
TypeDescription
boolean

Whether the emptyReason field is set.

hasSchemaRestrictionResponse()

public boolean hasSchemaRestrictionResponse()

Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

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

Returns
TypeDescription
boolean

Whether the schemaRestrictionResponse field is set.

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 and About Demographics and Interests.

optional bool subject_to_thresholding = 8;

Returns
TypeDescription
boolean

Whether the subjectToThresholding field is set.

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;

Returns
TypeDescription
boolean

Whether the timeZone 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 ResponseMetaData.Builder newBuilderForType()
Returns
TypeDescription
ResponseMetaData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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