Method: properties.audiences.patch

  • The PATCH request updates an Audience on a property using the provided URL which follows gRPC Transcoding syntax.

  • The audience.name path parameter specifies the resource name of the Audience to be updated.

  • The updateMask query parameter is required and specifies the fields to be updated, using a comma-separated list in FieldMask format.

  • The request and response bodies contain an instance of the Audience resource.

  • The request requires the https://www.googleapis.com/auth/analytics.edit OAuth scope for authorization.

Updates an Audience on a property.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1alpha/{audience.name=properties/*/audiences/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
audience.name

string

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

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 Audience.

Response body

If successful, the response body contains an instance of Audience.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit