リファラーデータへのアクセス

import Tooltip from "@site/src/components/Tooltip";

常にお客様のデータにアクセスでき、自分とビジネスに最適な方法でRokt経由でデータを利用できます。以下のオプションが含まれます：

1. API 経由.
2. SFTP 経由.
3. メール経由.
4. Mailchimp 経由.
5. 手動で.

メタデータ

次の表には、Roktの両方のキャンペーンタイプで顧客がキャンペーンにオプトインすると、広告主がアクセス可能で要求したデータ属性（利用可能な場合）のリストが含まれています。どのような場合でも、広告主はパートナーデータにアクセスすることはできません。

注記

利用可能な属性のリストは、オファーが表示されたパートナーサイトに基づいて異なる場合があります。

属性	データ形式	説明	例
郵便番号/ポスタルコード	整数	顧客の郵便番号またはポスタルコード	10010
国	文字列	顧客の国	Australia
性別	文字列	顧客の性別	Male
年齢	整数	顧客の年齢	25
日付/時間	日付/時間	顧客がオファーにオプトインした日付と時間	43765.07083
州	文字列	顧客の州	CA
町/市	文字列	顧客の市	Seattle
入札価格	Decimal	リファラルのために顧客が請求された金額	2.50
生年月日	Date/Time	顧客の生年月日	33569
広告応答	Text	オファーにオプトインするために顧客がクリックした肯定的な応答テキスト	Yes, please
広告テキスト	Text	顧客に提示されたオファーテキスト	Receive a call today to hear about our great value.
広告テキスト (HTML)	Text	HTML形式のオファーテキスト	<p>Receive a call today to hear about our great value.<p>
オーディエンスID	Integer	顧客が属していたオーディエンスに関するRokt内部識別子 このIDの長さと形式は変更される可能性があります。	2581697744617019994
オーディエンス名	Text	顧客が属するオーディエンスの名前	M/F: 25+
ブラウザ	Text	顧客のブラウザ	Chrome Mobile
ブラウザバージョン	Integer	顧客のブラウザバージョン（主要リリース）	52
ブラウザバージョン（完全）	Decimal	顧客のブラウザバージョン（主要およびマイナーリリース情報を含む）	52.109
キャンペーンID	Integer	顧客がオプトインしたオファーに関するRokt内部識別子 このIDの長さと形式は変更される可能性があります。	1112223334445556667
キャンペーン名	Text	顧客がオプトインしたオファーの名前	Brand name, Rokt, Hybrid, 2019
国コード	Text	顧客の国（ISO二桁形式）	AU
クーポンコード	Text	顧客に発行されたクーポンコード（キャンペーンにクーポンが含まれている場合にのみ適用されます）	ROKT1234
Creative ID	Integer	顧客がオプトインしたクリエイティブのRokt内部識別子。 このIDの長さと形式は変更される可能性があります。	2.26E+18
Date/time (UTC)	Date/Time	顧客がオファーにオプトインした日付と時間 (UTCタイムゾーン)	43765.2375
Device	Text	顧客がオファーにオプトインしたときのデバイスプラットフォーム	Mobile
Device manufacturer	Text	顧客がオファーにオプトインした際に使用したデバイスの製造元。 Device が Mobile の場合にのみ適用されます。	Samsung
Environment	Text	パートナーのウィジェットが表示された環境	Purchase
Experience	Text	パートナーのウィジェットが表示された体験	Overlay
Placement	Text	顧客がオプトインしたオファーの配置	Prime
Referral type	Text	顧客がオプトインしたオファーの紹介タイプ	Email
Rokt identifier	Text	特定の紹介に対するRokt内部識別子。 このIDの長さと形式は変更される可能性があります。	aa169abb-6552-3638-82b1-224b389fce5b

リファラルエクスポートテンプレートとカスタムフィールド

注記

このオプションは、メールおよびSFTPリファラルエクスポートオプションと併用する場合のみ利用可能です。

次の手順に従って、リファラルエクスポートのテンプレートを作成および管理できます:

テンプレートを作成する

1. 左側のナビゲーションメニューから キャンペーン > 顧客データ ページに移動し、リファラル タブにいることを確認します。

2. テンプレート ドロップダウンメニューから、カスタムテンプレートの作成 を選択します。

3. カスタムテンプレートの名前を入力します。

4. テンプレートに必要なフィールドを選択します。

5. テンプレート内のフィールドを希望する順序に並べ替えます。

6. 保存 をクリックします。

7. テンプレートドロップダウンから新しいカスタムテンプレートを選択します。

テンプレートを編集する

1. 編集したいカスタムテンプレートを選択します。

   

2. 既存のテンプレートを編集をクリックします。

   

3. 既存のカスタムテンプレートにフィールドを追加または削除します。

   

4. テンプレート内のフィールドを希望の順序に並べ替えます。

   

5. 保存をクリックします。

   

6. テンプレートドロップダウンから新しいカスタムテンプレートを選択します。

   

カスタムフィールド

紹介エクスポートのカスタムフィールドを作成するには、次の手順を行います：

1. 左側のナビゲーションメニューから、キャンペーン > 顧客データに移動し、紹介タブにいることを確認します。

2. フィールドをカスタマイズをクリックします。

3. 新しいカスタムフィールドをクリックします。

4. 変換したいフィールドを選択し、カスタムフィールドの名前を入力します。

5. 条件を選択します：等しい または 含む。

6. マップしたい値と新しいフィールド名を入力します。

7. 空の場合のカスタムフィールドの処理方法を選択します。

8. 一致が見つからない場合のデフォルト値を選択します。

9. 保存をクリックします。

API 経由

私たちのデータ管理プラットフォームは、あなたのキャンペーンの紹介データに安全にアクセスするための能力を提供します。人気のあるオプションの1つは、APIを介して直接CRMに統合することです。

APIは、Roktが紹介データをあなたに提供するための最も効率的な方法です。なぜなら、リアルタイムで動作し、あなたのキャンペーンに紹介が生成されるとすぐに、Roktがそのリードをあなたに伝えることができるからです。これを完了するために必要ないくつかの技術的な部分があり、それらは以下に概説されています。

要件

APIのセットアップを開始するには、Roktは以下の情報を必要とします。

以下の詳細をアカウントマネージャーに送信してください：

1. あなたのシステムで購読者を作成するための完全なAPIドキュメンテーション。
2. 設定クエリのトラブルシューティングを助けるための技術的な連絡先情報。
3. 関連する環境（本番、テスト、ステージングなど）のためのエンドポイント。
4. メソッド（例：GET、POST、PUT）
5. 認証（ある場合）
6. リクエストボディのエンコーディング（例：JSON、XML、URLエンコード済み）
7. 必要なAPIパラメータ（Roktが共有できる属性について学びましょう）。
8. Roktが正常に配信されたリードと拒否されたものを正確に分類するのを助けるための期待されるAPI応答。

API ドキュメンテーション

API ドキュメンテーションには、要件として挙げられているいくつかまたはすべてのポイントが含まれる場合があります:

• エンドポイント
• メソッド
• ボディ

これにより、Rokt がどのようにリードをあなたのシステムに届けることができるかを正確に詳細化する必要があります。

API ドキュメンテーションと技術的な連絡先は、API 設定プロセスを開始するのに十分であるべきです。

API ドキュメンテーションの良い例としては、Mailchimp API ドキュメンテーションをチェックしてください。

技術的な連絡先の詳細

API 設定プロセスについての質問を最も適切に対応できる関連する連絡先（あなた自身またはチームの他の誰か）を提供してください。

技術的な連絡先は以下の点で支援できるべきです:

• テストリードがシステム内で正常に記録されたことの確認
• なぜ私たちが403の応答ステータスを受け取っているのかの説明

例:

ジョン・スミス

テクニカルサポート

john.smith@company.com

エンドポイント

これは、Rokt がデータを配信する場所です。ステージングまたはテスト用のエンドポイントがある場合、本番 CRM にテストのリードが配信されないように、セットアップとテストの過程で Rokt チームを支援できます。

例: https://us9.api.mailchimp.com/3.0/lists/abcdefghij/members

メソッド

これは、Rokt がデータをリストに配信するために使用する HTTP リクエストのタイプです。ほとんどの場合、これは POST リクエストです。

Rokt は以下の送信メソッドをサポートしています:

• GET
• POST
• PUT

認証

Rokt が API を呼び出すために必要な認証情報を提供してください。これは以下のような形で提供できます:

• ユーザー名とパスワードの組み合わせ
• API キー
• クライアント ID とシークレット

API パラメーター

Rokt が各 API リクエストで含めるためのパラメーターのリストを提供してください。可能であれば、以下を指定してください:

• 必須属性（リクエストが成功するために送信しなければならない属性）
• オプション属性
• 各属性のパラメーター名（例えば、firstname, FirstName, または first-name を使用するか）

一般的な属性には以下が含まれます:

• メール
• 名
• 姓
• ソース
• 国

参考のため、Rokt はこれらの属性を共有できます。

Rokt は以下のボディエンコーディングをサポートしています:

• JSON
• URL エンコード
• プレーンテキスト
• XML

期待されるAPIレスポンス

可能性のあるAPIレスポンスのリストを提供することにより、Roktはレスポンス処理ロジックを設定して、リードが正常に配信されたのか、配信に失敗したのか、または重複としてラベル付けされたのかを迅速に識別できます。

レスポンス処理は、APIの設定方法に応じて、受け取ったステータスコードやレスポンスボディに基づいて作成できます。

ステータスコードの例:

• 201 (リードが正常に作成されました)
• 400 (認証されていない)
• 500 (サーバーエラー)

レスポンスボディの値の例:

• "successfully delivered"
• {"status": "duplicate"}
• {"success": false}

注意

以下のAPI設定プロセスを完了するために、Roktのアカウントマネージャーと協力してください。

API接続の設定

1. One Platformにログインし、ホームページでアカウントをクリックします。

2. 左のナビゲーションメニューでIntegrations > Connectionsページに移動します。

3. Add connectionをクリックします。

4. Referralsの下で、APIをクリックします。

   

5. 接続に名前を付けます。

   

6. 接続のエンドポイントを入力します。

   

7. Authorization、Headers、Bodyの下に必要な情報をすべて入力します。

   

8. すべてのResponse handlingルールを入力します。

   

API接続のテスト

1. API接続（エンドポイント、認証、ヘッダー、ボディ、レスポンス処理）が設定されたら、設定をクリックします。

   

2. テスト基準に従ってテスト設定を編集します。

   

3. 保存をクリックします。

4. テストをクリックします。

   

5. テスト結果を確認します。

6. 望む結果が得られるまでテストを繰り返します。

キャンペーンをAPI接続にリンクする

1. リアルタイム紹介ページに移動します。

2. キャンペーンをリンクしたい接続を展開します。

   

3. リンクされていないものを表示をクリックします。

   

4. 接続にリンクしたいキャンペーンを見つけて、リンクをクリックします。

   

5. キャンペーンが接続にリンクされました。

   

API接続からキャンペーンを解除する

1. リアルタイムリファラルページに移動します。

2. キャンペーンをリンクしたい接続を展開します。

   

3. 接続からリンクを解除したいキャンペーンを見つけ、リンク解除をクリックします。

   

4. リンク解除表示をクリックします。

   

5. キャンペーンが接続からリンク解除されたことを確認します。

   

SFTP 経由

セキュアファイル転送プロトコル (FTP) 接続を使用すると、リファラルの配信を自動化でき、設定にほとんど手間がかかりません。必要なのは、SFTP の認証情報だけで、準備完了です！

SFTP 接続を設定したら、すべての新しいリファラルと関連メタデータが含まれた .csv ファイルを含むメールを定期的に受信することができます。

自分の SFTP 接続を使用することも、Rokt の接続を使用することもできます。

RoktのFTP接続

始める前に

RoktのSFTPにアクセスできることを確認してください。アクセスできない場合は、アカウントマネージャーに連絡してアクセス権を取得してください。

Rokt SFTPへの接続を設定する前に、以下の情報を用意しておくと良いでしょう：

1. 配信頻度—何回とどの時間帯に紹介をSFTPサーバーにアップロードするか。
2. 必要なパラメータ—最も一般的なのは、メール、名、姓、ソース、州です。Roktが提供できるメタデータについて詳しく学んでください。

ホストコンピュータ（例：ラップトップ）から安全なFTPサーバーへの接続を確立するには、サードパーティのクライアントソフトウェアが必要です。このチュートリアルでは、Windows、Mac、Linuxオペレーティングシステム用に提供されている、一般的で無料のクライアントFileZillaを推奨しています。

1. ブラウザでhttps://filezilla-project.org/にアクセスして、**Download FileZilla Client**をクリックします。
2. FileZillaをコンピュータにインストールします。既にFileZillaがインストールされている場合は、最新バージョンを実行していることを確認してください。
3. Roktアカウントマネージャーに連絡して、Rokt SFTPへのアクセスを依頼します。アクセスが承認されると、Roktから「You've been granted access to Rokt's SFTP server」という件名のメールが届きます。
4. 添付ファイルをダウンロードし、「Email for password for file with instructions」で提供されたパスワードを使用して暗号化されたファイルを解凍します。
5. 今解凍した暗号化ファイルには、RoktのSFTPフォルダーにアクセスするためのキーとなる.pemファイルが含まれています。

注記

以下の手順は、Windows、Mac、Linuxオペレーティングシステムに共通で、最新のFileZillaバージョンに基づいています。

6. FileZillaを開き、File > Site Managerに移動します

7. 左側でNew Siteをクリックし、以下を記入します：

• Protocol: SFTP – SSH File Transfer Protocol

• Host: ftp.rokt.com

• Port: 22

• Key file: ローカルのキーファイル(.pem)を参照し、ローカルドライブから選択します（以下の画像を参照）。

  

8. Connectをクリックします。接続され、ファイルをアップロードするためのアクセス可能なフォルダが表示されるはずです。

ファイルパスと要件

リファラーファイルは以下のファイルパスに配置されています：

ファイルパス	用途
/downloads	Rokt によって提供されたリファラーデータのダウンロード

注記

リファラーファイルはこのフォルダから14日後に自動削除されます。

独自のSFTP接続の使用

接続の確立

1. One Platform にログインし、ホームページでアカウントをクリックします。

2. 左側のナビゲーションメニューからIntegrations > Connections ページに移動します。

3. Add connectionをクリックします。

4. Referralsの下で、FTPを選択します。

5. この接続のCampaignとTemplateを選択し、接続に名前を付けます。

   

6. ディレクトリとファイル名を入力します。

   

7. FTPサーバーホストの詳細とポートを入力します。

   

8. 使用するFTPメソッドを選択します。

   

9. ユーザー名とパスワードを入力するか、SFTPを使用する場合はユーザー名を入力してキー ファイルをアップロードします。

   

10. スケジュールを選択し、保存 をクリックします。

11. 接続が作成されました。

FTP接続の無効化

1. Connections タブに移動し、左のドロップダウンメニューから Scheduled を選択します。

   

2. Actions の下で、一時停止アイコンをクリックします。

   

3. 接続が無効になります。

   

4. これらの手順を逆行することで、接続を有効にすることができます。

メール経由

Roktは紹介ファイル（.csv形式）をメールにてスケジュール送信することができます。この方法はセキュリティが低く、ファイルをメールアカウントから手動でダウンロードする必要がありますが、One Platformから紹介データを取得する入門的な方法として便利です。今後、SFTPまたはAPIソリューションに切り替えることも可能です。

開始前に

メール配信セットアップには以下の情報のみが必要です：

1. 紹介を配信するEメールアドレス（または複数のEメールアドレスのリスト）。
2. 配信頻度—紹介メールを受け取る頻度と時間を指定します。
3. 必要なパラメーター—一般的なのは、メール、名、姓、ソース、および州です。Roktが提供できる 属性 についてもっと知る。

メール接続の設定

1. One Platformのアカウントに移動します。

2. 左側のナビゲーションでIntegrations > Connectionsに進みます。

3. Add connectionをクリックします。

4. Referralsの下で、Emailをクリックします。

5. この接続のキャンペーンとテンプレートを選択します。

6. 接続に名前を付けて、Nextをクリックします。

7. 送信先のメールアドレスを入力して、Nextをクリックします。

8. 希望のスケジュールを選択し、Saveをクリックしてメール接続を作成します。

9. リンクされたキャンペーンのメール接続が作成されました。

メール接続の無効化

1. 左側のナビゲーションメニューから、Integrations > Connections ページに移動し、ドロップダウンメニューからScheduledを選択します。

   

2. 一時停止アイコンをクリックします。

3. メール接続が無効になりました。

4. これらのステップを逆にして、接続を有効にすることができます。

Mailchimp経由

RoktをMailchimpと統合することができます。Mailchimpは、eコマース事業に特化したメールサービスプロバイダーおよびマーケティングオートメーションプラットフォームです。これにより、MailchimpのCRMデータを可能な限り最新に保ち（Roktは5分ごとに新しい紹介を投稿します）、キャンペーンの管理よりも戦略立案に多くのエネルギーを集中させることができます。

注記

より複雑なAPI設定は、Connections ページのAPI オプションの下にあります。API設定に加えて、紹介配信タスクを設定する必要があります。手順はこちらで確認できます。Mailchimp経由でカスタムオーディエンスリストをインポートするための別の設定があり、これについてはこちらで見つけることができます。

MailchimpからAPIキーを取得する

1. Mailchimpアカウントにログインします。右上のあなたの名前をクリックします。ドロップダウンメニューから、プロフィールを選択します。

   

2. エクストラのドロップダウンメニューに移動し、APIキーを選択します。

   

3. 既に作成したAPIキーを使用するか、キーを作成をクリックして新しいものを作成できます。

   

   • Mailchimpが生成したAPIキーを注意深く確認してください。

4. 設定を完了するために、Roktのアカウントマネージャーに連絡してください。

手動での取得

データは常にRoktプラットフォームでアクセス可能です。これは、特定期間のすべてのリファーラルを確認したい場合や、アドホックでトラブルシューティングをする必要がある場合に役立ちます。

既存の接続で問題が発生した場合、例えばAPIの障害やメールが削除された場合でも、心配しないでください！常にRoktプラットフォームにログインして、キャンペーンのリファーラルデータをダウンロードできます。

Roktプラットフォーム内でリファーラルデータにアクセスするためのセットアップは簡単で明確です。

1. アカウントマネージャーにアクセスの希望を伝えると、彼らはあなたのメールアドレスに招待状を送ります。
2. プラットフォームにログインし、ホームページであなたのアカウントをクリックします。
3. 左側のナビゲーションメニューのキャンペーン > 顧客データに移動します。
4. リファーラルタブで、確認したいフィルター（期間、キャンペーン、データ属性など）を選択します。
5. エクスポートをクリックしてデータをダウンロードします。リファーラルファイルのダウンロードを待ちたくない場合は、メールでエクスポートを選択することもできます。Roktは完了次第、.csvファイルをメールで送信します。

注記

一度に最大100,000件のレコードをダウンロードできます。