Method: advertisers.reachForecast.retrievePlannableUserLists

Mengambil daftar pengguna pihak pertama dan ketiga yang tersedia untuk perkiraan.

Permintaan HTTP

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib. ID pengiklan yang daftar pengguna yang dapat direncanakannya akan diambil.

Parameter kueri

Parameter
pageSize

integer

Opsional. Ukuran halaman yang diminta. Harus antara 1 dan 5000. Jika tidak ditentukan, setelan defaultnya adalah 5000.
pageToken

string

Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. Biasanya, ini adalah nilai nextPageToken yang ditampilkan dari panggilan sebelumnya ke metode reachForecast.retrievePlannableUserLists. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.
filter

string

Opsional. Memungkinkan pemfilteran menurut properti daftar pengguna yang dapat direncanakan.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Batasan dapat digabungkan dengan operator logika AND atau OR.
  • Pembatasan memiliki format {field} {operator} {value}.
  • Kolom displayName harus menggunakan operator HAS (:).
  • Semua kolom lainnya harus menggunakan operator EQUALS (=).

Kolom yang didukung:

  • plannableStatus
  • displayName
  • userListType
  • name

Contoh:

  • Semua daftar pengguna yang dapat direncanakan: plannableStatus="PLANNABLE"
  • Daftar pengguna yang dapat direncanakan dengan nama tampilan yang berisi "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Daftar pengguna pihak pertama: userListType="FIRST_PARTY"

Panjang kolom ini tidak boleh lebih dari 500 karakter.

Lihat panduan memfilter permintaan LIST kami untuk mengetahui informasi selengkapnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons untuk reachForecast.retrievePlannableUserLists.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
Kolom
plannableUserLists[]

object (PlannableUserList)

Hanya output. Daftar daftar pengguna yang dapat direncanakan.
nextPageToken

string

Hanya output. Token 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.

PlannableUserList

Daftar pengguna yang dapat direncanakan yang digunakan untuk perkiraan jangkauan.

Representasi JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Kolom
displayName

string

Hanya output. Nama tampilan daftar pengguna.
userListType

enum (UserListType)

Hanya output. Jenis daftar pengguna.
name

string

Hanya output. Nama resource yang mengidentifikasi daftar pengguna.

Format: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Hanya output. Status perencanaan daftar pengguna.

UserListType

Jenis daftar pengguna.

Enum
USER_LIST_TYPE_UNSPECIFIED Jenis daftar pengguna tidak ditentukan.
FIRST_PARTY Daftar pengguna pihak pertama.
THIRD_PARTY Daftar pengguna pihak ketiga.

PlannableStatus

Status yang menunjukkan apakah daftar dapat direncanakan atau tidak.

Enum
PLANNABLE_STATUS_UNSPECIFIED Status perencanaan tidak ditentukan.
PLANNABLE Daftar pengguna dapat direncanakan.
UNPLANNABLE Daftar pengguna tidak dapat direncanakan.