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

将来の日付の広告をリクエストする

CitrusAd の campaignFilterDate プロパティを使用すると、リクエストした日に公開できるキャンペーンを照会できます。

📘

この機能は、バナー広告の統合、特に、顧客が配信スロットを選択する際、価格情報をバナーに表示する法的要件がある場合に最適です。

この機能の目的

CitrusAd への広告リクエストで campaignFilterDate を指定すると、指定した日付に有効になるキャンペーン、または CitrusAd システムで「常にオン」に設定されているキャンペーンのみを確認できます。

CitrusAd システムでは、広告主はキャンペーンを特定の日付範囲においてのみ有効となるように設定できます。

通常、特定の期間にわたってキャンペーンをスケジュールするか、「常にオン」を選択して予算がある場合にキャンペーンで常に消化できるようにするかを広告主が決めることができます。

たとえば、上記のキャンペーンは 2023 年 7 月 2 日から 2023 年 3 月 14 日まで有効です。関連する広告リクエストが campaignFilterDate の 2 つの日付の間に受理された場合、最も関連性の高い広告と見なされると、このキャンペーンは配信されます。

統合の要件

概要

CitrusAd との標準的な統合に加え、広告リクエストで campaignFilterDate を特定するには、統合機能を強化する必要があります。インプレッションとクリックのレポートを変更する必要はありませんが、下記の要領で注文の報告が正しいことを確認する必要があります。

広告リクエスト

広告リクエストでは、ISO-8601 規格の形式で campaignFilterDateを以下の例のように指定する必要があります。

この campaignFilterDate は、顧客がWebサイトから注文を受け取る日付になります。

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "placement": "search",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "searchTerm": "chocolate",
    "campaignFilterDate": "2022-11-20T13:40:00+01:00",
    "options": {
                         "filterMode": "AndOr",
                             },
    "maxNumberOfAds": 3    
}

注文レポート

注文のレポート時には、以下が実装されているか必ずご確認ください。

  • 指定する注文日は、顧客の注文が集荷/配達される時間ではなく、顧客がチェックアウトした時間に設定しなくてはなりません。
    • これにより、CitrusAd のアトリビューションアルゴリズムは、正しいルックバックウィンドウを顧客のインタラクションに適用し、売上を顧客に表示されたキャンペーンに関連付けられるようになります。
  • 顧客が注文を再送信する可能性が高いことから、注文 ID を CitrusAd に送信しないようにすることも必要です。これにより、注文と注文更新を再送信するときに、CitrusAd アルゴリズムが注文と属性を適宜確認できます。
    • 現在のところ、CitrusAd 属性アルゴリズムは、以前に送信された注文 ID を用いて送信された注文は再処理していません。

注文のレポートに関する正しい情報は、 注文データ をご覧ください。

プラットフォームレポート

CitrusAd システムはリアルタイムでレポートを表示するため、クリックとインプレッションは、今後の配信も含めて、表示またはクリックされたときにレポートされます。

広告がリアルタイムで配信されるため、インプレッションやクリック数がCitrusAdに報告されると、ウォレットに課金されます。

🚧

支出レポート

この機能では、今後のキャンペーンを照会するため、支出およびレポートデータとともに今後の有効な日付のキャンペーンが表示される場合があります。今後の期間にわたって行われる予定のキャンペーンが事前に照会されるものであり、誤作動ではありませんのでご安心ください。