フィルタ

filter クエリ文字列パラメータは、AdSense Management API レポートで取得するデータを制限します。filter パラメータを使用する場合、フィルタを適用するディメンションの後にフィルタ式を指定します。

フィルタを適用したクエリでは、結果に含める行が制限されます。結果の各行はフィルタに対してテストされます。フィルタに一致する行は維持され、一致しない行は削除されます。

  • URL エンコード: クライアント ライブラリによってフィルタ演算子が自動的にエンコードされます。しかし、プロトコルに対してリクエストを直接行う場合、以下の表のように、フィルタ演算子を明示的にエンコードする必要があります。
  • フィルタの優先度: フィルタはディメンションの集計前に適用されるため、返される指標は該当するディメンションのみの合計を表します。

フィルタ構文

単一フィルタには次の形式を使用します。

name operator expression

この構文の内容は次のとおりです。

  • name — フィルタを適用するディメンションの名前。たとえば、AD_CLIENT_ID は広告クライアント ID にフィルタを適用します。
  • operator — 使用するフィルタの一致タイプを定義します。
  • expression — 結果に含める値を記述します。

フィルタ演算子

2 つのフィルタ演算子があります。演算子を URL クエリ文字列に含めるには URL エンコードを使用する必要があります。

演算子 説明 URL エンコード形式
== 完全一致 %3D%3D 国名が Canada の指標を集計する場合:
filter=COUNTRY_NAME%3D%3DCanada
=@ 文字列の一部に一致 %3D@ 国名に United が含まれる指標を集計する場合(United States や United Kingdom など):
filter=COUNTRY_NAME%3D@United

フィルタ式

フィルタ式には重要な規則が 2 つあります。

  • URL 予約文字& などの文字には、一般的な方法で URL エンコードを使用する必要があります。クライアント ライブラリがこの処理を行いますが、プロトコルを直接呼び出す場合にはこのエンコードに注意してください。
  • 予約文字 — カンマおよびバックスラッシュを式に含める場合は、バックスラッシュでエスケープ処理する必要があります。
    • バックスラッシュ \\
    • カンマ \,

注: エスケープ処理の重複を防ぐため、バックスラッシュのエスケープ処理はカンマよりも前に行います。

フィルタの組み合わせ

フィルタはブール論理演算の ORAND を使用して組み合わせることができます。

OR 論理演算

OR 論理演算はフィルタ式内でカンマ(,)を使用して定義します。

例:(いずれも URL エンコードを使用)

国コードが US または UK のどちらかの場合(US OR UK):
COUNTRY_CODE==US,COUNTRY_CODE==UK

AND 論理演算

AND 論理演算を行うには複数のフィルタ パラメータを指定します(これはクライアント ライブラリ内でフィルタ配列を指定することになります)。

例:

国コードが US でかつ(AND)商品コードが AFC の場合:
filter=COUNTRY_CODE%3D%3DUS&filter=PRODUCT_CODE%3D%3DAFC

AND および OR 論理演算の組み合わせ

1 つの式に AND と OR の論理演算を組み合わせることができます。

注: 各フィルタは、1 つの AND 論理式にまとめられる前に、個別に評価されます。

例:

国コードが US または UK(US OR UK)でかつ(AND)商品コードが AFC の場合:
filter=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filter=PRODUCT_CODE%3D%3DAFC

次のステップ

フィードバックを送信...