Class: Google::Analytics::Data::V1beta::DimensionMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1beta/data.rb

Overview

Explains a dimension.

Instance Attribute Summary collapse

Instance Attribute Details

#api_name ⇒ ::String

Returns 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.



986
987
988
989
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 986

class DimensionMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#category ⇒ ::String

Returns 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.



986
987
988
989
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 986

class DimensionMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_definition ⇒ ::Boolean

Returns True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.

Returns:



986
987
988
989
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 986

class DimensionMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#deprecated_api_names ⇒ ::Array<::String>

Returns 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.



986
987
988
989
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 986

class DimensionMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns Description of how this dimension is used and calculated.

Returns:

  • (::String) —

    Description of how this dimension is used and calculated.



986
987
988
989
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 986

class DimensionMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ui_name ⇒ ::String

Returns 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.



986
987
988
989
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 986

class DimensionMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end