class Google::Apis::AnalyticsdataV1beta::DimensionMetadata

Explains a dimension.

Attributes

api_name[RW]

This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`. Corresponds to the JSON property `apiName` @return [String]

category[RW]

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together. Corresponds to the JSON property `category` @return [String]

custom_definition[RW]

True if the dimension is a custom dimension for this property. Corresponds to the JSON property `customDefinition` @return [Boolean]

custom_definition?[RW]

True if the dimension is a custom dimension for this property. Corresponds to the JSON property `customDefinition` @return [Boolean]

deprecated_api_names[RW]

Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`. Corresponds to the JSON property `deprecatedApiNames` @return [Array<String>]

description[RW]

Description of how this dimension is used and calculated. Corresponds to the JSON property `description` @return [String]

ui_name[RW]

This dimension's name within the Google Analytics user interface. For example, `Event name`. Corresponds to the JSON property `uiName` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/analyticsdata_v1beta/classes.rb, line 623
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/analyticsdata_v1beta/classes.rb, line 628
def update!(**args)
  @api_name = args[:api_name] if args.key?(:api_name)
  @category = args[:category] if args.key?(:category)
  @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
  @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
  @description = args[:description] if args.key?(:description)
  @ui_name = args[:ui_name] if args.key?(:ui_name)
end