パートナーAPI
APIリファレンス

広告生成フィルタリング

広告をリクエストする際は、ブランド、カテゴリ、食の制限などといった顧客のフィルタリングに対応するようにします。eコマースサイトがand/or機能を使用するフィルタリングをサポートしている場合、リクエストに filterMode パラメータを追加するとこれに対応できます。

フィルタリングには以下の2種類があります。

andOr フィルタリング（推奨）

andOr フィルタリングは、ユーザーが検索で詳細にフィルタリングする場合に、有益です。これにより、詳細なフィルタリングをサポートしながらも、よりシンプルなコンテキスト形式が可能になります。この方法の構成は以下の通りです。

"productFilters": [
     [ "" OR "" ] AND [ "" OR "" ] AND [ "" OR "" ] 
    ],
    "options": {
     "filterMode": "AndOr"
    },

リクエストの例は以下のようになります。

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "sessionId": "ec9-4e07-881d-3e9", 
    "placement": "category",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "productFilters": [
     	 ["category:bread"],
    	 ["brand:brandA","brand:brandB"],
    	 ["price:below $10"],
    	 ["nutrition:organic","nutrition:vegan"]
    ],
    "options": {
   							 "filterMode": "AndOr"
 							 },
    "maxNumberOfAds": 3
}

この方法を用いることで、通常は、顧客が詳細なフィルタリングで検索を実施した場合に、小売業者がタイプ別にリクエストをチェーンする作業が、容易になります。

🚧

フィルタリングを正しく作動させるには filterMode を andOr で指定する必要があります。

orAnd フィルタリング（デフォルトモード）

商品フィルタのデフォルトのフィルタリング方法は以下の通りです。

"productFilters": [
     [ "" AND "" ], OR [ "" AND "" ], OR [ "" AND "" ] 
    ],
    "options": {
     "filterMode": "OrAnd"
    },

上記と同じ例では、以下のようなリクエストとして送信されます。

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "sessionId": "ec9-4e07-881d-3e9", 
    "placement": "category",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "productFilters": [
     	 ["category:bread","brand:brandA","price:below $10","nutrition:organic"],
     	 ["category:bread","brand:brandB","price:below $10","nutrition:organic"],
     	 ["category:bread","brand:brandA","price:below $10","nutrition:vegan"],
     	 ["category:bread","brand:brandB","price:below $10","nutrition:vegan"],       
    ],
    "options": {
   							 "filterMode": "OrAnd"
 							 },
    "maxNumberOfAds": 3
}

📘

この機能はデフォルトの動作であるため、 filterMode を orAnd を指定する必要はありません。