Package com.google.analytics.data.v1alpha

Interface DimensionOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    hasDimensionExpression()
    One dimension can be the result of an expression of multiple dimensions.

    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

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

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

    • hasDimensionExpression

      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.v1alpha.DimensionExpression dimension_expression = 2;
      Returns:
      Whether the dimensionExpression field is set.

    • getDimensionExpression

      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.v1alpha.DimensionExpression dimension_expression = 2;
      Returns:
      The dimensionExpression.

    • getDimensionExpressionOrBuilder

      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.v1alpha.DimensionExpression dimension_expression = 2;