Google Analytics Data V1beta API - Class Google::Analytics::Data::V1beta::DimensionMetadata (v0.4.3)

Reference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::DimensionMetadata.

Explains a dimension.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_name

defapi_name()->::String
Returns
  • (::String) — This dimension's name. Useable in Dimension's name. For example, eventName.

#api_name=

defapi_name=(value)->::String
Parameter
  • value (::String) — This dimension's name. Useable in Dimension's name. For example, eventName.
Returns
  • (::String) — This dimension's name. Useable in Dimension's name. For example, eventName.

#category

defcategory()->::String
Returns
  • (::String) — The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

#category=

defcategory=(value)->::String
Parameter
  • value (::String) — The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
Returns
  • (::String) — The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

#custom_definition

defcustom_definition()->::Boolean
Returns
  • (::Boolean) — True if the dimension is a custom dimension for this property.

#custom_definition=

defcustom_definition=(value)->::Boolean
Parameter
  • value (::Boolean) — True if the dimension is a custom dimension for this property.
Returns
  • (::Boolean) — True if the dimension is a custom dimension for this property.

#deprecated_api_names

defdeprecated_api_names()->::Array<::String>
Returns
  • (::Array<::String>) — 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.

#deprecated_api_names=

defdeprecated_api_names=(value)->::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.

#description

defdescription()->::String
Returns
  • (::String) — Description of how this dimension is used and calculated.

#description=

defdescription=(value)->::String
Parameter
  • value (::String) — Description of how this dimension is used and calculated.
Returns
  • (::String) — Description of how this dimension is used and calculated.

#ui_name

defui_name()->::String
Returns
  • (::String) — This dimension's name within the Google Analytics user interface. For example, Event name.

#ui_name=

defui_name=(value)->::String
Parameter
  • value (::String) — This dimension's name within the Google Analytics user interface. For example, Event name.
Returns
  • (::String) — This dimension's name within the Google Analytics user interface. For example, Event name.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.