Method: advertisers.adGroupAds.list
HTTP request
GET https://displayvideo.googleapis.com/v3/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:
adGroupIddisplayNameentityStatusadGroupAdId 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["Lists ad group ads associated with a specific advertiser ID using the `GET` method."],["Allows for filtering and sorting of results based on various criteria like `displayName`, `entityStatus`, etc., using query parameters."],["The response includes a list of ad group ads and a token for pagination to retrieve further results."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."]]],["This document outlines the process of listing ad group ads via the `adGroupAds.list` method. It requires a `GET` request to a specific URL, using the advertiser's ID as a path parameter. Optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter` enable pagination, sorting, and filtering. The request body must be empty. The response body will include a list of ad group ads and a `nextPageToken` for pagination. The process requires OAuth authorization with the `https://www.googleapis.com/auth/display-video` scope.\n"]]
