Package com.google.analytics.data.v1beta

Interface RunPivotReportResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RunPivotReportResponse, RunPivotReportResponse.Builder
@Generated public interface RunPivotReportResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getPivotHeadersList

      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;

    • getPivotHeaders

      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;

    • getPivotHeadersCount

      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;

    • getPivotHeadersOrBuilderList

      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;

    • getPivotHeadersOrBuilder

      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;

    • getDimensionHeadersList

      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;

    • getDimensionHeaders

      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;

    • getDimensionHeadersCount

      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;

    • getDimensionHeadersOrBuilderList

      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;

    • getDimensionHeadersOrBuilder

      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;

    • getMetricHeadersList

      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;

    • getMetricHeaders

      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;

    • getMetricHeadersCount

      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;

    • getMetricHeadersOrBuilderList

      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;

    • getMetricHeadersOrBuilder

      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;

    • getRowsList

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

    • getRows

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

    • getRowsCount

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

    • getRowsOrBuilderList

      List<? extends RowOrBuilder> getRowsOrBuilderList()
       Rows of dimension value combinations and metric values in the report.
      repeated .google.analytics.data.v1beta.Row rows = 4;

    • getRowsOrBuilder

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

    • getAggregatesList

      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;

    • getAggregates

      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;

    • getAggregatesCount

      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;

    • getAggregatesOrBuilderList

      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;

    • getAggregatesOrBuilder

      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;

    • hasMetadata

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

    • getMetadata

      ResponseMetaData getMetadata()
       Metadata for the report.
      .google.analytics.data.v1beta.ResponseMetaData metadata = 6;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      ResponseMetaDataOrBuilder getMetadataOrBuilder()
       Metadata for the report.
      .google.analytics.data.v1beta.ResponseMetaData metadata = 6;

    • hasPropertyQuota

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

    • getPropertyQuota

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

    • getPropertyQuotaOrBuilder

      PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()
       This Google Analytics property's quota state including this request.
      .google.analytics.data.v1beta.PropertyQuota property_quota = 7;

    • getKind

      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:
      The kind.

    • getKindBytes

      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;
      Returns:
      The bytes for kind.