Method: advertisers.locationLists.list

Mencantumkan daftar lokasi berdasarkan ID pengiklan tertentu.

Permintaan HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/locationLists

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib. ID pengiklan DV360 yang memiliki daftar lokasi yang diambil.

Parameter kueri

Parameter
pageSize

integer

Ukuran halaman yang diminta. Harus antara 1 dan 100. Jika tidak disetel, 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 locationLists.list. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.

orderBy

string

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

  • locationListId (default)
  • displayName

Urutan penyortiran {i>default<i} adalah menaik. Guna menentukan urutan menurun untuk suatu kolom, akhiran "desc" harus ditambahkan ke nama kolom. Contoh: displayName desc.

filter

string

Memungkinkan pemfilteran berdasarkan kolom daftar lokasi.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Pembatasan dapat digabungkan dengan operator logika AND atau OR. Urutan pembatasan secara implisit menggunakan AND.
  • Batasan memiliki bentuk {field} {operator} {value}.
  • Operator harus EQUALS (=).
  • Kolom yang didukung:
    • locationType

Contoh:

  • Semua daftar lokasi regional: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Semua daftar lokasi kedekatan: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "locationLists": [
    {
      object (LocationList)
    }
  ],
  "nextPageToken": string
}
Kolom
locationLists[]

object (LocationList)

Daftar daftar lokasi.

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