v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13286594.5 KB
properties

Creates a Key Event.

post/v1beta/{+parent}/keyEvents

Path parameters

parentstring required

Required. The resource name of the parent property where this Key Event will be created. Format: properties/123

Request body

eventNamestring

Immutable. The event name for this key event. Examples: 'click', 'purchase'

countingMethod'COUNTING_METHOD_UNSPECIFIED' | 'ONCE_PER_EVENT' | 'ONCE_PER_SESSION'

Required. The method by which Key Events will be counted across multiple events within a session.

namestring

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

createTimestring google-datetime

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

deletableboolean

Output only. If set to true, this event can be deleted.

customboolean

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.

Response

Successful response