楽天広告主取引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時刻のISO 8601形式（`YYYY-MM-DDTHH:MM:SS.SSSZ`）で、ユーザーがオンラインで報酬対象のアクションを完了した時刻。マッピングされていない場合、イベントのタイムスタンプがデフォルトになります。
注文ID	（必須）一意の注文ID、取引問い合わせへの返答には消費者向けが望ましい。
通貨	（必須）注文通貨コード。
クリックID	リンクレス報告でない場合に必要。楽天からリダイレクト時または最終ランディングページで送信される34文字のID。
ランディングタイムスタンプ	リンクレス報告でない場合に必要。ユーザーがあなたのサイトに着陸したUTC時刻。このタイムスタンプは取引タイムスタンプよりも前でなければなりません。

オプションの注文データ

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

商品データ

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

オプションの商品データ

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

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

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

返金送信

返金データ

パラメータ	説明
取引タイムスタンプ	UTC時刻のISO 8601形式（`YYYY-MM-DDTHH:MM:SS.SSSZ`）で、ユーザーが元の報酬対象のアクションを完了した時刻。マッピングされていない場合、イベントのタイムスタンプがデフォルトになります。
注文ID	（必須）返金される取引の一意の注文ID。
通貨	（必須）注文通貨コード。
クリックID	（必須）楽天からリダイレクト時または最終ランディングページで送信される34文字のID。
ランディングタイムスタンプ	（必須）ユーザーがあなたのサイトに着陸したUTC時刻。このタイムスタンプは取引タイムスタンプよりも前でなければなりません。

商品データ

パラメータ	説明
商品価格	（必須）商品価格のリスト。コネクタはアイテム金額をRakutenの返金API要件に従って負の数値として送信します。デフォルトでは、コネクタはまた各価格を対応する数量で乗算してから符号変更を適用します。乗算を無効にするには、商品価格計算を無効にするチェックボックスを有効にします。
商品SKU	（必須）商品SKUのリスト。
商品数量	（必須）商品数量のリスト。
商品名	（必須）商品名のリスト。

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

業種別オプションデータ

楽天広告APIは、コネクタUIの名前付きパラメータとして利用できない業種特有のオプションデータフィールドをサポートしています。これらのフィールドを送信するには、オプションデータをサポートする任意のコネクタアクションでカスタムマッピングとして追加し、マッピングキーとしてAPIフィールド名を使用します。

金融

API フィールド	説明	使用法
`autopay`	消費者が自動的に支払いを行うためにアカウントを構成したかどうかを示します。	注文レベル
`customer_segment_group`	広告主が定義したユーザーを5つのグループに分類し、報告では五分位スコアとして表示されます。	アイテムレベル
`designated_marketing_area`	消費者オファーの指定マーケティングエリアのID。	注文レベル
`estimated_aum`	アカウント開設後の消費者の推定管理資産。	注文レベル
`funded_amount`	開設された各アカウントの更新された総残高。	アイテムレベル
`funded_amount_range`	開設されたアカウントの残高を表す広告主が定義した範囲。	アイテムレベル
`home_ownership`	申請者が提出した住宅所有状況。	注文レベル
`income_aum`	オンボーディング中に消費者が入力した収入に基づいて広告主が定義した管理資産。	注文レベル
`income_band`	申請者が提出した収入のコード化された値。	注文レベル
`loan_amount_requested`	申請者が要求したローン額。	注文レベル
`loan_approval_datetime`	ローンの承認日。	注文レベル
`loan_apr`	ローンのAPR。	注文レベル
`loan_funded_datetime`	ローンの資金調達日。	注文レベル
`loan_model_number`	オファーを提示するために使用された事前資格モデルのモデル番号。	注文レベル
`loan_offer_apr`	事前資格モデルによって予測されたローンのAPR。	注文レベル
`loan_offer_badge`	事前資格モデルによって予測されたオファーのバッジタイプ。	注文レベル
`loan_offer_term`	事前資格モデルによって予測されたローン期間。	注文レベル
`loan_origination_fee`	ローンの発生手数料。	注文レベル
`loan_purpose`	ローンのために広告主が定義した目的。	注文レベル
`loan_purpose_applicant`	申請者が提出したローン目的のコード化された値。	注文レベル
`loan_term_in_months`	ローン期間の月数。	注文レベル
`monthly_housing_payment`	申請者が提出した月々のホーム賃または住宅支払いのコード化された値。	注文レベル
`publisher_lead_id`	公開社が閉じたローンを自社の記録と照合するために生成したID。	注文レベル

小売

API フィールド	説明	使用法
`artist_curation_id`	顧客向けのカスタマイズされた製品キュレーションに使用されるアーティストのID。	注文レベル
`commission_estimate`	マーケットプレイス広告主の推定コミッション。公開社には表示されません。	注文レベル
`credit_card_last_four`	カードリンクオファーの識別子として意図されたクレジットカードの最後の4桁。	注文レベル
`discount_amount`	注文レベルで適用された割引額。	注文レベル
`discount_amount`	アイテムレベルで適用された割引額。	アイテムレベル
`discount_type`	注文レベルで使用される割引のタイプ。	注文レベル
`discount_type`	アイテムレベルで使用される割引のタイプ。	アイテムレベル
`is_clearance`	製品がクリアランスセール中であるかどうかを示します。	アイテムレベル
`is_marketplace`	アイテムがマーケットプレイスからのものであるかどうかを示します。	アイテムレベル
`is_sale`	製品がセール中であるかどうかを示します。	アイテムレベル
`markdown_rate`	アイテムの値下げ率（0から100の間）。	アイテムレベル
`marketplace_store`	マーケットプレイス環境で販売が行われた商店の名前。	アイテムレベル
`marketplace_store_id`	マーケットプレイス環境で販売が行われた商店のID。	アイテムレベル
`o2o_bank_partner`	カードリンクオファーの追跡に使用される銀行パートナーの名前。	注文レベル
`o2o_store_address`	店舗の住所。	注文レベル
`o2o_store_city`	店舗が位置する都市。	注文レベル
`o2o_store_country`	店舗が位置する国。	注文レベル
`o2o_store_id`	店舗ID。	注文レベル
`o2o_store_name`	店舗名。	注文レベル
`o2o_store_state`	店舗が位置する州。	注文レベル
`o2o_store_zip`	店舗が位置するZIPまたは郵便番号。	注文レベル
`ship_country`	注文が発送される国。	注文レベル
`shipment_id`	一緒に発送または返送されるアイテムのグループの識別子。	アイテムレベル
`shipped_datetime`	アイテムが発送された、または発送予定の日時。	注文レベル
`store_category`	購入が行われた店舗を表すカテゴリ。	注文レベル
`store_id`	購入が行われた店舗のID。	注文レベル
`subscription_id`	製品サブスクリプションプランのID。	アイテムレベル
`subscription_name`	製品サブスクリプションプランの名前。	アイテムレベル

旅行

API フィールド	説明	使用法
`accommodation_type`	宿泊施設のタイプ。	アイテムレベル
`cancel_deadline_datetime`	旅行者が予約をキャンセルできる期限。	注文レベル
`check_in_datetime`	旅行者がチェックインする日付。	注文レベル
`check_out_datetime`	旅行者がチェックアウトする日付。	注文レベル
`consumed_datetime`	予約が利用された日付。	注文レベル
`departure_country`	旅行者が旅行を開始する国。	アイテムレベル
`departure_location`	旅行者が旅行を開始する場所（都市、空港、クルーズポートなど）。	アイテムレベル
`destination_country`	旅行者が旅行を終える国。	アイテムレベル
`destination_location`	旅行者が旅行を終える場所（都市、空港、クルーズポートなど）。	アイテムレベル
`discount_amount`	注文レベルで適用された割引額。	注文レベル
`discount_amount`	アイテムレベルで適用された割引額。	アイテムレベル
`discount_type`	注文レベルで使用される割引のタイプ。	注文レベル
`discount_type`	アイテムレベルで使用される割引のタイプ。	アイテムレベル
`fare_type`	旅行運賃のタイプ（ファーストクラス、ビジネスクラス、エコノミーなど）。	アイテムレベル
`is_weekend`	予約が週末に行われたかどうかを示します。	注文レベル
`number_of_rooms`	予約に含まれる部屋の数。	アイテムレベル
`paid_in_loyalty_points`	顧客がロイヤルティポイントを使用して支払ったかどうかを示します。	アイテムレベル
`property_type`	不動産のタイプ（ホテルやモーテルなど）。	アイテムレベル
`reservation_end_datetime`	予約終了日。	注文レベル
`reservation_length_in_days`	予約の日数。	注文レベル
`reservation_region`	旅行予約に関連する地域。広告主が複数の場所を持っている場合に役立ちます。	アイテムレベル
`reservation_start_datetime`	予約開始日。	注文レベル
`travel_reason`	旅行の理由（個人的なものやビジネスなど）。	注文レベル
`travel_type`	旅行予約のタイプ（航空会社、クルーズ、ホテル、レンタカー、アクティビティなど）。	アイテムレベル
`vehicle_type`	レンタカーに関連する車両のタイプ（プレミアム、スタンダード、コンパクトなど）。	アイテムレベル