Method: properties.patch
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-01-14 UTC.
[null,null,["Last updated 2025-01-14 UTC."],[[["This method updates a specified Google Analytics 4 property using the provided parameters."],["It utilizes an HTTP PATCH request to the designated endpoint with property name as a path parameter."],["The request body should contain the updated Property object and a query parameter 'updateMask' specifying the fields to be updated."],["Successful execution results in a response body containing the updated Property object."],["Authorization requires the `https://www.googleapis.com/auth/analytics.edit` OAuth scope."]]],["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"]]