Method: advertisers.adGroupAds.list

Mencantumkan iklan grup iklan.

Permintaan HTTP

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

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 100. 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 adGroupAds.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 iklan 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 (=).

Kolom yang didukung:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Contoh:

  • Semua iklan grup iklan dalam grup iklan: adGroupId="1234"
  • Semua iklan grup iklan dalam grup iklan dengan entityStatus ENTITY_STATUS_ACTIVE atau ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

Panjang kolom ini tidak boleh lebih dari 500 karakter.

Lihat panduan memfilter permintaan LIST untuk mengetahui informasi selengkapnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
Kolom
adGroupAds[]

object (AdGroupAd)

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