Mulai
8 September 2025, setiap item baris baru harus menyatakan apakah item baris tersebut akan menayangkan iklan politik Uni Eropa (EU) atau tidak. Upload SDF dan API Display & Video 360 yang tidak memberikan pernyataan akan gagal. Lihat
halaman penghentian penggunaan kami untuk mengetahui detail selengkapnya tentang cara memperbarui integrasi Anda untuk membuat pernyataan ini.
Method: advertisers.adGroups.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Permintaan HTTP
GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
advertiserId |
string (int64 format)
Wajib. ID pengiklan yang memiliki grup iklan.
|
Parameter kueri
| Parameter |
pageSize |
integer
Opsional. Ukuran halaman yang diminta. Harus antara 1 dan 200. Jika tidak ditentukan, setelan defaultnya adalah 100. Menampilkan kode error INVALID_ARGUMENT jika nilai yang ditentukan tidak valid.
|
pageToken |
string
Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. Biasanya, ini adalah nilai nextPageToken yang ditampilkan dari panggilan sebelumnya ke metode adGroups.list. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.
|
orderBy |
string
Opsional. Kolom yang akan digunakan untuk mengurutkan daftar. Nilai yang dapat diterima adalah:
displayName (default)entityStatus Urutan pengurutan default adalah menaik. Untuk menentukan urutan menurun untuk kolom, akhiran "desc" harus ditambahkan ke nama kolom. Contoh: displayName desc.
|
filter |
string
Opsional. Memungkinkan pemfilteran menurut kolom grup iklan kustom. Sintaksis yang didukung:
- Ekspresi filter terdiri dari satu atau beberapa batasan.
- Batasan dapat digabungkan oleh
AND dan OR. Urutan batasan secara implisit menggunakan AND.
- Batasan memiliki bentuk
{field} {operator} {value}.
- Semua kolom harus menggunakan operator
EQUALS (=).
Properti yang didukung:
adGroupIddisplayNameentityStatuslineItemIdadGroupFormat Contoh:
- Semua grup iklan dalam item baris:
lineItemId="1234"
- Semua grup iklan
ENTITY_STATUS_ACTIVE atau ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM di bagian pengiklan: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"
Panjang kolom ini tidak boleh lebih dari 500 karakter. Lihat panduan memfilter permintaan LIST kami untuk mengetahui informasi selengkapnya.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"adGroups": [
{
object (AdGroup)
}
],
"nextPageToken": string
} |
| Kolom |
adGroups[] |
object (AdGroup)
Daftar grup iklan. Daftar ini tidak akan ada jika kosong.
|
nextPageToken |
string
Token untuk mengambil halaman hasil berikutnya. Teruskan nilai ini di kolom pageToken dalam panggilan berikutnya ke metode adGroups.list untuk mengambil halaman hasil berikutnya.
|
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/display-video
Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[],["This document outlines the `adGroups.list` method in the Display & Video 360 API v4. It details how to retrieve a list of ad groups associated with a specific advertiser. Key actions include sending a GET request to a specified URL, using the `advertiserId` as a path parameter. Optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter` enable result customization. The response returns a list of `adGroups` and a `nextPageToken` for pagination. The request body should be empty, and specific OAuth scopes are needed for authorization.\n"],null,["# Method: advertisers.adGroups.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAdGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad groups.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the advertiser the ad groups belongs to. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `pageToken` | `string` Optional. A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/advertisers.adGroups/list#body.ListAdGroupsResponse.FIELDS.next_page_token) returned from the previous call to `adGroups.list` method. If not specified, the first page of results will be returned. |\n| `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`. |\n| `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](/display-video/api/guides/how-tos/filters) guide for more information. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adGroups\": [ { object (/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroups[]` | `object (`[AdGroup](/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup)`)` The list of ad groups. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v4/advertisers.adGroups/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroups.list` method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
