Method: properties.keyEvents.patch

  • This documentation outlines how to update a Key Event using a PATCH request.

  • The request utilizes gRPC Transcoding syntax and requires specific path and query parameters, including a required updateMask.

  • The request and response bodies both contain an instance of a KeyEvent.

  • 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/v1beta/{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