filters
查詢字串參數可限制 AdSense Management API 報表中傳回的資料。使用 filters
參數時,您必須提供要篩選的維度,後面接著篩選器運算式。
查詢在經過篩選後,包含在結果中的資料列會受到限制。結果中的每一個資料列都會根據篩選器進行測試:如果符合篩選器,即會保留資料列,若不相符,該列就會捨棄。
- 網址編碼:用戶端程式庫會自動為篩選器運算子編碼。不過,如果您直接向通訊協定發出要求,就必須按照下表指示為篩選器運算子明確編碼。
- 篩選優先順序:篩選是在維度匯總「之前」進行,因此傳回的指標只會呈現相關維度的總數。
篩選器語法
每個篩選器的形式如下:
name operator expression
在這個語法中:
- name — 做為篩選依據的維度名稱。
舉例來說,
AD_CLIENT_ID
會依據廣告用戶端 ID 進行篩選。 - operator — 定義要使用的篩選器比對類型。
- expression:指出包含在結果中的值。
套用至報表中所列指標的所有維度都可以做為篩選器使用,但日期相關維度 (DATE
、WEEK
和 MONTH
) 除外。如要按日期篩選,請改為指定報表的日期範圍。
篩選運算子
篩選器運算子有兩種,運算子必須經過網址編碼,才能加進網址查詢字串中。
業者 | 說明 | 網址編碼格式 | 範例 |
---|---|---|---|
== |
完全比對 | %3D%3D |
匯總國家/地區名稱為「Canada」的指標:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
包含子字串 | %3D@ |
匯總國家/地區名稱包含「United」的指標 (與美國和英國相符),例如:filters=COUNTRY_NAME%3D@United |
篩選器運算式
篩選運算式有幾項重要規則:
- 網址保留字元 —
&
等字元必須以正常的方式進行網址編碼。用戶端程式庫會為您處理這一點,因此只有在您直接呼叫通訊協定時,才需要擔心這個編碼。 - 保留字元:當半形逗號和反斜線出現在運算式時,必須以反斜線逸出。
- 反斜線
\\
- 逗號
\,
- 反斜線
注意: 請務必在逗號前逸出反斜線,以免重複逸出。
合併篩選器
篩選器可以使用 OR
和 AND
布林邏輯合併。
OR 邏輯
OR
邏輯是使用篩選器運算式中的半形逗號 (,
) 定義。
範例: (每個都必須進行網址編碼)
國家/地區代碼為 (美國或英國):
COUNTRY_CODE==US,COUNTRY_CODE==UK
「且」邏輯
AND
邏輯是由提供多個篩選器參數的方式來完成,這些參數會轉譯為在用戶端程式庫中提供篩選器陣列。
範例:
國家/地區代碼為美國「且」產品代碼為 AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
合併「且」和「或」邏輯
可以將 AND 和 OR 邏輯合併成單一運算式。
注意: 系統會分別評估每個篩選器,再將所有篩選器合併為 AND 邏輯運算式。
範例:
國家/地區代碼為 (美國或英國)「且」產品代碼為 AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC