目次
Criteo リセラー プログラム API V2 - フル リファレンス ガイド
コンセプト
Criteo Reseller Program API では次の概念が使用されています
- 予算- 予算は、1 つ以上のキャンペーンに対する販売者の支出を制限します。初期金額と使用済み金額があります。開始日と終了日もあります。販売者キャンペーンを通じて販売された広告のクリックは、交渉されたレートに従って、関連する予算に対して請求されます。同じ販売者に属している限り、複数の販売者キャンペーンによって予算が消費される場合があります。
- キャンペーン- キャンペーンは、販売者の製品を宣伝するための一連の行動です。
- 広告主- 広告主は、販売者に代わって広告を掲載する主体です。通常、広告主は CRP ソリューションを使用して販売者の広告予算を収益化するマーケットプレイスです。別名:マーケットプレイス
- 販売者- 販売者はマーケットプレイスで製品を販売します。販売者は、Criteo プラットフォームを通じてインターネット上で製品の露出が増えるため、キャンペーンの恩恵を受けます。ただし、販売者は Criteo と金銭的なやり取りを行いません。
- 販売者キャンペーン- 販売者キャンペーンは、特定のキャンペーンで使用するために販売者が同意したビジネス ルールをカプセル化したリソースです。たとえば、販売者が何らかのキャンペーンに対して希望する最高入札額が含まれています。通常、プラットフォーム (ウェブとモバイル) が異なれば、キャンペーンも異なります。
この API で公開されるリソースは次のとおりです。
- 広告主（広告主）
- 販売者（販売者）
- 販売者キャンペーン (販売者キャンペーン)
- 予算（予算）
また、v1 Campaignリソース (/marketing/v1/campaigns) も API から参照されます。
これらのリソースには、sellerId と CampaignId が一意の識別子として機能する販売者キャンペーンを除き、それぞれグローバルに一意の識別子があります。
販売者リソースは広告主に関連付けられており、そのコンテキスト内で一意の名前も付けられます。
デザイン
v2 スキーマの設計は、最も重要なリソースに関する次の関係図に基づいています。
すべての販売者キャンペーンは、単一の販売者と単一のキャンペーンで構成される複合主キーを使用することに注意してください。複数の予算リソースに関連付けることができます。同じ販売者に属している限り、複数の販売者キャンペーンによって予算が消費される場合があります。ただし、ビジネス ルールでは、現在の日次予算と現在の非日次予算が最大 1 つずつ存在すると規定されています。日次予算は、非日次予算なしで設定できますが、日次予算だけでは、販売者キャンペーンをアクティブにして広告の配信を開始するには十分ではありません。非日次 (別名「合計」) 予算が必要です。
APIエンドポイント
- この設計ドキュメントでは、サービス ルートhttps://api.criteo.com/marketing/v2/crpの下にあるサービスについて説明します。
- API の swagger の説明は、https: //api.criteo.com/marketing/swaggerでご覧いただけます。
このサービス ルートは、リセラー プログラム ドメイン専用に使用されます。以前は、リセラー プログラムは、販売者の URI パス セグメントの下にあるhttps://api.criteo.com/marketing/v1/サービス ルートの一部でした。
このセクションの残りの部分は、URI アドレスごとに構成されています。 4 つの主要なサブセクションがあります。
- 広告主
- 売り手（売り手）
- 販売者キャンペーン (販売者キャンペーン)
- 予算（予算）
各サブセクションは、サポートされるエンドポイントの表から始まります。