RokuイベントAPIコネクタ構成ガイド | サーバーサイドコネクター

API情報

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

API名：Roku API
APIバージョン：v1
APIエンドポイント：https://events.ads.rokuapi.net
ドキュメント：Roku API

バッチ制限

このコネクタは、ベンダーへの大量データ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値に達するか、プロファイルが公開されるまでキューに入れられます：

最大リクエスト数：1,000
最古のリクエストからの最大時間：10分
リクエストの最大サイズ：1 MB

構成

コネクタマーケットプレイスにアクセスして、新しいコネクタを追加します。コネクタを追加する一般的な手順については、コネクタについてを参照してください。

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

APIキー
- APIキーを生成するには、Roku Ads Managerのイベントタブ内の構成ページにアクセスしてください。
イベントグループID
- イベントグループは、ウェブサイトやアプリ、チャンネルなどのオンラインプロパティを表すために使用されます。イベントグループIDの作成についての詳細は、Roku: イベントグループを参照してください。

アクション

アクション名	AudienceStream	EventStream
イベント送信	✓	✓

アクション名を入力し、ドロップダウンメニューからアクションタイプを選択します。

次のセクションでは、各アクションのパラメータとオプションの構成方法について説明します。

イベント送信

パラメータ

パラメータ 説明

イベント名

パラメータ	説明
イベント名	イベントのタイプ。以下はRokuがサポートするイベントです： `AD_VIEW` - 広告表示。 `ADD_PAYMENT_INFO` - チェックアウトフローで支払い情報が追加されます。 `ADD_TO_CART` - 商品がショッピングカートに追加されます。 `ADD_TO_WISHLIST` - 商品がウィッシュリストに追加されます。 `APP_INSTALL` - モバイルアプリがインストールされます。 `COMPLETE_REGISTRATION` - 登録フォームが完了します。 `CONTACT` - お客様が電話、`SMS`、メール、チャット、その他の連絡方法を通じてビジネスに連絡を取ります。 `CUSTOMIZE_PRODUCT` - お客様が製品をカスタマイズします。 `DONATE` - あなたの組織や原因への寄付が行われます。 `DOWNLOAD` - ドキュメント、情報、またはサービスのダウンロード。 `FIND_LOCATION` - お客様がウェブサイトやアプリを通じて物理的な店舗の場所を検索し、訪問する意図を持っています。 `INITIATE_CHECKOUT` - お客様が完了前にチェックアウトフローに入ります。 `LEAD` - お客様がサインアップフォームを完了します。 `PAGE_VIEW` - ピクセルトラッキングページ訪問のデフォルト数。 `PURCHASE` - 購入またはチェックアウトフローが完了します。 `SCHEDULE` - お客様があなたのロケーションのいずれかを訪問するための予約をします。 `SEARCH` - 検索クエリが行われます。 `SIGN_UP` - サインアップイベント。 `START_TRIAL` - 無料トライアルが開始されます。 `SUBMIT_APPLICATION` - お客様が提供された製品、サービス、またはプログラムに応募します。 `SUBSCRIBE` - お客様が提供された製品やサービスの有料サブスクリプションを開始します。 `SUBSCRIPTION_CANCELLATION` - お客様が製品やサービスの有料サブスクリプションをキャンセルします。 `SUBSCRIPTION_RENEWAL` - お客様が製品やサービスの有料サブスクリプションを更新します。 `UNLOCK_ACHIEVEMENT` - お客様が成果や報酬を解除します。 `VIEW_CONTENT` - お客様が興味のあるページを訪れます。例えば、製品ページやランディングページです。このイベントはページ上のアクションについて具体的ではありません。このイベントは、特定のページや映画やテレビ番組などのコンテンツのアプリ内`VIEW`をキャプチャするためにも使用できます。

イベントのタイプ。以下はRokuがサポートするイベントです：

AD_VIEW - 広告表示。
ADD_PAYMENT_INFO - チェックアウトフローで支払い情報が追加されます。
ADD_TO_CART - 商品がショッピングカートに追加されます。
ADD_TO_WISHLIST - 商品がウィッシュリストに追加されます。
APP_INSTALL - モバイルアプリがインストールされます。
COMPLETE_REGISTRATION - 登録フォームが完了します。
CONTACT - お客様が電話、SMS、メール、チャット、その他の連絡方法を通じてビジネスに連絡を取ります。
CUSTOMIZE_PRODUCT - お客様が製品をカスタマイズします。
DONATE - あなたの組織や原因への寄付が行われます。
DOWNLOAD - ドキュメント、情報、またはサービスのダウンロード。
FIND_LOCATION - お客様がウェブサイトやアプリを通じて物理的な店舗の場所を検索し、訪問する意図を持っています。
INITIATE_CHECKOUT - お客様が完了前にチェックアウトフローに入ります。
LEAD - お客様がサインアップフォームを完了します。
PAGE_VIEW - ピクセルトラッキングページ訪問のデフォルト数。
PURCHASE - 購入またはチェックアウトフローが完了します。
SCHEDULE - お客様があなたのロケーションのいずれかを訪問するための予約をします。
SEARCH - 検索クエリが行われます。
SIGN_UP - サインアップイベント。
START_TRIAL - 無料トライアルが開始されます。
SUBMIT_APPLICATION - お客様が提供された製品、サービス、またはプログラムに応募します。
SUBSCRIBE - お客様が提供された製品やサービスの有料サブスクリプションを開始します。
SUBSCRIPTION_CANCELLATION - お客様が製品やサービスの有料サブスクリプションをキャンセルします。
SUBSCRIPTION_RENEWAL - お客様が製品やサービスの有料サブスクリプションを更新します。
UNLOCK_ACHIEVEMENT - お客様が成果や報酬を解除します。
VIEW_CONTENT - お客様が興味のあるページを訪れます。例えば、製品ページやランディングページです。このイベントはページ上のアクションについて具体的ではありません。このイベントは、特定のページや映画やテレビ番組などのコンテンツのアプリ内VIEWをキャプチャするためにも使用できます。

