Roku Events 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
- イベントグループは、Web サイト、アプリ、チャンネルなど、1 つのオンラインプロパティを表すために使用されます。イベントグループ ID の作成方法については、Roku：イベントグループを参照してください。

コネクタを構成したら、完了をクリックします。

アクション

アクション名	訪問プロファイル	イベントデータ
イベントを送信	✓	✓

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

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

イベントを送信

パラメーター

パラメーター 説明

イベント名

パラメーター	説明
イベント名	イベントのタイプ。Roku では次のイベントがサポートされています。 `AD_VIEW` - 広告が表示された。 `ADD_PAYMENT_INFO` - チェックアウトフローで支払い情報が追加された。 `ADD_TO_CART` - 商品がショッピングカートに追加された。 `ADD_TO_WISHLIST` - 商品がウィッシュリストに追加された。 `APP_INSTALL` - モバイルアプリがインストールされた。 `COMPLETE_REGISTRATION` - 登録フォームへの入力が完了した。 `CONTACT` - 顧客が電話、`SMS`、メール、チャット、またはその他の連絡方法を使用してビジネスへの問い合わせを開始した。 `CUSTOMIZE_PRODUCT` - 顧客が商品をカスタマイズした。 `DONATE` - 組織または活動に対して寄付が行われた。 `DOWNLOAD` - ドキュメント、情報、またはサービスがダウンロードされた。 `FIND_LOCATION` - 顧客が訪問する目的で、Web サイトまたはアプリから実店舗の所在地を検索した。 `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 - 顧客が訪問する目的で、Web サイトまたはアプリから実店舗の所在地を検索した。
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。ブラウザーとサーバーから送信される 1 組のイベントに対して、ID が一意であることを確認してください。
イベントソース URL	イベントが発生したページの URL。
リファラー URL	ユーザーが対象の URL に到達する直前に閲覧していたページの URL。
イベントタイプ	マッピングされていない場合、コネクタはデフォルトで `conversion` を送信します。
オプトアウト	値を `true` にすると、データ使用制限フラグが有効になります。詳細については、Roku：データ使用制限を参照してください。

ユーザーデータ

パラメーター	説明
メールアドレス（SHA256 ハッシュ化済み）	前後の空白を削除し、小文字に変換して SHA256 でハッシュ化済みのメールアドレスを指定します。
メールアドレス（SHA256 ハッシュを適用）	プレーンテキストのメールアドレスを指定します。コネクタは前後の空白を削除して小文字に変換し、SHA256 を使用してこの値をハッシュ化します。
電話番号（SHA256 ハッシュ化済み）	数字のみで構成され、前後の空白が削除され、SHA256 でハッシュ化済みの電話番号を指定します。ハッシュ化する前に、先頭のゼロをすべて削除してください。
電話番号（SHA256 ハッシュを適用）	プレーンテキストの電話番号を指定します。コネクタは、数字以外のすべての文字と先頭のゼロを削除し、前後の空白を削除して、SHA256 を使用してこの値をハッシュ化します。
名（SHA256 ハッシュ化済み）	前後の空白を削除し、小文字に変換して SHA256 でハッシュ化済みの名を指定します。
名（SHA256 ハッシュを適用）	プレーンテキストの名を指定します。コネクタは前後の空白を削除して小文字に変換し、SHA256 を使用してこの値をハッシュ化します。
姓（SHA256 ハッシュ化済み）	前後の空白を削除し、小文字に変換して SHA256 でハッシュ化済みの姓を指定します。
姓（SHA256 ハッシュを適用）	プレーンテキストの姓を指定します。コネクタは前後の空白を削除して小文字に変換し、SHA256 を使用してこの値をハッシュ化します。
生年月日（SHA256 ハッシュ化済み）	前後の空白を削除し、小文字に変換して SHA256 でハッシュ化済みの生年月日（yyyy-mm-dd）を指定します。
生年月日（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` です。

自動重複排除

パラメータ	説明
Tealium iQタグID	Tealium iQタグIDを指定すると、コネクタはタグ管理から送信されたイベントIDの値を自動的に検索し、この値をRokuに送信します。