Method: properties.keyEvents.patch

  • Use the PATCH method with a specific URL to update a Key Event resource.

  • Path parameters include keyEvent.name to identify the resource to be updated.

  • The required updateMask query parameter specifies which fields of the Key Event will be updated.

  • The request and response bodies contain instances of the KeyEvent resource.

  • Updating a Key Event requires the https://www.googleapis.com/auth/analytics.edit authorization scope.

Updates a Key Event.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1alpha/{keyEvent.name=properties/*/keyEvents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
keyEvent.name

string

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

Query parameters

Parameters
updateMask

string (FieldMask format)

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.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of KeyEvent.

Response body

If successful, the response body contains an instance of KeyEvent.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit