Method: properties.channelGroups.list

  • This document details how to list ChannelGroups on a property using an HTTP GET request.

  • The request requires a parent path parameter specifying the property and supports optional pageSize and pageToken query parameters for pagination.

  • The request body must be empty, and the response body contains a list of ChannelGroups and an optional nextPageToken.

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

Lists ChannelGroups on a property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/channelGroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The property for which to list ChannelGroups. Example format: properties/1234

Query parameters

Parameters
pageSize

integer

The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
pageToken

string

A page token, received from a previous channelGroups.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to channelGroups.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for channelGroups.list RPC.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "channelGroups": [
    {
      object (ChannelGroup)
    }
  ],
  "nextPageToken": string
}
Fields
channelGroups[]

object (ChannelGroup)

List of ChannelGroup. These will be ordered stably, but in an arbitrary order.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit