Method: customLists.list

Mencantumkan daftar kustom.

Urutan ditentukan oleh parameter orderBy.

Permintaan HTTP

GET https://displayvideo.googleapis.com/v1/customLists

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
pageSize

integer

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

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

string

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

  • customListId (default)
  • displayName

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

string

Memungkinkan pemfilteran menurut kolom daftar kustom.

Sintaksis yang didukung:

  • Ekspresi filter untuk daftar kustom hanya boleh berisi maksimal satu batasan.
  • Batasan memiliki bentuk {field} {operator} {value}.
  • Semua kolom harus menggunakan operator HAS (:).

Kolom yang didukung:

  • displayName

Contoh:

  • Semua daftar kustom yang nama tampilannya berisi "Google": displayName:"Google".

Panjang kolom ini tidak boleh lebih dari 500 karakter.

Lihat panduan memfilter permintaan LIST untuk mengetahui informasi selengkapnya.
advertiserId

string (int64 format)

ID pengiklan DV360 yang memiliki akses ke daftar kustom yang diambil.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
Kolom
customLists[]

object (CustomList)

Daftar daftar kustom.

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 customLists.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.