Method: advertisers.creatives.list

Mencantumkan materi iklan dalam pengiklan.

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

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib. ID pengiklan yang akan dikirimi materi iklan.

Parameter kueri

Parameter
pageSize

integer

Ukuran halaman yang diminta. Harus antara 1 dan 100. Jika tidak ditentukan, nilai 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, nilai ini adalah nilai nextPageToken yang ditampilkan dari panggilan sebelumnya ke metode creatives.list. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.
orderBy

string

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

  • creativeId (default)
  • createTime
  • mediaDuration
  • dimensions (diurutkan berdasarkan lebar terlebih dahulu, lalu tinggi)

Tata urutan default adalah menaik. Guna menentukan urutan menurun untuk kolom, akhiran "desc" harus ditambahkan ke nama kolom. Contoh: createTime desc.
filter

string

Memungkinkan pemfilteran menurut properti materi iklan.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Pembatasan untuk kolom yang sama harus digabungkan dengan OR.
  • Pembatasan untuk kolom yang berbeda harus digabungkan dengan AND.
  • Antara ( dan ), hanya boleh ada batasan yang digabungkan oleh OR untuk kolom yang sama.
  • Batasan memiliki bentuk {field} {operator} {value}.
  • Operator harus berupa EQUALS (=) untuk kolom berikut:
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • Operator harus berupa HAS (:) untuk kolom berikut:
    • lineItemIds
  • Operator harus berupa GREATER THAN OR EQUAL TO (>=) atau LESS THAN OR EQUAL TO (<=) untuk kolom berikut:
    • updateTime (input dalam format ISO 8601, atau YYYY-MM-DDTHH:MM:SSZ)
  • Untuk entityStatus, minDuration, maxDuration, updateTime, dan dynamic, mungkin ada maksimal satu batasan.
  • Untuk dimensions, nilainya dalam bentuk "{width}x{height}".
  • Untuk exchangeReviewStatus, nilainya dalam bentuk {exchange}-{reviewStatus}.
  • Untuk minDuration dan maxDuration, nilainya akan dalam bentuk "{duration}s". Hanya detik yang didukung dengan perincian milidetik.
  • Untuk updateTime, nilai kolom resource materi iklan mencerminkan waktu terakhir kali materi iklan diperbarui, yang mencakup pembaruan yang dibuat oleh sistem (mis., pembaruan peninjauan materi iklan).
  • Mungkin ada beberapa batasan lineItemIds untuk menelusuri beberapa kemungkinan ID item baris.
  • Mungkin ada beberapa batasan creativeId untuk melakukan penelusuran terhadap beberapa kemungkinan ID materi iklan.

Contoh:

  • Semua materi iklan native: creativeType="CREATIVE_TYPE_NATIVE"
  • Semua materi iklan aktif dengan dimensi 300x400 atau 50x100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Semua materi iklan dinamis yang disetujui oleh AdX atau AppNexus, dengan durasi minimum 5 detik dan 200 md. dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Semua materi iklan video yang dikaitkan dengan ID item baris 1 atau 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Temukan materi iklan berdasarkan beberapa ID materi iklan: creativeId=1 OR creativeId=2

  • Semua materi iklan dengan waktu update lebih dari atau sama dengan 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" Panjang kolom ini tidak boleh lebih dari 500 karakter.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
Kolom
creatives[]

object (Creative)

Daftar materi 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 ListCreativesRequest untuk mengambil halaman hasil berikutnya. Jika kolom ini null, berarti ini adalah halaman terakhir.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.