Class RunPivotReportResponse (0.54.0)

public final class RunPivotReportResponse extends GeneratedMessageV3 implements RunPivotReportResponseOrBuilder

The response pivot report table corresponding to a pivot request.

Protobuf type google.analytics.data.v1beta.RunPivotReportResponse

Static Fields

AGGREGATES_FIELD_NUMBER

public static final int AGGREGATES_FIELD_NUMBER
Field Value
Type Description
int

DIMENSION_HEADERS_FIELD_NUMBER

public static final int DIMENSION_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

METRIC_HEADERS_FIELD_NUMBER

public static final int METRIC_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

PIVOT_HEADERS_FIELD_NUMBER

public static final int PIVOT_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_QUOTA_FIELD_NUMBER

public static final int PROPERTY_QUOTA_FIELD_NUMBER
Field Value
Type Description
int

ROWS_FIELD_NUMBER

public static final int ROWS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunPivotReportResponse getDefaultInstance()
Returns
Type Description
RunPivotReportResponse

getDescriptor()

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

newBuilder()

public static RunPivotReportResponse.Builder newBuilder()
Returns
Type Description
RunPivotReportResponse.Builder

newBuilder(RunPivotReportResponse prototype)

public static RunPivotReportResponse.Builder newBuilder(RunPivotReportResponse prototype)
Parameter
Name Description
prototype RunPivotReportResponse
Returns
Type Description
RunPivotReportResponse.Builder

parseDelimitedFrom(InputStream input)

public static RunPivotReportResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunPivotReportResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunPivotReportResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunPivotReportResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunPivotReportResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunPivotReportResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunPivotReportResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunPivotReportResponse> parser()
Returns
Type Description
Parser<RunPivotReportResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregates(int index)

public Row getAggregates(int index)

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Parameter
Name Description
index int
Returns
Type Description
Row

getAggregatesCount()

public int getAggregatesCount()

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Returns
Type Description
int

getAggregatesList()

public List<Row> getAggregatesList()

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Returns
Type Description
List<Row>

getAggregatesOrBuilder(int index)

public RowOrBuilder getAggregatesOrBuilder(int index)

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Parameter
Name Description
index int
Returns
Type Description
RowOrBuilder

getAggregatesOrBuilderList()

public List<? extends RowOrBuilder> getAggregatesOrBuilderList()

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_<MetricAggregation>".

repeated .google.analytics.data.v1beta.Row aggregates = 5;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getDefaultInstanceForType()

public RunPivotReportResponse getDefaultInstanceForType()
Returns
Type Description
RunPivotReportResponse

getDimensionHeaders(int index)

public DimensionHeader getDimensionHeaders(int index)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Parameter
Name Description
index int
Returns
Type Description
DimensionHeader

getDimensionHeadersCount()

public int getDimensionHeadersCount()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Returns
Type Description
int

getDimensionHeadersList()

public List<DimensionHeader> getDimensionHeadersList()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Returns
Type Description
List<DimensionHeader>

getDimensionHeadersOrBuilder(int index)

public DimensionHeaderOrBuilder getDimensionHeadersOrBuilder(int index)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Parameter
Name Description
index int
Returns
Type Description
DimensionHeaderOrBuilder

getDimensionHeadersOrBuilderList()

public List<? extends DimensionHeaderOrBuilder> getDimensionHeadersOrBuilderList()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.DimensionHeaderOrBuilder>

getKind()

public String getKind()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

string kind = 8;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

string kind = 8;

Returns
Type Description
ByteString

The bytes for kind.

getMetadata()

public ResponseMetaData getMetadata()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 6;

Returns
Type Description
ResponseMetaData

The metadata.

getMetadataOrBuilder()

public ResponseMetaDataOrBuilder getMetadataOrBuilder()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 6;

Returns
Type Description
ResponseMetaDataOrBuilder

getMetricHeaders(int index)

public MetricHeader getMetricHeaders(int index)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Parameter
Name Description
index int
Returns
Type Description
MetricHeader

getMetricHeadersCount()

public int getMetricHeadersCount()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Returns
Type Description
int

getMetricHeadersList()

public List<MetricHeader> getMetricHeadersList()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Returns
Type Description
List<MetricHeader>

getMetricHeadersOrBuilder(int index)

public MetricHeaderOrBuilder getMetricHeadersOrBuilder(int index)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Parameter
Name Description
index int
Returns
Type Description
MetricHeaderOrBuilder

getMetricHeadersOrBuilderList()

public List<? extends MetricHeaderOrBuilder> getMetricHeadersOrBuilderList()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.MetricHeaderOrBuilder>

getParserForType()

public Parser<RunPivotReportResponse> getParserForType()
Returns
Type Description
Parser<RunPivotReportResponse>
Overrides

getPivotHeaders(int index)

public PivotHeader getPivotHeaders(int index)

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Parameter
Name Description
index int
Returns
Type Description
PivotHeader

getPivotHeadersCount()

public int getPivotHeadersCount()

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Returns
Type Description
int

getPivotHeadersList()

public List<PivotHeader> getPivotHeadersList()

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Returns
Type Description
List<PivotHeader>

getPivotHeadersOrBuilder(int index)

public PivotHeaderOrBuilder getPivotHeadersOrBuilder(int index)

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Parameter
Name Description
index int
Returns
Type Description
PivotHeaderOrBuilder

getPivotHeadersOrBuilderList()

public List<? extends PivotHeaderOrBuilder> getPivotHeadersOrBuilderList()

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

 "pivots": [{
   "fieldNames": ["country",
     "city"]
 },
 {
   "fieldNames": "eventName"
 }]

We will have the following pivotHeaders in the response:

 "pivotHeaders" : [{
   "dimensionHeaders": [{
     "dimensionValues": [
        { "value": "United Kingdom" },
        { "value": "London" }
      ]
   },
   {
     "dimensionValues": [
     { "value": "Japan" },
     { "value": "Osaka" }
     ]
   }]
 },
 {
   "dimensionHeaders": [{
     "dimensionValues": [{ "value": "session_start" }]
   },
   {
     "dimensionValues": [{ "value": "scroll" }]
   }]
 }]

repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.PivotHeaderOrBuilder>

getPropertyQuota()

public PropertyQuota getPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 7;

Returns
Type Description
PropertyQuota

The propertyQuota.

getPropertyQuotaOrBuilder()

public PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 7;

Returns
Type Description
PropertyQuotaOrBuilder

getRows(int index)

public Row getRows(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Parameter
Name Description
index int
Returns
Type Description
Row

getRowsCount()

public int getRowsCount()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Returns
Type Description
int

getRowsList()

public List<Row> getRowsList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Returns
Type Description
List<Row>

getRowsOrBuilder(int index)

public RowOrBuilder getRowsOrBuilder(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Parameter
Name Description
index int
Returns
Type Description
RowOrBuilder

getRowsOrBuilderList()

public List<? extends RowOrBuilder> getRowsOrBuilderList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 4;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMetadata()

public boolean hasMetadata()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 6;

Returns
Type Description
boolean

Whether the metadata field is set.

hasPropertyQuota()

public boolean hasPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 7;

Returns
Type Description
boolean

Whether the propertyQuota field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunPivotReportResponse.Builder newBuilderForType()
Returns
Type Description
RunPivotReportResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunPivotReportResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunPivotReportResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RunPivotReportResponse.Builder toBuilder()
Returns
Type Description
RunPivotReportResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException