Method: advertisers.adGroups.list

Lists ad groups.

HTTP request

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser the ad groups belongs to.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
pageToken

string

Optional. A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to adGroups.list method. If not specified, the first page of results will be returned.
orderBy

string

Optional. Field by which to sort the list. Acceptable values are:

  • displayName (default)
  • entityStatus

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.
filter

string

Optional. Allows filtering by custom ad group fields.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • All fields must use the EQUALS (=) operator.

Supported properties:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Examples:

  • All ad groups under an line item: lineItemId="1234"
  • All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM ad groups under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

The length of this field should be no more than 500 characters.

Reference our filter LIST requests guide for more information.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
Fields
adGroups[]

object (AdGroup)

The list of ad groups.

This list will be absent if empty.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to adGroups.list method to retrieve the next page of results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.