Method: advertisers.campaigns.list

Mencantumkan kampanye dalam pengiklan.

Urutan ditentukan oleh parameter orderBy. Jika filter oleh entityStatus tidak ditentukan, kampanye dengan ENTITY_STATUS_ARCHIVED tidak akan disertakan dalam hasil.

Permintaan HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

ID pengiklan yang akan mencantumkan kampanye.

Parameter kueri

Parameter
pageSize

integer

Ukuran halaman yang diminta. Harus antara 1 dan 200. Jika tidak ditentukan, setelan 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 campaigns.list. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.
orderBy

string

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

  • displayName (default)
  • entityStatus
  • updateTime

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

string

Memungkinkan pemfilteran menurut kolom kampanye.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Pembatasan dapat digabungkan dengan operator logika AND atau OR. Urutan batasan secara implisit menggunakan AND.
  • 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:

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

Contoh:

  • Semua kampanye ENTITY_STATUS_ACTIVE atau ENTITY_STATUS_PAUSED di bagian pengiklan: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Semua kampanye dengan waktu pembaruan kurang dari atau sama dengan 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Semua kampanye 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Kolom
campaigns[]

object (Campaign)

Daftar kampanye.

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

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.