Reference documentation and code samples for the Google Analytics Admin V1alpha Client class KeyEvent.
A key event in a Google Analytics property.
Generated from protobuf message google.analytics.admin.v1alpha.KeyEvent
Namespace
Google \ Analytics \ Admin \ V1alphaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
↳ event_name
string
Immutable. The event name for this key event. Examples: 'click', 'purchase'
↳ create_time
↳ deletable
bool
Output only. If set to true, this event can be deleted.
↳ custom
bool
Output only. If set to true, this key event refers to a custom event. If set to false, this key 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 key events that may be created per property.
↳ counting_method
int
Required. The method by which Key Events will be counted across multiple events within a session.
↳ default_value
getName
Output only. Resource name of this key event.
Format: properties/{property}/keyEvents/{key_event}
string
setName
Output only. Resource name of this key event.
Format: properties/{property}/keyEvents/{key_event}
var
string
$this
getEventName
Immutable. The event name for this key event.
Examples: 'click', 'purchase'
string
setEventName
Immutable. The event name for this key event.
Examples: 'click', 'purchase'
var
string
$this
getCreateTime
Output only. Time when this key event was created in the property.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when this key event was created in the property.
$this
getDeletable
Output only. If set to true, this event can be deleted.
bool
setDeletable
Output only. If set to true, this event can be deleted.
var
bool
$this
getCustom
Output only. If set to true, this key event refers to a custom event. If set to false, this key 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 key events that may be created per property.
bool
setCustom
Output only. If set to true, this key event refers to a custom event. If set to false, this key 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 key events that may be created per property.
var
bool
$this
getCountingMethod
Required. The method by which Key Events will be counted across multiple events within a session.
int
setCountingMethod
Required. The method by which Key Events will be counted across multiple events within a session.
var
int
$this
getDefaultValue
Optional. Defines a default value/currency for a key event.
hasDefaultValue
clearDefaultValue
setDefaultValue
Optional. Defines a default value/currency for a key event.
$this
