Method: advertisers.lineItems.list

Menampilkan daftar item baris di pengiklan.

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

Permintaan HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/lineItems

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib. ID pengiklan untuk mencantumkan item baris.

Parameter kueri

Parameter
pageSize

integer

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

string

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

  • displayName (default)
  • entityStatus
  • updateTime

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

string

Memungkinkan pemfilteran berdasarkan kolom item baris.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Pembatasan dapat digabungkan oleh operator logika AND atau OR. Urutan pembatasan 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
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (input dalam format ISO 8601, atau YYYY-MM-DDTHH:MM:SSZ)

Contoh:

  • Semua item baris dalam perjanjian pemasangan iklan: insertionOrderId="1234"
  • Semua item baris ENTITY_STATUS_ACTIVE atau ENTITY_STATUS_PAUSED dan LINE_ITEM_TYPE_DISPLAY_DEFAULT di bawah pengiklan: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Semua item baris dengan waktu pembaruan kurang dari atau sama dengan 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Semua item baris dengan waktu pembaruan lebih 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 filter permintaan LIST kami untuk mendapatkan informasi selengkapnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Kolom
lineItems[]

object (LineItem)

Daftar item baris.

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