- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists ad group ads.
HTTP request
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroupAds
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
advertiserId |
Required. The ID of the advertiser the ad groups belongs to. |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. Requested page size. Must be between |
pageToken |
Optional. A token identifying a page of results the server should return. Typically, this is the value of |
orderBy |
Optional. Field by which to sort the list. Acceptable values are:
The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: |
filter |
Optional. Allows filtering by custom ad group ad fields. Supported syntax:
Supported fields:
Examples:
The length of this field should be no more than 500 characters. Reference our filter |
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 ( |
Fields | |
---|---|
adGroupAds[] |
The list of ad group ads. This list will be absent if empty. |
nextPageToken |
A token to retrieve the next page of results. Pass this value in the |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/display-video
For more information, see the OAuth 2.0 Overview.