Parameter string kueri filters
membatasi data yang ditampilkan dalam laporan AdSense Management API. Saat menggunakan parameter filters
, Anda
memberikan dimensi yang ingin difilter, diikuti dengan ekspresi filter.
Kueri yang difilter membatasi baris yang disertakan dalam hasil. Setiap baris dalam hasil akan diuji terhadap filter: jika filter cocok, baris akan dipertahankan, dan jika tidak cocok, baris akan dihapus.
- Encoding URL: Library klien mengenkode operator filter secara otomatis. Namun, jika membuat permintaan langsung ke protokol, Anda harus mengenkode operator filter secara eksplisit seperti yang ditunjukkan pada tabel di bawah.
- Prioritas pemfilteran: Pemfilteran terjadi sebelum dimensi apa pun digabungkan, sehingga metrik yang ditampilkan hanya mewakili total dimensi yang relevan.
Filter Sintaksis
Satu filter menggunakan bentuk:
name operator expression
Dalam sintaksis ini:
- nama — nama dimensi yang akan difilter.
Misalnya:
AD_CLIENT_ID
akan memfilter client ID iklan. - operator — menentukan jenis pencocokan filter yang akan digunakan.
- expression — menyatakan nilai yang disertakan dalam hasil.
Semua dimensi yang berlaku untuk metrik yang dilaporkan dapat digunakan sebagai filter, dengan pengecualian dimensi terkait tanggal (DATE
, WEEK
, dan MONTH
). Untuk memfilter berdasarkan tanggal, tentukan rentang tanggal untuk laporan.
Operator Filter
Ada dua operator filter. Operator tersebut harus berupa URL yang dienkode agar dapat disertakan dalam string kueri URL.
Operator | Deskripsi | Formulir yang Dienkode URL | Contoh |
---|---|---|---|
== |
Pencocokan persis | %3D%3D |
Metrik gabungan dengan nama negara Kanada:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
Berisi substring | %3D@ |
Metrik gabungan yang nama negaranya berisi Amerika Serikat, cocok dengan Amerika Serikat dan Inggris Raya, misalnya:
filters=COUNTRY_NAME%3D@United |
Filter Ekspresi
Ada beberapa aturan penting untuk ekspresi filter:
- Karakter yang dicadangkan untuk URL — Karakter seperti
&
harus dienkode URL dengan cara biasa. Library klien akan menangani hal ini untuk Anda, jadi Anda hanya perlu mengkhawatirkan encoding ini jika melakukan panggilan langsung ke protokol. - Karakter yang digunakan sistem — Koma dan garis miring terbalik harus di-escape garis miring terbalik saat muncul dalam ekspresi.
- garis miring terbalik
\\
- koma
\,
- garis miring terbalik
Catatan: Pastikan Anda meng-escape garis miring terbalik sebelum koma, untuk menghindari escape ganda.
Menggabungkan Filter
Filter dapat digabungkan menggunakan logika boolean OR
dan
AND
.
Logika OR
Logika OR
ditentukan menggunakan koma (,
) di dalam
ekspresi filter.
Contoh: (masing-masing harus dienkode ke URL)
Kode negaranya adalah (AS ATAU Inggris Raya):
COUNTRY_CODE==US,COUNTRY_CODE==UK
Logika DAN
Logika AND
dicapai dengan menyediakan beberapa parameter filter,
yang berarti menyediakan array filter dalam library klien.
Contoh:
Kode negara adalah AS DAN kode produk adalah AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
Menggabungkan logika DAN dan ATAU
Logika DAN dan ATAU dapat digabungkan menjadi satu ekspresi.
Catatan: Setiap filter dievaluasi satu per satu sebelum semua filter digabungkan ke dalam ekspresi logika AND.
Contoh:
Kode negara adalah (AS ATAU Inggris Raya) DAN kode produk adalah AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC