Last updated 2024年7月16日

紹介データにアクセスする

常に、あなたとあなたのビジネスに最も適した方法で、Roktを通じて

referral

Referral

顧客がオファーとやり取りした結果としてのポジティブな成果。例えば、顧客がメールリストの購読にオプトインしたり、モバイルアプリをダウンロードしたり、ウェブサイトに誘導されたりすること。

データにアクセスできます。これには以下のオプションがあります：

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. 左側のナビゲーションメニューから Campaigns > Customer Data ページに移動し、Referrals タブにいることを確認します。

2. Template ドロップダウンメニューから、Create custom template を選択します。

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

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

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

6. Save をクリックします。

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

テンプレートを編集する

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

   

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

   

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

   

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

   

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

   

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

   

カスタムフィールド

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

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

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

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

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

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

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

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

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

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

API経由で

当社のデータ管理プラットフォームは、キャンペーンの紹介データに安全にアクセスする機能を提供します。人気のあるオプションの一つは、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がデータを配信する場所です。ステージングまたはテスト用のエンドポイントがある場合、セットアップおよびテストプロセス中にRoktチームが支援できるため、テストリードがライブCRMに配信されることはありません。

例: 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のSFTPサーバーへのアクセスが許可されました」という件名のメールがRoktから届くはずです。
4. 添付ファイルをダウンロードし、2通目のメール「ファイルのパスワードに関する指示のメール」で提供されたパスワードを使用して暗号化されたファイルを解凍します。
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. Directory and file name を入力します。

   

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

   

8. 希望する FTP メソッドを選択します。

   

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

   

10. スケジュールを選択して Save をクリックします。

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

FTP 接続の無効化

1. 接続 タブに移動し、左端のドロップダウンメニューから スケジュール を選択します。

   

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

   

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

   

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

メール経由

Rokt は、紹介ファイル（.csv 形式）をメールで配信するようにスケジュールできます。この方法はセキュリティが低く、メールアカウントからファイルをダウンロードするために手動処理が必要ですが、One Platform から紹介データを取得するための便利な方法です。将来的には SFTP や API ソリューションに切り替えることができます。

始める前に

メール配信の設定には、次の情報のみが必要です:

1. 紹介を配信するメールアドレス（または複数のメールアドレスのリスト）。
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 は、電子商取引ビジネスを専門とするメールサービスプロバイダーおよびマーケティングオートメーションプラットフォームです。これにより、Mailchimp の CRM データを可能な限り最新の状態に保つことができ（Rokt は新しい紹介を5分ごとに投稿します）、キャンペーンの戦略により多くのエネルギーを集中させ、管理に費やす時間を減らすことができます。

注記

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

MailchimpからAPIキーを取得する

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

   

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

   

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

   

   • Mailchimpが生成したAPIキーをメモしておいてください。

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

手動で

データは常にRoktプラットフォームでアクセス可能です。これは、特定の期間内のすべての紹介を確認したい場合や、アドホックなトラブルシューティングが必要な場合に便利です。

既存の接続に問題が発生した場合（APIの失敗や削除されたメールなど）、心配しないでください！Roktプラットフォームにログインして、キャンペーンの紹介データをダウンロードすることができます。

Roktプラットフォーム内で紹介データにアクセスするための設定は簡単でわかりやすいです：

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

注記

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