filters クエリ文字列パラメータは、返されるデータを制限します。
AdSense Management API レポートで
確認できますfilters パラメータを使用すると、
フィルタを適用するディメンションに続けてフィルタ式を指定します。
フィルタされたクエリでは、結果に含まれる行が制限されます。各行 結果のフィルタがフィルタに対してテストされます。フィルタが一致する場合、その行は 一致しない場合、その行は削除されます。
- URL エンコード: クライアント ライブラリは、 フィルタ演算子を使用します。ただし、このプロトコルに直接リクエストを送信すると、 下の表に示すように、フィルタ演算子を明示的にエンコードする必要があります。
- フィルタの優先度: フィルタは特定のフィルタよりも前に行われます。 ディメンションは集計されるため、返される指標は 関連するディメンションのみを ターゲティングできます
フィルタ構文
1 つのフィルタには次の形式を使用します。
name operator expression
この構文の説明は次のとおりです。
- name - フィルタを適用するディメンションの名前。
たとえば、「
AD_CLIENT_ID」は広告クライアント ID でフィルタします。 - operator — 使用するフィルタの一致タイプを定義します。
- expression — 結果に含める値を記述します。
すべてのディメンション
フィルタとして使用でき、
日付関連のディメンション（DATE、WEEK、
および MONTH）。日付でフィルタするには、
期間のみを使用できます。
フィルタ演算子
フィルタ演算子は 2 つあります。演算子を URL エンコードしないと、 URL クエリ文字列に含めることはできません。
| 演算子 | 説明 | URL エンコード形式 | 例 |
|---|---|---|---|
== |
完全一致 | %3D%3D |
国名が Canada の指標を集計する場合:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
文字列の一部に一致 | %3D@ |
国名に United が含まれる指標を集計する場合、
United States と United States に一致します。たとえば、次のようになります。
filters=COUNTRY_NAME%3D@United |
フィルタ式
フィルタ式にはいくつか重要な規則があります。
- URL 予約文字 - 次のような文字
&は、通常の方法で URL エンコードする必要があります。クライアント ライブラリ 自動的にエンコードされます。 プロトコルを直接呼び出します。 - 予約文字 - カンマとバックスラッシュを
式に含まれている場合は、バックスラッシュでエスケープされます。
- バックスラッシュ
\\ - カンマ
\,
- バックスラッシュ
注: 重複して使用しないでください。
フィルタの組み合わせ
フィルタは、ブール値 OR と AND を使用して組み合わせることができます。
できます。
OR 論理演算子
OR論理は、,
フィルタ式を指定します。
例: （いずれも URL エンコードを使用）
国コードが US または UK のいずれかである:
COUNTRY_CODE==US,COUNTRY_CODE==UK
AND ロジック
AND 論理演算を行うには、複数のフィルタ パラメータを指定します。
これは、クライアント ライブラリでフィルタの配列を指定することになります。
例:
国コードが US で、かつ商品コードが AFC の場合:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
AND 論理演算子と OR 論理演算子の組み合わせ
AND 論理演算と OR 論理演算を 1 つの式にまとめることができます。
注: 各フィルタは個別に評価されます。 すべてのフィルタが AND 論理式に結合される前に行われます。
例:
国コードが「US OR UK」かつ商品コードが AFC の場合:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC