Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.keyEvents.patch
Stay organized with collections
Save and categorize content based on your preferences.
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-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eThis endpoint updates a specific Key Event within a Google Analytics property using an HTTP PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the Key Event's resource name in the URL path and a \u003ccode\u003eupdateMask\u003c/code\u003e query parameter to indicate the fields to be modified.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated Key Event data in JSON format, and the response will contain the updated Key Event if successful.\u003c/p\u003e\n"],["\u003cp\u003eUsers need to have the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope to authorize this request.\u003c/p\u003e\n"]]],["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"],null,["# Method: properties.keyEvents.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates a Key Event.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1alpha/{keyEvent.name=properties/*/keyEvents/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|-----------------------------------------------------------------------------------------------------------|\n| `keyEvent.name` | `string` Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{keyEvent} |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n\n### Request body\n\nThe request body contains an instance of [KeyEvent](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#KeyEvent).\n\n### Response body\n\nIf successful, the response body contains an instance of [KeyEvent](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#KeyEvent).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
