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/v1alpha/{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\u003eUpdates a Google Analytics 4 property using the \u003ccode\u003ePATCH\u003c/code\u003e method and provides instructions on constructing the request.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying the property name in the URL path and using a FieldMask in the query parameters to indicate which fields to update.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated Property object, following the structure defined in the provided link, and a successful response will return 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 for making changes to the property.\u003c/p\u003e\n"]]],["This document details how to update a property using a PATCH request to the specified URL: `https://analyticsadmin.googleapis.com/v1alpha/{property.name=properties/*}`. The `property.name` in the URL is a path parameter. The `updateMask` is a required query parameter to specify fields to update. The request body should contain a `Property` instance with modified values, and a successful response also returns a `Property` instance. This action requires the `https://www.googleapis.com/auth/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/v1alpha/{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/v1alpha/properties#Property).\n\n### Response body\n\nIf successful, the response body contains an instance of [Property](/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
