Memfilter permintaan daftar

Metode list mengambil beberapa resource dari jenis set. Parameter kueri filter memungkinkan Anda memberikan kriteria yang harus dipenuhi oleh resource yang diambil.

Struktur filter

Nilai parameter filter adalah string. String ini terdiri dari satu atau beberapa kriteria. Kriteria digabungkan dengan operator AND atau OR.

Satu kriteria memiliki bentuk {field} {operator} {value}. Berikut contohnya:

  entityStatus="ENTITY_STATUS_ACTIVE"

String filter dibatasi hingga 500 karakter. Jika string Anda terlalu panjang:

  • Pisahkan logika menjadi string terpisah. Lakukan panggilan list dengan setiap string filter. Gabungkan hasil untuk membuat satu daftar.
  • Hapus kriteria dari string filter. Gunakan kriteria yang dihapus untuk memfilter resource yang diambil secara lokal.

Gabungkan nilai untuk kriteria dalam tanda kutip.

Pastikan string filter Anda dienkode untuk digunakan dalam URL saat melakukan panggilan API secara langsung.

Lihat bagian Kriteria gabungan untuk mengetahui struktur string filter selengkapnya.

Kriteria filter

Setiap metode daftar mendukung kriteria filter tertentu. Deskripsi untuk parameter filter metode mencantumkan kriteria ini. Kriteria filter sering kali merupakan subset kolom resource yang diambil.

Setiap kriteria mendukung satu atau beberapa operator:

Operator yang sebanding
EQUALS (=)

Kolom sama dengan nilai yang diberikan.

Contoh: entityStatus="ENTITY_STATUS_ACTIVE"
LESS THAN OR EQUAL TO (<=)

Kolom kurang dari atau sama dengan nilai yang diberikan. Sering digunakan untuk memfilter menurut tanggal atau tanggal dan waktu.

Contoh: updateTime<="2023-04-01T12:00:00Z"
GREATER THAN OR EQUAL TO (>=)

Kolom lebih besar dari atau sama dengan nilai yang diberikan. Sering digunakan untuk memfilter menurut tanggal atau tanggal dan waktu.

Contoh: updateTime>="2023-03-01T12:00:00Z"
HAS (:)

Kolom berisi nilai yang diberikan. Jika kolom adalah string, kolom akan memeriksa apakah nilai yang diberikan adalah substring. Jika kolom adalah array, kolom akan memeriksa array untuk nilai yang diberikan.

Contoh: lineItemIds:"1234"

Jika kriteria tidak menentukan operator, kriteria tersebut hanya mendukung EQUALS (=).

Kriteria akan mencatat apakah memerlukan format khusus.

Kriteria bergabung

Gabungkan beberapa kriteria untuk lebih membatasi respons list.

Gabungkan kriteria dengan operator logika AND dan OR. Setiap metode list menentukan metode mana yang didukung. Beberapa metode hanya mendukung filter dengan satu kriteria.

Pertimbangkan batas ini saat menggunakan beberapa kriteria:

Batasan dan contoh
AND harus menggabungkan batasan, atau grup batasan, yang memfilter kolom yang berbeda, atau yang memfilter kolom yang sama secara berbeda. updateTime>="2023-03-01T12:00:00Z" AND updateTime<="2023-04-01T12:00:00Z" AND (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
OR harus menggabungkan batasan individual yang memfilter menurut kolom yang sama. (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND (lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" OR lineItemType="LINE_ITEM_TYPE_VIDEO_DEFAULT")
OR tidak dapat menggabungkan dua grup batasan. Sebagai gantinya, gunakan beberapa permintaan list dengan nilai filter yang berbeda. Dua string filter berikut harus digunakan dalam permintaan terpisah dan tidak dapat digabungkan menggunakan operator OR:
  • (lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" AND insertionOrderId="123")
  • (lineItemType="LINE_ITEM_TYPE_VIDEO_DEFAULT" AND insertionOrderId="456")
Tanda kurung dapat tersirat untuk mengelompokkan batasan meskipun tidak disertakan. String filter updateTime>="2023-03-01T12:00:00Z" AND entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED" OR entityStatus="ENTITY_STATUS_DRAFT" ditafsirkan sebagai updateTime>="2023-03-01T12:00:00Z" AND (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED" OR entityStatus="ENTITY_STATUS_DRAFT")