Method: properties.audiences.patch

AI-generated Key Takeaways

• This method updates an existing Audience on a Google Analytics property using an HTTP PATCH request.

• The request must specify the Audience resource name in the URL path and provide an updateMask query parameter indicating the fields to modify.

• The request body should contain the updated Audience data, and a successful response will return the updated Audience resource.

• Authorization requires the https://www.googleapis.com/auth/analytics.edit scope.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• Try it!

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