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/v3/advertisers

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
partnerId

string (int64 format)

Wajib. ID partner yang menjadi tujuan semua pengiklan yang diambil. Sistem hanya mendukung pencantuman pengiklan untuk satu partner dalam satu waktu.
pageSize

integer

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

  • advertiserId (default)
  • displayName
  • entityStatus
  • updateTime

Urutan pengurutan default adalah menaik. Untuk menentukan urutan menurun untuk kolom, akhiran "desc" harus ditambahkan ke nama kolom. Misalnya, displayName desc.
filter

string

Memungkinkan pemfilteran menurut kolom pengiklan.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Batasan dapat digabungkan dengan operator logis AND atau OR.
  • Pembatasan 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 di partner: entityStatus="ENTITY_STATUS_ACTIVE"
  • Semua pengiklan dengan waktu pembaruan kurang dari atau sama dengan 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Semua pengiklan dengan waktu pembaruan lebih besar 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 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 
{
  "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:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.