Method: properties.channelGroups.patch

  • This API endpoint updates a ChannelGroup resource using a PATCH request to the specified URL with the necessary parameters.

  • The request requires a updateMask query parameter to specify fields to be updated and a request body containing a ChannelGroup object with the desired changes.

  • Successful responses will contain the updated ChannelGroup object in the response body.

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

  • The URL path includes the ChannelGroup resource name, and uses gRPC Transcoding syntax.

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