Package com.google.analytics.data.v1beta

Interface PivotOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFieldNames(int index)
    Dimension names for visible columns in the report response.
    com.google.protobuf.ByteString
    getFieldNamesBytes(int index)
    Dimension names for visible columns in the report response.
    int
    getFieldNamesCount()
    Dimension names for visible columns in the report response.
    List<String>
    getFieldNamesList()
    Dimension names for visible columns in the report response.
    long
    getLimit()
    The number of unique combinations of dimension values to return in this pivot.
    MetricAggregation
    getMetricAggregations(int index)
    Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
    int
    getMetricAggregationsCount()
    Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
    List<MetricAggregation>
    getMetricAggregationsList()
    Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
    int
    getMetricAggregationsValue(int index)
    Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
    List<Integer>
    getMetricAggregationsValueList()
    Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
    long
    getOffset()
    The row count of the start row.
    OrderBy
    getOrderBys(int index)
    Specifies how dimensions are ordered in the pivot.
    int
    getOrderBysCount()
    Specifies how dimensions are ordered in the pivot.
    List<OrderBy>
    getOrderBysList()
    Specifies how dimensions are ordered in the pivot.
    OrderByOrBuilder
    getOrderBysOrBuilder(int index)
    Specifies how dimensions are ordered in the pivot.
    List<? extends OrderByOrBuilder>
    getOrderBysOrBuilderList()
    Specifies how dimensions are ordered in the pivot.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getFieldNamesList

      List<String> getFieldNamesList()
       Dimension names for visible columns in the report response. Including
 "dateRange" produces a date range column; for each row in the response,
 dimension values in the date range column will indicate the corresponding
 date range from the request.
      repeated string field_names = 1;
      Returns:
      A list containing the fieldNames.

    • getFieldNamesCount

      int getFieldNamesCount()
       Dimension names for visible columns in the report response. Including
 "dateRange" produces a date range column; for each row in the response,
 dimension values in the date range column will indicate the corresponding
 date range from the request.
      repeated string field_names = 1;
      Returns:
      The count of fieldNames.

    • getFieldNames

      String getFieldNames(int index)
       Dimension names for visible columns in the report response. Including
 "dateRange" produces a date range column; for each row in the response,
 dimension values in the date range column will indicate the corresponding
 date range from the request.
      repeated string field_names = 1;
      Parameters:
      index - The index of the element to return.
      Returns:
      The fieldNames at the given index.

    • getFieldNamesBytes

      com.google.protobuf.ByteString getFieldNamesBytes(int index)
       Dimension names for visible columns in the report response. Including
 "dateRange" produces a date range column; for each row in the response,
 dimension values in the date range column will indicate the corresponding
 date range from the request.
      repeated string field_names = 1;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the fieldNames at the given index.

    • getOrderBysList

      List<OrderBy> getOrderBysList()
       Specifies how dimensions are ordered in the pivot. In the first Pivot, the
 OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
 Pivots, the OrderBys determine only PivotDimensionHeader ordering.
 Dimensions specified in these OrderBys must be a subset of
 Pivot.field_names.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

    • getOrderBys

      OrderBy getOrderBys(int index)
       Specifies how dimensions are ordered in the pivot. In the first Pivot, the
 OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
 Pivots, the OrderBys determine only PivotDimensionHeader ordering.
 Dimensions specified in these OrderBys must be a subset of
 Pivot.field_names.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

    • getOrderBysCount

      int getOrderBysCount()
       Specifies how dimensions are ordered in the pivot. In the first Pivot, the
 OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
 Pivots, the OrderBys determine only PivotDimensionHeader ordering.
 Dimensions specified in these OrderBys must be a subset of
 Pivot.field_names.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

    • getOrderBysOrBuilderList

      List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()
       Specifies how dimensions are ordered in the pivot. In the first Pivot, the
 OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
 Pivots, the OrderBys determine only PivotDimensionHeader ordering.
 Dimensions specified in these OrderBys must be a subset of
 Pivot.field_names.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

    • getOrderBysOrBuilder

      OrderByOrBuilder getOrderBysOrBuilder(int index)
       Specifies how dimensions are ordered in the pivot. In the first Pivot, the
 OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
 Pivots, the OrderBys determine only PivotDimensionHeader ordering.
 Dimensions specified in these OrderBys must be a subset of
 Pivot.field_names.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

    • getOffset

      long getOffset()
       The row count of the start row. The first row is counted as row 0.
      int64 offset = 3;
      Returns:
      The offset.

    • getLimit

      long getLimit()
       The number of unique combinations of dimension values to return in this
 pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
 single pivot requests.

 The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
 must not exceed 250,000. For example, a two pivot request with `limit:
 1000` in each pivot will fail because the product is `1,000,000`.
      int64 limit = 4;
      Returns:
      The limit.

    • getMetricAggregationsList

      List<MetricAggregation> getMetricAggregationsList()
       Aggregate the metrics by dimensions in this pivot using the specified
 metric_aggregations.
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
      Returns:
      A list containing the metricAggregations.

    • getMetricAggregationsCount

      int getMetricAggregationsCount()
       Aggregate the metrics by dimensions in this pivot using the specified
 metric_aggregations.
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
      Returns:
      The count of metricAggregations.

    • getMetricAggregations

      MetricAggregation getMetricAggregations(int index)
       Aggregate the metrics by dimensions in this pivot using the specified
 metric_aggregations.
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The metricAggregations at the given index.

    • getMetricAggregationsValueList

      List<Integer> getMetricAggregationsValueList()
       Aggregate the metrics by dimensions in this pivot using the specified
 metric_aggregations.
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
      Returns:
      A list containing the enum numeric values on the wire for metricAggregations.

    • getMetricAggregationsValue

      int getMetricAggregationsValue(int index)
       Aggregate the metrics by dimensions in this pivot using the specified
 metric_aggregations.
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of metricAggregations at the given index.