Package com.google.analytics.data.v1beta

Class Dimension

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1beta.Dimension
All Implemented Interfaces:
DimensionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Dimension extends com.google.protobuf.GeneratedMessage implements DimensionOrBuilder
 Dimensions are attributes of your data. For example, the dimension city
 indicates the city from which an event originates. Dimension values in report
 responses are strings; for example, the city could be "Paris" or "New York".
 Requests are allowed up to 9 dimensions.
Protobuf type google.analytics.data.v1beta.Dimension
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Dimension.Builder
    Dimensions are attributes of your data.

    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
    DIMENSION_EXPRESSION_FIELD_NUMBER
     
    static final int
    NAME_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 Dimension
    getDefaultInstance()
     
    Dimension
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DimensionExpression
    getDimensionExpression()
    One dimension can be the result of an expression of multiple dimensions.
    DimensionExpressionOrBuilder
    getDimensionExpressionOrBuilder()
    One dimension can be the result of an expression of multiple dimensions.
    String
    getName()
    The name of the dimension.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the dimension.
    com.google.protobuf.Parser<Dimension>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasDimensionExpression()
    One dimension can be the result of an expression of multiple dimensions.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Dimension.Builder
    newBuilder()
     
    static Dimension.Builder
    newBuilder(Dimension prototype)
     
    Dimension.Builder
    newBuilderForType()
     
    protected Dimension.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Dimension
    parseDelimitedFrom(InputStream input)
     
    static Dimension
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dimension
    parseFrom(byte[] data)
     
    static Dimension
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dimension
    parseFrom(com.google.protobuf.ByteString data)
     
    static Dimension
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dimension
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Dimension
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dimension
    parseFrom(InputStream input)
     
    static Dimension
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dimension
    parseFrom(ByteBuffer data)
     
    static Dimension
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Dimension>
    parser()
     
    Dimension.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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DIMENSION_EXPRESSION_FIELD_NUMBER

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

    • getName

      public String getName()
       The name of the dimension. See the [API
 Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
 for the list of dimension names supported by core reporting methods such
 as `runReport` and `batchRunReports`. See
 [Realtime
 Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
 for the list of dimension names supported by the `runRealtimeReport`
 method. See
 [Funnel
 Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
 for the list of dimension names supported by the `runFunnelReport`
 method.

 If `dimensionExpression` is specified, `name` can be any string that you
 would like within the allowed character set. For example if a
 `dimensionExpression` concatenates `country` and `city`, you could call
 that dimension `countryAndCity`. Dimension names that you choose must match
 the regular expression `^[a-zA-Z0-9_]$`.

 Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
 `dimensionExpression`, and `pivots`.
      string name = 1;
      Specified by:
      getName in interface DimensionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the dimension. See the [API
 Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
 for the list of dimension names supported by core reporting methods such
 as `runReport` and `batchRunReports`. See
 [Realtime
 Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
 for the list of dimension names supported by the `runRealtimeReport`
 method. See
 [Funnel
 Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
 for the list of dimension names supported by the `runFunnelReport`
 method.

 If `dimensionExpression` is specified, `name` can be any string that you
 would like within the allowed character set. For example if a
 `dimensionExpression` concatenates `country` and `city`, you could call
 that dimension `countryAndCity`. Dimension names that you choose must match
 the regular expression `^[a-zA-Z0-9_]$`.

 Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
 `dimensionExpression`, and `pivots`.
      string name = 1;
      Specified by:
      getNameBytes in interface DimensionOrBuilder
      Returns:
      The bytes for name.

    • hasDimensionExpression

      public boolean hasDimensionExpression()
       One dimension can be the result of an expression of multiple dimensions.
 For example, dimension "country, city": concatenate(country, ", ", city).
      .google.analytics.data.v1beta.DimensionExpression dimension_expression = 2;
      Specified by:
      hasDimensionExpression in interface DimensionOrBuilder
      Returns:
      Whether the dimensionExpression field is set.

    • getDimensionExpression

      public DimensionExpression getDimensionExpression()
       One dimension can be the result of an expression of multiple dimensions.
 For example, dimension "country, city": concatenate(country, ", ", city).
      .google.analytics.data.v1beta.DimensionExpression dimension_expression = 2;
      Specified by:
      getDimensionExpression in interface DimensionOrBuilder
      Returns:
      The dimensionExpression.

    • getDimensionExpressionOrBuilder

      public DimensionExpressionOrBuilder getDimensionExpressionOrBuilder()
       One dimension can be the result of an expression of multiple dimensions.
 For example, dimension "country, city": concatenate(country, ", ", city).
      .google.analytics.data.v1beta.DimensionExpression dimension_expression = 2;
      Specified by:
      getDimensionExpressionOrBuilder in interface DimensionOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Dimension.Builder newBuilder()

    • newBuilder

      public static Dimension.Builder newBuilder(Dimension prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Dimension getDefaultInstance()

    • parser

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

    • getParserForType

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