イベントパラメータ

パラメータ	説明
イベント時間	イベントが発生したときのUNIXタイムスタンプ（エポック秒）。
イベントソース	イベントのソース。ソースには`website`、`phone_call`、`physical_store`が含まれます。ソースの完全なリストについては、Roku: Events APIを参照してください。
イベントID	Rokuがサーバーとブラウザーの両方から送信された同じイベントの重複を排除するために使用するIDです。IDがブラウザーとサーバーから送信されたイベントのペアに対して一意であることを確認してください。
イベントソースURL	イベントが発生したページのURL。
リファラーURL	対象URLに着陸する直前にユーザーがいたページのURL。
イベントタイプ	マッピングされていない場合、コネクタはデフォルトで`conversion`を送信します。
オプトアウト	`true`の値はLimited Data Useフラグをトリガーします。詳細については、Roku: Limited Data Useを参照してください。

ユーザーデータ

パラメータ	説明
Email (既にSHA256ハッシュ化されている)	すでに空白トリム、小文字化、SHA256ハッシュ化されたメールアドレスを提供してください。
Email (SHA256ハッシュを適用)	プレーンテキストのメールアドレスを提供し、コネクタが空白トリム、小文字化、SHA256ハッシュを使用してこの値をハッシュ化します。
電話番号 (既にSHA256ハッシュ化されている)	数字のみを含む電話番号を提供してください。ハッシュ化する前に先頭のゼロを取り除き、空白トリムとSHA256ハッシュを行ってください。
電話番号 (SHA256ハッシュを適用)	プレーンテキストの電話番号を提供し、コネクタがすべての非数字文字と先頭のゼロを取り除き、空白トリムとSHA256ハッシュを使用してこの値をハッシュ化します。
名 (既にSHA256ハッシュ化されている)	すでに空白トリム、小文字化、SHA256ハッシュ化された名前を提供してください。
名 (SHA256ハッシュを適用)	プレーンテキストの名前を提供し、コネクタが空白トリム、小文字化、SHA256ハッシュを使用してこの値をハッシュ化します。
姓 (既にSHA256ハッシュ化されている)	すでに空白トリム、小文字化、SHA256ハッシュ化された姓を提供してください。
姓 (SHA256ハッシュを適用)	プレーンテキストの姓を提供し、コネクタが空白トリム、小文字化、SHA256ハッシュを使用してこの値をハッシュ化します。
生年月日 (既にSHA256ハッシュ化されている)	yyyy-mm-dd形式の生年月日をすでに空白トリム、小文字化、SHA256ハッシュ化して提供してください。
生年月日 (SHA256ハッシュを適用)	yyyy-mm-dd形式のプレーンテキストの生年月日を提供し、コネクタが空白トリム、小文字化、SHA256ハッシュを使用してこの値をハッシュ化します。

カスタムデータ

パラメータ	説明
コンテンツカテゴリ	リクエストのページまたは製品のカテゴリ。
コンテンツID	イベントに関連する製品ID。
コンテンツ名	ページまたは製品の名前。
コンテンツタイプ	リクエストのコンテンツIDのタイプに応じて、`product`または`product_group`。
製品ID	製品IDの配列。
製品数量	製品数量の配列。
製品価格	製品価格の配列。
通貨コード	3文字の通貨コード。サポートされている通貨のリストについては、Roku: Events APIを参照してください。
アイテム数	チェックアウトが開始されたときのアイテム数。
予測LTV	広告主によって定義された加入者の予測生涯価値で、正確な値として表現されます。
検索文字列	検索イベントのためにユーザーが入力した文字列。
ステータス	注文またはサービスのステータス。
価値	購入されるすべての製品の合計価値。
注文ID	トランザクションの注文ID。
購入タイプ	受け入れられる購入タイプの値は`first_time_purchase`と`repeat_purchase`です。
配送カテゴリ	購入イベントの配送タイプ。受け入れられる値は`in_store`、`curbside`、`home_delivery`です。