Class: Google::Analytics::Admin::V1alpha::ConversionEvent

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 conversion event in a Google Analytics property.

Defined Under Namespace

Modules: ConversionCountingMethod Classes: DefaultConversionValue

Instance Attribute Summary collapse

Instance Attribute Details

#counting_method ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent::ConversionCountingMethod

Returns Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to ONCE_PER_EVENT.

Returns:



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 832

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

  # Defines a default value/currency for a conversion event. Both value and
  # currency must be provided.
  # @!attribute [rw] value
  #   @return [::Float]
  #     This value will be used to populate the value for all conversions
  #     of the specified event_name where the event "value" parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     When a conversion event for this 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 DefaultConversionValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which conversions will be counted across multiple events
  # within a session.
  module ConversionCountingMethod
    # Counting method not specified.
    CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0

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

    # An Event instance is considered a Conversion 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 conversion event was created in the property.

Returns:



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 832

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

  # Defines a default value/currency for a conversion event. Both value and
  # currency must be provided.
  # @!attribute [rw] value
  #   @return [::Float]
  #     This value will be used to populate the value for all conversions
  #     of the specified event_name where the event "value" parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     When a conversion event for this 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 DefaultConversionValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which conversions will be counted across multiple events
  # within a session.
  module ConversionCountingMethod
    # Counting method not specified.
    CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0

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

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

#custom ⇒ ::Boolean (readonly)

Returns Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property.

Returns:

  • (::Boolean) —

    Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property.



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 832

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

  # Defines a default value/currency for a conversion event. Both value and
  # currency must be provided.
  # @!attribute [rw] value
  #   @return [::Float]
  #     This value will be used to populate the value for all conversions
  #     of the specified event_name where the event "value" parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     When a conversion event for this 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 DefaultConversionValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which conversions will be counted across multiple events
  # within a session.
  module ConversionCountingMethod
    # Counting method not specified.
    CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0

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

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

#default_conversion_value ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent::DefaultConversionValue

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

Returns:



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 832

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

  # Defines a default value/currency for a conversion event. Both value and
  # currency must be provided.
  # @!attribute [rw] value
  #   @return [::Float]
  #     This value will be used to populate the value for all conversions
  #     of the specified event_name where the event "value" parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     When a conversion event for this 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 DefaultConversionValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which conversions will be counted across multiple events
  # within a session.
  module ConversionCountingMethod
    # Counting method not specified.
    CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0

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

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

#deletable ⇒ ::Boolean (readonly)

Returns Output only. If set, this event can currently be deleted with DeleteConversionEvent.

Returns:

  • (::Boolean) —

    Output only. If set, this event can currently be deleted with DeleteConversionEvent.



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 832

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

  # Defines a default value/currency for a conversion event. Both value and
  # currency must be provided.
  # @!attribute [rw] value
  #   @return [::Float]
  #     This value will be used to populate the value for all conversions
  #     of the specified event_name where the event "value" parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     When a conversion event for this 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 DefaultConversionValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which conversions will be counted across multiple events
  # within a session.
  module ConversionCountingMethod
    # Counting method not specified.
    CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0

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

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

#event_name ⇒ ::String

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

Returns:

  • (::String) —

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



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 832

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

  # Defines a default value/currency for a conversion event. Both value and
  # currency must be provided.
  # @!attribute [rw] value
  #   @return [::Float]
  #     This value will be used to populate the value for all conversions
  #     of the specified event_name where the event "value" parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     When a conversion event for this 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 DefaultConversionValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which conversions will be counted across multiple events
  # within a session.
  module ConversionCountingMethod
    # Counting method not specified.
    CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0

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

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

#name ⇒ ::String (readonly)

Returns Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}.

Returns:

  • (::String) —

    Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 832

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

  # Defines a default value/currency for a conversion event. Both value and
  # currency must be provided.
  # @!attribute [rw] value
  #   @return [::Float]
  #     This value will be used to populate the value for all conversions
  #     of the specified event_name where the event "value" parameter is unset.
  # @!attribute [rw] currency_code
  #   @return [::String]
  #     When a conversion event for this 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 DefaultConversionValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The method by which conversions will be counted across multiple events
  # within a session.
  module ConversionCountingMethod
    # Counting method not specified.
    CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0

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

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