Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ConversionEvent.
A conversion event in a Google Analytics property.
Generated from protobuf message google.analytics.admin.v1alpha.ConversionEvent
Namespace
Google \ Analytics \ Admin \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
Google\Protobuf\Timestamp
Output only. Time when this conversion event was created in the property. |
↳ 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 |
↳ default_conversion_value |
Google\Analytics\Admin\V1alpha\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}
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of this conversion event.
Format: properties/{property}/conversionEvents/{conversion_event}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEventName
Immutable. The event name for this conversion event.
Examples: 'click', 'purchase'
| Returns | |
|---|---|
| Type | Description |
string | |
setEventName
Immutable. The event name for this conversion event.
Examples: 'click', 'purchase'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when this conversion event was created in the property.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when this conversion event was created in the property.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeletable
Output only. If set, this event can currently be deleted with DeleteConversionEvent.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDeletable
Output only. If set, this event can currently be deleted with DeleteConversionEvent.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDefaultConversionValue
Optional. Defines a default value/currency for a conversion event.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Admin\V1alpha\ConversionEvent\DefaultConversionValue|null | |
hasDefaultConversionValue
clearDefaultConversionValue
setDefaultConversionValue
Optional. Defines a default value/currency for a conversion event.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Admin\V1alpha\ConversionEvent\DefaultConversionValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |