Method: advertisers.list

Mencantumkan pengiklan yang dapat diakses oleh pengguna saat ini.

Urutan ditentukan oleh parameter orderBy.

Satu partnerId diperlukan. Listingan lintas partner tidak didukung.

Permintaan HTTP

GET https://displayvideo.googleapis.com/v2/advertisers

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
partnerId

string (int64 format)

Wajib. ID partner yang seharusnya memiliki semua pengiklan yang diambil. Sistem ini hanya mendukung listingan pengiklan untuk satu partner dalam satu waktu.
pageSize

integer

Ukuran halaman yang diminta. Harus antara 1 dan 200. Jika tidak ditentukan akan ditetapkan secara default ke 100.
pageToken

string

Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. Biasanya, ini adalah nilai nextPageToken yang ditampilkan dari panggilan sebelumnya ke metode advertisers.list. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.
orderBy

string

Kolom yang digunakan untuk mengurutkan daftar. Nilai yang dapat diterima adalah:

  • displayName (default)
  • entityStatus
  • updateTime

Urutan penyortiran {i>default<i} adalah menaik. Untuk menentukan urutan kolom yang menurun, akhiran "desc" harus ditambahkan ke nama kolom. Misalnya, displayName desc.
filter

string

Memungkinkan pemfilteran berdasarkan kolom pengiklan.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Pembatasan dapat digabungkan oleh operator logika AND atau OR.
  • Batasan memiliki bentuk {field} {operator} {value}.
  • Kolom updateTime harus menggunakan operator GREATER THAN OR EQUAL TO (>=) atau LESS THAN OR EQUAL TO (<=).
  • Semua kolom lainnya harus menggunakan operator EQUALS (=).

Kolom yang didukung:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (input dalam format ISO 8601, atau YYYY-MM-DDTHH:MM:SSZ)

Contoh:

  • Semua pengiklan aktif yang tergabung dalam partner: entityStatus="ENTITY_STATUS_ACTIVE"
  • Semua pengiklan dengan waktu update kurang dari atau sama dengan 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Semua pengiklan yang memiliki waktu update lebih dari atau sama dengan 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

Panjang kolom ini tidak boleh lebih dari 500 karakter.

Lihat panduan filter permintaan LIST kami untuk mendapatkan informasi selengkapnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Kolom
advertisers[]

object (Advertiser)

Daftar pengiklan.

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 advertisers.list untuk mengambil halaman hasil berikutnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/display-video

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.