Method: properties.keyEvents.patch

  • Updates a Key Event via a PATCH request to the specified URL with required path and query parameters.

  • The request body should contain an instance of KeyEvent for specifying the desired modifications.

  • A successful update operation results in a response containing the updated KeyEvent instance.

  • Users need to be authorized with the https://www.googleapis.com/auth/analytics.edit scope to perform this action.

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