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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

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

Returns Required. The method by which Key Events will be counted across multiple events within a session.

Returns:



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 965

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)

Returns Output only. Time when this key event was created in the property.

Returns:



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 965

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)

Returns Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.

Returns:

  • (::Boolean) —

    Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 965

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

Returns Optional. Defines a default value/currency for a key event.

Returns:



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 965

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)

Returns Output only. If set to true, this event can be deleted.

Returns:

  • (::Boolean) —

    Output only. If set to true, this event can be deleted.



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 965

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

Returns Immutable. The event name for this key event. Examples: 'click', 'purchase'.

Returns:

  • (::String) —

    Immutable. The event name for this key event. Examples: 'click', 'purchase'



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 965

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)

Returns Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}.

Returns:

  • (::String) —

    Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 965

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