Method: advertisers.insertionOrders.list

Mencantumkan pesanan pemasangan di pengiklan.

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

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib. ID pengiklan yang akan mencantumkan pesanan pemasangan iklan.

Parameter kueri

Parameter
pageSize

integer

Ukuran halaman yang diminta. Harus antara 1 dan 100. 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 insertionOrders.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"

Tata urutan 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 pesanan pemasangan.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Batasan dapat digabungkan oleh operator logis 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 pesanan pemasangan iklan dalam kampanye: campaignId="1234"
  • Semua perjanjian pemasangan iklan ENTITY_STATUS_ACTIVE atau ENTITY_STATUS_PAUSED di bagian pengiklan: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Semua pesanan penyisipan dengan waktu pembaruan kurang dari atau sama dengan 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Semua pesanan penyisipan 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 memfilter permintaan LIST untuk mengetahui informasi selengkapnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Kolom
insertionOrders[]

object (InsertionOrder)

Daftar perjanjian pemasangan iklan.

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