Method: properties.patch

  • Updates a Google Analytics 4 property using the PATCH method and provides instructions on constructing the request.

  • Requires specifying the property name in the URL path and using a FieldMask in the query parameters to indicate which fields to update.

  • The 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.

  • Authorization requires the https://www.googleapis.com/auth/analytics.edit OAuth scope for making changes to the property.

Updates a property.

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