Method: properties.keyEvents.patch
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[null,null,["Last updated 2025-01-14 UTC."],[[["This endpoint updates a specific Key Event within a Google Analytics property using an HTTP PATCH request."],["The request requires specifying the Key Event's resource name in the URL path and a `updateMask` query parameter to indicate the fields to be modified."],["The request body should contain the updated Key Event data in JSON format, and the response will contain the updated Key Event if successful."],["Users need to have the `https://www.googleapis.com/auth/analytics.edit` OAuth scope to authorize this request."]]],["This document details updating a Key Event via a PATCH request to a specific URL (`https://analyticsadmin.googleapis.com/v1alpha/{keyEvent.name=properties/*/keyEvents/*}`). The `keyEvent.name` path parameter is required to identify the target. The `updateMask` query parameter specifies fields to be updated, using a field mask format. The request and response bodies utilize the `KeyEvent` resource. An `analytics.edit` OAuth scope is needed for authorization.\n"]]