Google Analytics Admin V1alpha Client - Class ConversionEvent (0.20.0)

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 \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
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 ONCE_PER_EVENT.

↳ 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
TypeDescription
string

setName

Output only. Resource name of this conversion event.

Format: properties/{property}/conversionEvents/{conversion_event}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEventName

Immutable. The event name for this conversion event.

Examples: 'click', 'purchase'

Returns
TypeDescription
string

setEventName

Immutable. The event name for this conversion event.

Examples: 'click', 'purchase'

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDeletable

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

Returns
TypeDescription
bool

setDeletable

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getDefaultConversionValue

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

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\ConversionEvent\DefaultConversionValue|null

hasDefaultConversionValue

clearDefaultConversionValue

setDefaultConversionValue

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

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\ConversionEvent\DefaultConversionValue
Returns
TypeDescription
$this