楽天広告主取引APIコネクタ構成ガイド

API情報

このコネクタは以下のベンダーAPIを使用します：

API名：楽天広告主取引API
APIバージョン：v1
APIエンドポイント：https://api.linksynergy.com
ドキュメント：楽天広告開発者ポータル

構成

コネクタマーケットプレイスにアクセスし、新しいコネクタを追加します。コネクタの追加方法については、コネクタについてを参照してください。

コネクタを追加した後、以下の構成を行います：

楽天広告主ID：あなたの楽天広告主ID。
クライアントID：楽天から提供されるOAuthクライアントID。
クライアントシークレット：楽天から提供されるOAuthクライアントシークレットキー。

このコネクタはOAuth 2.0クライアント認証を使用します。クライアントIDとクライアントシークレットをhttps://api.linksynergy.com/tokenでベアラートークンと交換します。ベアラートークンは4時間後に期限切れになります。

アクション

アクション名	AudienceStream	EventStream
取引送信	✗	✓
返金送信	✗	✓

取引送信

注文データ

パラメータ	説明
取引タイムスタンプ	(必須) ユーザーがオンラインで報酬対象アクションを完了したUTC時間。
注文ID	(必須) ユニークな注文ID、取引問い合わせへの返答には消費者向けが望ましい。
通貨	(必須) 注文通貨コード。
クリックID	リンクレス報告でない場合に必要。楽天からリダイレクトまたは最終ランディングページで送信された34文字のID。
ランディングタイムスタンプ	リンクレス報告でない場合に必要。ユーザーがあなたのサイトに着陸したUTC時間。このタイムスタンプは取引タイムスタンプよりも前でなければなりません。

オプショナル注文データ

パラメータ	説明
代替注文ID	報告された注文IDの代替バージョン。
コミッション理由	取引にコミッションが支払われない理由。Is Commissionableと併用します。
消費日時	予約が消費された日付。
消費者国	消費者が住んでいる国。
消費者オペレーティングシステム	報酬対象アクション時の消費者のデバイスのオペレーティングシステム。
消費者地域	消費者が住んでいる地域。
コンバージョンタイプ	広告主が使用するコンバージョン帰属方法。例：`post click`。
クーポン	取引に使用されたクーポンまたは割引コード。
クレジットカードタイプ	購入に使用されたクレジットカードのタイプ。
顧客ID	顧客を表すID。
顧客ランク	顧客に割り当てられた広告主のランクまたはスコア。
顧客セグメント	広告主の顧客セグメント。
顧客州	顧客が住んでいる州。
顧客ステータス	顧客の広告主ステータス。例：`new`, `existing`。
イベント日時	イベントの日時。例：コンサート、スポーツイベント。
モバイルデバイスID	モバイルデバイスの広告ID。
注文ステータス	注文のステータス。
購入サイト	購入が行われたドメイン。
トラッキングソース	楽天にトラッキングデータが送信された方法。
トラフィックソース	変換イベントをトリガーしたトラフィックのソース。

商品データ

パラメータ	説明
商品価格	(必須) 商品価格のリスト。デフォルトでは、コネクタは各価格に対応する数量を掛け合わせて送信します。価格値を変更せずに送信するには、商品価格計算を無効にするチェックボックスを有効にします。
商品SKU	(必須) 商品SKUのリスト。
商品数量	(必須) 商品数量のリスト。
商品名	(必須) 商品名のリスト。

オプショナル商品データ

パラメータ	説明
商品ブランド	商品ブランドのリスト。
商品カテゴリ	商品カテゴリのリスト。楽天用により複雑なアイテムごとのカテゴリ配列を作成するためにテンプレートを使用します。
商品カテゴリID	商品カテゴリIDのリスト。楽天用により複雑なアイテムごとのカテゴリ配列を作成するためにテンプレートを使用します。
商品クーポン	商品レベルのクーポンのリスト。
商品ID	商品IDのリスト。
高コミッション率	高いコミッション率に関連する商品のブール値のリスト。
商品シーケンス	出荷に含まれるアイテムのシーケンスを識別するリスト。
商品ステータス	アイテムステータスのリスト。
コミッション対象	各商品がコミッション対象かどうかを示すブール値のリスト。
商品マージン	商品レベルのマージンのリスト。
マーケットプレイスストア	マーケットプレイス環境で販売が行われた店舗のリスト。
マーケットプレイスストアID	マーケットプレイス環境で販売が行われた店舗のIDのリスト。
非課税	各商品が非課税であるかどうかを示すブール値のリスト。

商品価格計算を無効にする

楽天は商品価格を価格×数量として送信することを要求しています。コネクタはこの計算を自動的に行います。マップされた価格値を変更せずに送信するには、このチェックボックスを有効にします。

返金送信

返金データ

パラメータ	説明
取引タイムスタンプ	(必須) ユーザーが元の報酬対象アクションを完了したUTC時間。
注文ID	(必須) 返金される取引のユニークな注文ID。
通貨	(必須) 注文通貨コード。
クリックID	(必須) 楽天からリダイレクトまたは最終ランディングページで送信された34文字のID。
ランディングタイムスタンプ	(必須) ユーザーがあなたのサイトに着陸したUTC時間。このタイムスタンプは取引タイムスタンプよりも前でなければなりません。

商品データ

パラメータ	説明
商品価格	(必須) 商品価格のリスト。コネクタはアイテム金額を楽天の返金API要件に従ってマイナス数値として送信します。デフォルトでは、コネクタは各価格に対応する数量を掛け合わせて符号変更を適用します。掛け合わせを無効にするには、商品価格計算を無効にするチェックボックスを有効にします。
商品SKU	(必須) 商品SKUのリスト。
商品数量	(必須) 商品数量のリスト。
商品名	(必須) 商品名のリスト。