Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://analyticsadmin.googleapis.com/v1beta/{property.name=properties/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
property.name |
string
Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
|
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 Property.
Response body
If successful, the response body contains an instance of Property.
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 method updates a specified Google Analytics 4 property using the provided parameters.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes an HTTP PATCH request to the designated endpoint with property name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated Property object and a query parameter 'updateMask' specifying the fields to be updated.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful execution results in a response body containing the updated Property object.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This outlines how to update a property using a PATCH request to `https://analyticsadmin.googleapis.com/v1beta/{property.name=properties/*}`. The `property.name` path parameter specifies the target property, while the `updateMask` query parameter (using FieldMask format) dictates which fields to modify. The request body contains the updated `Property` details, and a successful response returns the updated `Property`. This operation requires the `analytics.edit` authorization scope.\n"],null,["# Method: properties.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 property.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1beta/{property.name=properties/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------|\n| `property.name` | `string` Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\" |\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 [Property](/analytics/devguides/config/admin/v1/rest/v1beta/properties#Property).\n\n### Response body\n\nIf successful, the response body contains an instance of [Property](/analytics/devguides/config/admin/v1/rest/v1beta/properties#Property).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
