Package com.google.analytics.data.v1beta

Class RunPivotReportResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1beta.RunPivotReportResponse
All Implemented Interfaces:
RunPivotReportResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RunPivotReportResponse extends com.google.protobuf.GeneratedMessage implements RunPivotReportResponseOrBuilder
 The response pivot report table corresponding to a pivot request.
Protobuf type google.analytics.data.v1beta.RunPivotReportResponse
See Also:

  • Field Details

    • PIVOT_HEADERS_FIELD_NUMBER

      public static final int PIVOT_HEADERS_FIELD_NUMBER
      See Also:

    • DIMENSION_HEADERS_FIELD_NUMBER

      public static final int DIMENSION_HEADERS_FIELD_NUMBER
      See Also:

    • METRIC_HEADERS_FIELD_NUMBER

      public static final int METRIC_HEADERS_FIELD_NUMBER
      See Also:

    • ROWS_FIELD_NUMBER

      public static final int ROWS_FIELD_NUMBER
      See Also:

    • AGGREGATES_FIELD_NUMBER

      public static final int AGGREGATES_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • PROPERTY_QUOTA_FIELD_NUMBER

      public static final int PROPERTY_QUOTA_FIELD_NUMBER
      See Also:

    • KIND_FIELD_NUMBER

      public static final int KIND_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getPivotHeadersList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getPivotHeadersOrBuilderList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getPivotHeadersCount in interface RunPivotReportResponseOrBuilder

    • getPivotHeaders

      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;
      Specified by:
      getPivotHeaders in interface RunPivotReportResponseOrBuilder

    • getPivotHeadersOrBuilder

      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;
      Specified by:
      getPivotHeadersOrBuilder in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getDimensionHeadersList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getDimensionHeadersOrBuilderList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getDimensionHeadersCount in interface RunPivotReportResponseOrBuilder

    • getDimensionHeaders

      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;
      Specified by:
      getDimensionHeaders in interface RunPivotReportResponseOrBuilder

    • getDimensionHeadersOrBuilder

      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;
      Specified by:
      getDimensionHeadersOrBuilder in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getMetricHeadersList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getMetricHeadersOrBuilderList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getMetricHeadersCount in interface RunPivotReportResponseOrBuilder

    • getMetricHeaders

      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;
      Specified by:
      getMetricHeaders in interface RunPivotReportResponseOrBuilder

    • getMetricHeadersOrBuilder

      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;
      Specified by:
      getMetricHeadersOrBuilder in interface RunPivotReportResponseOrBuilder

    • getRowsList

      public List<Row> getRowsList()
       Rows of dimension value combinations and metric values in the report.
      repeated .google.analytics.data.v1beta.Row rows = 4;
      Specified by:
      getRowsList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getRowsOrBuilderList in interface RunPivotReportResponseOrBuilder

    • getRowsCount

      public int getRowsCount()
       Rows of dimension value combinations and metric values in the report.
      repeated .google.analytics.data.v1beta.Row rows = 4;
      Specified by:
      getRowsCount in interface RunPivotReportResponseOrBuilder

    • getRows

      public Row getRows(int index)
       Rows of dimension value combinations and metric values in the report.
      repeated .google.analytics.data.v1beta.Row rows = 4;
      Specified by:
      getRows in interface RunPivotReportResponseOrBuilder

    • getRowsOrBuilder

      public RowOrBuilder getRowsOrBuilder(int index)
       Rows of dimension value combinations and metric values in the report.
      repeated .google.analytics.data.v1beta.Row rows = 4;
      Specified by:
      getRowsOrBuilder in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getAggregatesList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getAggregatesOrBuilderList in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getAggregatesCount in interface RunPivotReportResponseOrBuilder

    • getAggregates

      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;
      Specified by:
      getAggregates in interface RunPivotReportResponseOrBuilder

    • getAggregatesOrBuilder

      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;
      Specified by:
      getAggregatesOrBuilder in interface RunPivotReportResponseOrBuilder

    • hasMetadata

      public boolean hasMetadata()
       Metadata for the report.
      .google.analytics.data.v1beta.ResponseMetaData metadata = 6;
      Specified by:
      hasMetadata in interface RunPivotReportResponseOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public ResponseMetaData getMetadata()
       Metadata for the report.
      .google.analytics.data.v1beta.ResponseMetaData metadata = 6;
      Specified by:
      getMetadata in interface RunPivotReportResponseOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      public ResponseMetaDataOrBuilder getMetadataOrBuilder()
       Metadata for the report.
      .google.analytics.data.v1beta.ResponseMetaData metadata = 6;
      Specified by:
      getMetadataOrBuilder in interface RunPivotReportResponseOrBuilder

    • hasPropertyQuota

      public boolean hasPropertyQuota()
       This Google Analytics property's quota state including this request.
      .google.analytics.data.v1beta.PropertyQuota property_quota = 7;
      Specified by:
      hasPropertyQuota in interface RunPivotReportResponseOrBuilder
      Returns:
      Whether the propertyQuota field is set.

    • getPropertyQuota

      public PropertyQuota getPropertyQuota()
       This Google Analytics property's quota state including this request.
      .google.analytics.data.v1beta.PropertyQuota property_quota = 7;
      Specified by:
      getPropertyQuota in interface RunPivotReportResponseOrBuilder
      Returns:
      The propertyQuota.

    • getPropertyQuotaOrBuilder

      public PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()
       This Google Analytics property's quota state including this request.
      .google.analytics.data.v1beta.PropertyQuota property_quota = 7;
      Specified by:
      getPropertyQuotaOrBuilder in interface RunPivotReportResponseOrBuilder

    • 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;
      Specified by:
      getKind in interface RunPivotReportResponseOrBuilder
      Returns:
      The kind.

    • getKindBytes

      public com.google.protobuf.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;
      Specified by:
      getKindBytes in interface RunPivotReportResponseOrBuilder
      Returns:
      The bytes for kind.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 RunPivotReportResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static RunPivotReportResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static RunPivotReportResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static RunPivotReportResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RunPivotReportResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static RunPivotReportResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public RunPivotReportResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RunPivotReportResponse.Builder newBuilder()

    • newBuilder

      public static RunPivotReportResponse.Builder newBuilder(RunPivotReportResponse prototype)

    • toBuilder

      public RunPivotReportResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RunPivotReportResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RunPivotReportResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RunPivotReportResponse> 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.GeneratedMessage

    • getDefaultInstanceForType

      public RunPivotReportResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder