Method: advertisers.adGroups.list

Mencantumkan grup iklan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib diisi. ID pengiklan yang memiliki grup iklan tersebut.

Parameter kueri

Parameter
pageSize

integer

Opsional. Ukuran halaman yang diminta. Harus antara 1 dan 200. Jika tidak ditentukan, nilai 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, nilai 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 digunakan untuk mengurutkan daftar. Nilai yang dapat diterima:

  • displayName (default)
  • entityStatus

Tata urutan default adalah menaik. Guna 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.
  • Pembatasan dapat digabungkan dengan AND dan OR. Urutan pembatasan secara implisit menggunakan AND.
  • Batasan memiliki bentuk {field} {operator} {value}.
  • Semua kolom harus menggunakan operator EQUALS (=).

Properti yang didukung:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

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 bawah 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 permintaan LIST filter 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 informasi selengkapnya, lihat Ringkasan OAuth 2.0.