Resource: ConversionEvent
A conversion event in a Google Analytics property.
JSON representation |
---|
{ "name": string, "eventName": string, "createTime": string, "deletable": boolean, "custom": boolean, "countingMethod": enum ( |
Fields | |
---|---|
name |
Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversionEvent} |
eventName |
Immutable. The event name for this conversion event. Examples: 'click', 'purchase' |
createTime |
Output only. Time when this conversion event was created in the property. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deletable |
Output only. If set, this event can currently be deleted with conversionEvents.delete. |
custom |
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. |
countingMethod |
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 |
defaultConversionValue |
Optional. Defines a default value/currency for a conversion event. |
ConversionCountingMethod
The method by which conversions will be counted across multiple events within a session.
Enums | |
---|---|
CONVERSION_COUNTING_METHOD_UNSPECIFIED |
Counting method not specified. |
ONCE_PER_EVENT |
Each Event instance is considered a Conversion. |
ONCE_PER_SESSION |
An Event instance is considered a Conversion at most once per session per user. |
DefaultConversionValue
Defines a default value/currency for a conversion event. Both value and currency must be provided.
JSON representation |
---|
{ "value": number, "currencyCode": string } |
Fields | |
---|---|
value |
This value will be used to populate the value for all conversions of the specified eventName where the event "value" parameter is unset. |
currencyCode |
When a conversion event for this eventName 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. |
Methods |
|
---|---|
(deprecated) |
Creates a conversion event with the specified attributes. |
(deprecated) |
Deletes a conversion event in a property. |
(deprecated) |
Retrieve a single conversion event. |
(deprecated) |
Returns a list of conversion events in the specified parent property. |
(deprecated) |
Updates a conversion event with the specified attributes. |