Method: properties.patch

  • This document details how to update a property using the PATCH method with a specific URL format.

  • The request uses a path parameter property.name to identify the property to be updated.

  • A required query parameter updateMask is used to specify which fields of the property will be updated.

  • Both the request and successful response bodies contain an instance of a Property.

  • Updating a property requires the https://www.googleapis.com/auth/analytics.edit OAuth scope.

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