Class ResponseMetaData.Builder (0.63.0) 

public static final class ResponseMetaData.Builder extends GeneratedMessageV3.Builder<ResponseMetaData.Builder> implements ResponseMetaDataOrBuilder

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

Protobuf type google.analytics.data.v1alpha.ResponseMetaData

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ResponseMetaData.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResponseMetaData.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResponseMetaData.Builder
Overrides

build()

public ResponseMetaData build()
Returns
Type Description
ResponseMetaData

buildPartial()

public ResponseMetaData buildPartial()
Returns
Type Description
ResponseMetaData

clear()

public ResponseMetaData.Builder clear()
Returns
Type Description
ResponseMetaData.Builder
Overrides

clearCurrencyCode()

public ResponseMetaData.Builder clearCurrencyCode()

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
Type Description
ResponseMetaData.Builder

This builder for chaining.

clearDataLossFromOtherRow()

public ResponseMetaData.Builder clearDataLossFromOtherRow()

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

The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

To learn more, see About the (other) row and data sampling.

bool data_loss_from_other_row = 3;

Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

clearEmptyReason()

public ResponseMetaData.Builder clearEmptyReason()

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

optional string empty_reason = 7;

Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ResponseMetaData.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ResponseMetaData.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ResponseMetaData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ResponseMetaData.Builder
Overrides

clearSchemaRestrictionResponse()

public ResponseMetaData.Builder clearSchemaRestrictionResponse()

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

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

Returns
Type Description
ResponseMetaData.Builder

clearSubjectToThresholding()

public ResponseMetaData.Builder clearSubjectToThresholding()

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
Type Description
ResponseMetaData.Builder

This builder for chaining.

clearTimeZone()

public ResponseMetaData.Builder clearTimeZone()

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
Type Description
ResponseMetaData.Builder

This builder for chaining.

clone()

public ResponseMetaData.Builder clone()
Returns
Type Description
ResponseMetaData.Builder
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
Type Description
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
Type Description
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.

The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

To learn more, see About the (other) row and data sampling.

bool data_loss_from_other_row = 3;

Returns
Type Description
boolean

The dataLossFromOtherRow.

getDefaultInstanceForType()

public ResponseMetaData getDefaultInstanceForType()
Returns
Type Description
ResponseMetaData

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEmptyReason()

public String getEmptyReason()

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

optional string empty_reason = 7;

Returns
Type Description
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
Type Description
ByteString

The bytes for emptyReason.

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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type Description
ResponseMetaData.SchemaRestrictionResponse

The schemaRestrictionResponse.

getSchemaRestrictionResponseBuilder()

public ResponseMetaData.SchemaRestrictionResponse.Builder getSchemaRestrictionResponseBuilder()

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

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

Returns
Type Description
ResponseMetaData.SchemaRestrictionResponse.Builder

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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type Description
ResponseMetaData.SchemaRestrictionResponseOrBuilder

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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for timeZone.

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
Type Description
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
Type Description
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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the timeZone field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ResponseMetaData other)

public ResponseMetaData.Builder mergeFrom(ResponseMetaData other)
Parameter
Name Description
other ResponseMetaData
Returns
Type Description
ResponseMetaData.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ResponseMetaData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMetaData.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ResponseMetaData.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ResponseMetaData.Builder
Overrides

mergeSchemaRestrictionResponse(ResponseMetaData.SchemaRestrictionResponse value)

public ResponseMetaData.Builder mergeSchemaRestrictionResponse(ResponseMetaData.SchemaRestrictionResponse value)

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

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

Parameter
Name Description
value ResponseMetaData.SchemaRestrictionResponse
Returns
Type Description
ResponseMetaData.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResponseMetaData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResponseMetaData.Builder
Overrides

setCurrencyCode(String value)

public ResponseMetaData.Builder setCurrencyCode(String value)

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;

Parameter
Name Description
value String

The currencyCode to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public ResponseMetaData.Builder setCurrencyCodeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for currencyCode to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setDataLossFromOtherRow(boolean value)

public ResponseMetaData.Builder setDataLossFromOtherRow(boolean value)

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

The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

To learn more, see About the (other) row and data sampling.

bool data_loss_from_other_row = 3;

Parameter
Name Description
value boolean

The dataLossFromOtherRow to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setEmptyReason(String value)

public ResponseMetaData.Builder setEmptyReason(String value)

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

optional string empty_reason = 7;

Parameter
Name Description
value String

The emptyReason to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setEmptyReasonBytes(ByteString value)

public ResponseMetaData.Builder setEmptyReasonBytes(ByteString value)

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

optional string empty_reason = 7;

Parameter
Name Description
value ByteString

The bytes for emptyReason to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ResponseMetaData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResponseMetaData.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ResponseMetaData.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ResponseMetaData.Builder
Overrides

setSchemaRestrictionResponse(ResponseMetaData.SchemaRestrictionResponse value)

public ResponseMetaData.Builder setSchemaRestrictionResponse(ResponseMetaData.SchemaRestrictionResponse value)

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

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

Parameter
Name Description
value ResponseMetaData.SchemaRestrictionResponse
Returns
Type Description
ResponseMetaData.Builder

setSchemaRestrictionResponse(ResponseMetaData.SchemaRestrictionResponse.Builder builderForValue)

public ResponseMetaData.Builder setSchemaRestrictionResponse(ResponseMetaData.SchemaRestrictionResponse.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue ResponseMetaData.SchemaRestrictionResponse.Builder
Returns
Type Description
ResponseMetaData.Builder

setSubjectToThresholding(boolean value)

public ResponseMetaData.Builder setSubjectToThresholding(boolean value)

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;

Parameter
Name Description
value boolean

The subjectToThresholding to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setTimeZone(String value)

public ResponseMetaData.Builder setTimeZone(String value)

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;

Parameter
Name Description
value String

The timeZone to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public ResponseMetaData.Builder setTimeZoneBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for timeZone to set.
Returns
Type Description
ResponseMetaData.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ResponseMetaData.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResponseMetaData.Builder
Overrides