Package com.google.analytics.data.v1beta

Class Pivot

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1beta.Pivot
All Implemented Interfaces:
PivotOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Pivot extends com.google.protobuf.GeneratedMessage implements PivotOrBuilder
 Describes the visible dimension columns and rows in the report response.
Protobuf type google.analytics.data.v1beta.Pivot
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Pivot.Builder
    Describes the visible dimension columns and rows in the report response.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FIELD_NAMES_FIELD_NUMBER
     
    static final int
    LIMIT_FIELD_NUMBER
     
    static final int
    METRIC_AGGREGATIONS_FIELD_NUMBER
     
    static final int
    OFFSET_FIELD_NUMBER
     
    static final int
    ORDER_BYS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Pivot
    getDefaultInstance()
     
    Pivot
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.ProtocolStringList
    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.
    com.google.protobuf.Parser<Pivot>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Pivot.Builder
    newBuilder()
     
    static Pivot.Builder
    newBuilder(Pivot prototype)
     
    Pivot.Builder
    newBuilderForType()
     
    protected Pivot.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Pivot
    parseDelimitedFrom(InputStream input)
     
    static Pivot
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pivot
    parseFrom(byte[] data)
     
    static Pivot
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pivot
    parseFrom(com.google.protobuf.ByteString data)
     
    static Pivot
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pivot
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Pivot
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pivot
    parseFrom(InputStream input)
     
    static Pivot
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pivot
    parseFrom(ByteBuffer data)
     
    static Pivot
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Pivot>
    parser()
     
    Pivot.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • FIELD_NAMES_FIELD_NUMBER

      public static final int FIELD_NAMES_FIELD_NUMBER
      See Also:

    • ORDER_BYS_FIELD_NUMBER

      public static final int ORDER_BYS_FIELD_NUMBER
      See Also:

    • OFFSET_FIELD_NUMBER

      public static final int OFFSET_FIELD_NUMBER
      See Also:

    • LIMIT_FIELD_NUMBER

      public static final int LIMIT_FIELD_NUMBER
      See Also:

    • METRIC_AGGREGATIONS_FIELD_NUMBER

      public static final int METRIC_AGGREGATIONS_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

    • getFieldNamesList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getFieldNamesList in interface PivotOrBuilder
      Returns:
      A list containing the fieldNames.

    • getFieldNamesCount

      public 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;
      Specified by:
      getFieldNamesCount in interface PivotOrBuilder
      Returns:
      The count of fieldNames.

    • getFieldNames

      public 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;
      Specified by:
      getFieldNames in interface PivotOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The fieldNames at the given index.

    • getFieldNamesBytes

      public 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;
      Specified by:
      getFieldNamesBytes in interface PivotOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the fieldNames at the given index.

    • getOrderBysList

      public 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;
      Specified by:
      getOrderBysList in interface PivotOrBuilder

    • getOrderBysOrBuilderList

      public 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;
      Specified by:
      getOrderBysOrBuilderList in interface PivotOrBuilder

    • getOrderBysCount

      public 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;
      Specified by:
      getOrderBysCount in interface PivotOrBuilder

    • getOrderBys

      public 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;
      Specified by:
      getOrderBys in interface PivotOrBuilder

    • getOrderBysOrBuilder

      public 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;
      Specified by:
      getOrderBysOrBuilder in interface PivotOrBuilder

    • getOffset

      public long getOffset()
       The row count of the start row. The first row is counted as row 0.
      int64 offset = 3;
      Specified by:
      getOffset in interface PivotOrBuilder
      Returns:
      The offset.

    • getLimit

      public 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;
      Specified by:
      getLimit in interface PivotOrBuilder
      Returns:
      The limit.

    • getMetricAggregationsList

      public 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;
      Specified by:
      getMetricAggregationsList in interface PivotOrBuilder
      Returns:
      A list containing the metricAggregations.

    • getMetricAggregationsCount

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

    • getMetricAggregations

      public 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;
      Specified by:
      getMetricAggregations in interface PivotOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The metricAggregations at the given index.

    • getMetricAggregationsValueList

      public 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;
      Specified by:
      getMetricAggregationsValueList in interface PivotOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for metricAggregations.

    • getMetricAggregationsValue

      public 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;
      Specified by:
      getMetricAggregationsValue in interface PivotOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of metricAggregations at the given index.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Pivot.Builder newBuilder()

    • newBuilder

      public static Pivot.Builder newBuilder(Pivot prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Pivot getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Pivot> 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 Pivot getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder