Method: properties.channelGroups.patch

  • A PATCH request is used to update a ChannelGroup resource via the provided URL.

  • The URL utilizes gRPC Transcoding syntax and includes channelGroup.name as a required path parameter.

  • An updateMask query parameter is required to specify which fields of the ChannelGroup should be updated.

  • The request body contains an instance of ChannelGroup with the data to be updated, and the successful response body will return an updated ChannelGroup instance.

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

Updates a ChannelGroup.

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