Reference documentation and code samples for the Google Analytics Admin V1beta Client class ConversionEvent.
A conversion event in a Google Analytics property.
Generated from protobuf message google.analytics.admin.v1beta.ConversionEvent
Namespace
Google \ Analytics \ Admin \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
↳ event_name
string
Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
↳ create_time
↳ deletable
bool
Output only. If set, this event can currently be deleted with DeleteConversionEvent.
↳ custom
bool
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.
↳ counting_method
int
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
.
↳ default_conversion_value
ConversionEvent\DefaultConversionValue
Optional. Defines a default value/currency for a conversion event.
getName
Output only. Resource name of this conversion event.
Format: properties/{property}/conversionEvents/{conversion_event}
string
setName
Output only. Resource name of this conversion event.
Format: properties/{property}/conversionEvents/{conversion_event}
var
string
$this
getEventName
Immutable. The event name for this conversion event.
Examples: 'click', 'purchase'
string
setEventName
Immutable. The event name for this conversion event.
Examples: 'click', 'purchase'
var
string
$this
getCreateTime
Output only. Time when this conversion event was created in the property.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when this conversion event was created in the property.
$this
getDeletable
Output only. If set, this event can currently be deleted with DeleteConversionEvent.
bool
setDeletable
Output only. If set, this event can currently be deleted with DeleteConversionEvent.
var
bool
$this
getCustom
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.
bool
setCustom
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.
var
bool
$this
getCountingMethod
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
.
int
setCountingMethod
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
.
var
int
$this
getDefaultConversionValue
Optional. Defines a default value/currency for a conversion event.
hasDefaultConversionValue
clearDefaultConversionValue
setDefaultConversionValue
Optional. Defines a default value/currency for a conversion event.
$this
