Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.channelGroups.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://analyticsadmin.googleapis.com/v1alpha/{channelGroup.name=properties/*/channelGroups/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
channelGroup.name |
string
Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channelGroup}
|
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 ChannelGroup.
Response body
If successful, the response body contains an instance of ChannelGroup.
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 API endpoint updates a ChannelGroup resource using a PATCH request to the specified URL with the necessary parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eupdateMask\u003c/code\u003e query parameter to specify fields to be updated and a request body containing a \u003ccode\u003eChannelGroup\u003c/code\u003e object with the desired changes.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses will contain the updated \u003ccode\u003eChannelGroup\u003c/code\u003e object in the response body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eThe URL path includes the ChannelGroup resource name, and uses gRPC Transcoding syntax.\u003c/p\u003e\n"]]],["This document outlines the process for updating a ChannelGroup via a PATCH request to the Google Analytics Admin API. The core actions involve using a specific URL structure that includes the channel group's name. It requires a `FieldMask` parameter specifying which fields to update. The request body and successful response both use the `ChannelGroup` resource. The process requires `analytics.edit` authorization. This process utilizes HTTP requests, path/query parameters, and request/response bodies.\n"],null,["# Method: properties.channelGroups.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 a ChannelGroup.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1alpha/{channelGroup.name=properties/*/channelGroups/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `channelGroup.name` | `string` Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channelGroup} |\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 [ChannelGroup](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.channelGroups#ChannelGroup).\n\n### Response body\n\nIf successful, the response body contains an instance of [ChannelGroup](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.channelGroups#ChannelGroup).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
