Method: advertisers.adGroupAds.list

  • The adGroupAds.list method lists ad group ads for a specific advertiser.

  • The HTTP request uses a GET method with a URL structure that includes the advertiser ID.

  • The request uses path parameters for the advertiser ID and optional query parameters for pagination, sorting, and filtering.

  • The request body must be empty.

  • The response body contains a list of ad group ads and a token for retrieving the next page of results.

  • The method requires authorization with the https://www.googleapis.com/auth/display-video OAuth scope.

Lists ad group ads.

HTTP request

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

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 100. 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 adGroupAds.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 ad 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 fields:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Examples:

  • All ad group ads under an ad group: adGroupId="1234"
  • All ad group ads under an ad group with an entityStatus of ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
Fields
adGroupAds[]

object (AdGroupAd)

The list of ad group ads.

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 adGroupAds.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.