Class: Google::Analytics::Admin::V1alpha::KeyEvent

Inherits:

Object

• Object
• Google::Analytics::Admin::V1alpha::KeyEvent

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/analytics/admin/v1alpha/resources.rb

Overview

A key event in a Google Analytics property.

Defined Under Namespace

Modules: CountingMethod Classes: DefaultValue

Instance Attribute Summary

• #counting_method ⇒ ::Google::Analytics::Admin::V1alpha::KeyEvent::CountingMethod

  Required.

• #create_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #custom ⇒ ::Boolean readonly

  Output only.

• #default_value ⇒ ::Google::Analytics::Admin::V1alpha::KeyEvent::DefaultValue

  Optional.

• #deletable ⇒ ::Boolean readonly

  Output only.

• #event_name ⇒ ::String

  Immutable.

• #name ⇒ ::String readonly

  Output only.

Instance Attribute Details

#counting_method ⇒ ::Google::Analytics::Admin::V1alpha::KeyEvent::CountingMethod

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1000

class KeyEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a default value/currency for a key event.
  # @!attribute [rw] numeric_value
  #   @return [::Float]
  #     Required. This will be used to populate the "value" parameter for all
  #     occurrences of this Key Event (specified by event_name) where that
  #     parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     Required. When an occurrence of this Key Event (specified by event_name)
  #     has no set currency this currency will be applied as the default. Must be
  #     in ISO 4217 currency code format.
  #
  #     See https://en.wikipedia.org/wiki/ISO_4217 for more information.
  class DefaultValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which Key Events will be counted across multiple events
  # within a session.
  module CountingMethod
    # Counting method not specified.
    COUNTING_METHOD_UNSPECIFIED = 0

    # Each Event instance is considered a Key Event.
    ONCE_PER_EVENT = 1

    # An Event instance is considered a Key Event at most once per session per
    # user.
    ONCE_PER_SESSION = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1000

class KeyEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a default value/currency for a key event.
  # @!attribute [rw] numeric_value
  #   @return [::Float]
  #     Required. This will be used to populate the "value" parameter for all
  #     occurrences of this Key Event (specified by event_name) where that
  #     parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     Required. When an occurrence of this Key Event (specified by event_name)
  #     has no set currency this currency will be applied as the default. Must be
  #     in ISO 4217 currency code format.
  #
  #     See https://en.wikipedia.org/wiki/ISO_4217 for more information.
  class DefaultValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which Key Events will be counted across multiple events
  # within a session.
  module CountingMethod
    # Counting method not specified.
    COUNTING_METHOD_UNSPECIFIED = 0

    # Each Event instance is considered a Key Event.
    ONCE_PER_EVENT = 1

    # An Event instance is considered a Key Event at most once per session per
    # user.
    ONCE_PER_SESSION = 2
  end
end

#custom ⇒ ::Boolean (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1000

class KeyEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a default value/currency for a key event.
  # @!attribute [rw] numeric_value
  #   @return [::Float]
  #     Required. This will be used to populate the "value" parameter for all
  #     occurrences of this Key Event (specified by event_name) where that
  #     parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     Required. When an occurrence of this Key Event (specified by event_name)
  #     has no set currency this currency will be applied as the default. Must be
  #     in ISO 4217 currency code format.
  #
  #     See https://en.wikipedia.org/wiki/ISO_4217 for more information.
  class DefaultValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which Key Events will be counted across multiple events
  # within a session.
  module CountingMethod
    # Counting method not specified.
    COUNTING_METHOD_UNSPECIFIED = 0

    # Each Event instance is considered a Key Event.
    ONCE_PER_EVENT = 1

    # An Event instance is considered a Key Event at most once per session per
    # user.
    ONCE_PER_SESSION = 2
  end
end

#default_value ⇒ ::Google::Analytics::Admin::V1alpha::KeyEvent::DefaultValue

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1000

class KeyEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a default value/currency for a key event.
  # @!attribute [rw] numeric_value
  #   @return [::Float]
  #     Required. This will be used to populate the "value" parameter for all
  #     occurrences of this Key Event (specified by event_name) where that
  #     parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     Required. When an occurrence of this Key Event (specified by event_name)
  #     has no set currency this currency will be applied as the default. Must be
  #     in ISO 4217 currency code format.
  #
  #     See https://en.wikipedia.org/wiki/ISO_4217 for more information.
  class DefaultValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which Key Events will be counted across multiple events
  # within a session.
  module CountingMethod
    # Counting method not specified.
    COUNTING_METHOD_UNSPECIFIED = 0

    # Each Event instance is considered a Key Event.
    ONCE_PER_EVENT = 1

    # An Event instance is considered a Key Event at most once per session per
    # user.
    ONCE_PER_SESSION = 2
  end
end

#deletable ⇒ ::Boolean (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1000

class KeyEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a default value/currency for a key event.
  # @!attribute [rw] numeric_value
  #   @return [::Float]
  #     Required. This will be used to populate the "value" parameter for all
  #     occurrences of this Key Event (specified by event_name) where that
  #     parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     Required. When an occurrence of this Key Event (specified by event_name)
  #     has no set currency this currency will be applied as the default. Must be
  #     in ISO 4217 currency code format.
  #
  #     See https://en.wikipedia.org/wiki/ISO_4217 for more information.
  class DefaultValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which Key Events will be counted across multiple events
  # within a session.
  module CountingMethod
    # Counting method not specified.
    COUNTING_METHOD_UNSPECIFIED = 0

    # Each Event instance is considered a Key Event.
    ONCE_PER_EVENT = 1

    # An Event instance is considered a Key Event at most once per session per
    # user.
    ONCE_PER_SESSION = 2
  end
end

#event_name ⇒ ::String

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1000

class KeyEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a default value/currency for a key event.
  # @!attribute [rw] numeric_value
  #   @return [::Float]
  #     Required. This will be used to populate the "value" parameter for all
  #     occurrences of this Key Event (specified by event_name) where that
  #     parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     Required. When an occurrence of this Key Event (specified by event_name)
  #     has no set currency this currency will be applied as the default. Must be
  #     in ISO 4217 currency code format.
  #
  #     See https://en.wikipedia.org/wiki/ISO_4217 for more information.
  class DefaultValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which Key Events will be counted across multiple events
  # within a session.
  module CountingMethod
    # Counting method not specified.
    COUNTING_METHOD_UNSPECIFIED = 0

    # Each Event instance is considered a Key Event.
    ONCE_PER_EVENT = 1

    # An Event instance is considered a Key Event at most once per session per
    # user.
    ONCE_PER_SESSION = 2
  end
end

#name ⇒ ::String (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1000

class KeyEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a default value/currency for a key event.
  # @!attribute [rw] numeric_value
  #   @return [::Float]
  #     Required. This will be used to populate the "value" parameter for all
  #     occurrences of this Key Event (specified by event_name) where that
  #     parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     Required. When an occurrence of this Key Event (specified by event_name)
  #     has no set currency this currency will be applied as the default. Must be
  #     in ISO 4217 currency code format.
  #
  #     See https://en.wikipedia.org/wiki/ISO_4217 for more information.
  class DefaultValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which Key Events will be counted across multiple events
  # within a session.
  module CountingMethod
    # Counting method not specified.
    COUNTING_METHOD_UNSPECIFIED = 0

    # Each Event instance is considered a Key Event.
    ONCE_PER_EVENT = 1

    # An Event instance is considered a Key Event at most once per session per
    # user.
    ONCE_PER_SESSION = 2
  end
end