Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audiences.patch
Stay organized with collections
Save and categorize content based on your preferences.
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
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-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eThis method updates an existing Audience on a Google Analytics property using an HTTP PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe request must specify the Audience resource name in the URL path and provide an \u003ccode\u003eupdateMask\u003c/code\u003e query parameter indicating the fields to modify.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated Audience data, and a successful response will return the updated Audience resource.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines the process to update an Audience on a property via a PATCH request to the specified URL. The URL utilizes gRPC Transcoding syntax and requires the `audience.name` path parameter in the format `properties/*/audiences/*`. A `updateMask` query parameter specifies which fields to modify. The request and response bodies use the Audience resource. The process requires the `https://www.googleapis.com/auth/analytics.edit` OAuth scope for authorization.\n"],null,["# Method: properties.audiences.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates an Audience on a property.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1alpha/{audience.name=properties/*/audiences/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------|\n| `audience.name` | `string` Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n\n### Request body\n\nThe request body contains an instance of [Audience](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.audiences#Audience).\n\n### Response body\n\nIf successful, the response body contains an instance of [Audience](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.audiences#Audience).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
