2024-04-04
▼ ▲ analyticsadmin.properties.keyEvents.create
Flat Path : v1alpha/properties/{propertiesId}/keyEvents
Parameters :
parent
Pattern : ^properties/[^/]+$
Type : string
Description : Required. The resource name of the parent property where this Key Event will be created. Format: properties/123
Location : path
Required : Yes
Description : Creates a Key Event.
Scopes : https://www.googleapis.com/auth/analytics.edit
Path : v1alpha/{+parent}/keyEvents
Parameter Order : parent
HTTP Method : POST
▼ ▲ analyticsadmin.properties.keyEvents.patch
Parameters :
updateMask
Description : Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Type : string
Format : google-fieldmask
Location : query
name
Type : string
Location : path
Required : Yes
Description : Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
Pattern : ^properties/[^/]+/keyEvents/[^/]+$
HTTP Method : PATCH
Flat Path : v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}
Path : v1alpha/{+name}
Parameter Order : name
Description : Updates a Key Event.
▼ ▲ analyticsadmin.properties.keyEvents.list
HTTP Method : GET
Parameter Order : parent
Path : v1alpha/{+parent}/keyEvents
Scopes :
Description : Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
Parameters :
pageToken
Description : A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.
Location : query
Type : string
parent
Required : Yes
Location : path
Pattern : ^properties/[^/]+$
Type : string
Description : Required. The resource name of the parent property. Example: 'properties/123'
pageSize
Description : The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
Location : query
Format : int32
Type : integer
Flat Path : v1alpha/properties/{propertiesId}/keyEvents
▼ ▲ analyticsadmin.properties.keyEvents.delete
Description : Deletes a Key Event.
Flat Path : v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}
Parameter Order : name
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/analytics.edit
Parameters :
name
Required : Yes
Location : path
Pattern : ^properties/[^/]+/keyEvents/[^/]+$
Description : Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"
Type : string
Path : v1alpha/{+name}
▼ ▲ analyticsadmin.properties.keyEvents.get
Flat Path : v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}
HTTP Method : GET
Description : Retrieve a single Key Event.
Parameters :
name
Description : Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"
Required : Yes
Pattern : ^properties/[^/]+/keyEvents/[^/]+$
Location : path
Type : string
Path : v1alpha/{+name}
Parameter Order : name
Scopes :