Nurture Unsubscribe API
目的
Nurture Unsubscribe APIは、広告主やパートナーが購読解除した顧客を即座にRoktシステムに送信し、すべての広告主コミュニケーションをリアルタイムで削除することを可能にします。さらに、Nurture Unsubscribe APIは、Roktが広告主に購読解除を送信するためにも使用できます。
利点は何ですか？
- 効率性。 メールリストをリアルタイムで更新します。
- 正確性。 最新のリストを維持し、オプトインした顧客のみがメールコミュニケーションを受け取るようにします。
Import Nurture Unsubscribe APIは誰に適していますか？
- 自社の購読解除ランディングページをホストしている広告主（Rokt提供のランディングページではなく）。
- Roktが生成した顧客に対して、Rokt提供のメール育成シリーズと並行して自社のメールコミュニケーションを送信している広告主。
素晴らしいですね。何をすればいいですか？
エンジニアリングリソースを活用して、APIを導入してください。APIのセットアップに関するドキュメントについては、アカウントマネージャーにお問い合わせください。大量のデータを扱い、ナーチャーリストが優先事項である方にとっては、この初期投資の時間は価値があります。
エンジニアリング作業が完了したら、どのように機能しますか？
Nurture Unsubscribe APIが設定されると、準備完了です。顧客がRoktのメールナーチャーや広告主のコミュニケーションから退会すると、両方のシステムがリアルタイムで更新されます。
どのようにして動作していることを確認できますか？
退会した顧客はOne Platformで確認できます。ホームページからアカウントにアクセスし、左側のナビゲーションメニューからCampaigns > Customer Dataページに移動し、Unsubscribesタブをクリックしてください。
認証
このAPIは、リクエストの一部として認証ヘッダーを期待しています。これは、Roktプラットフォームにアクセスする許可があることを確認するためです。認証ヘッダーの値は、Rokt APIにアクセスするための資格情報として機能する、あなたのアカウントのユニークなAPIキーである必要があります。
APIキーの取得
- あなたのアカウントのOP1 - Dataに移動します。
- 左側のナビゲーションでSettingsをクリックします。
- SettingsのサブメニューでWebhook API Keyをクリックします。
- すでにアカウントにAPIキーがある場合は、ページに表示されます。そうでない場合は、Create API Keyをクリックして生成します。
セキュリティに関する注意
このAPIキーの目的は、あなたのRoktアカウントに影響を与えるAPIへのアクセスを可能にすることですので、このAPIキーは他の資格情報（例えばパスワード）と同様に扱うべきです。
APIエンドポイント
| エンドポイントURL | https://api.data.rokt.com/1.0/nurture/unsubscribe |
|---|
このAPIは、マップでなければならないJSONペイロードを受け入れます。ペイロードがJSONであるため、Content-Typeヘッダーをapplication/jsonに設定する必要があります。
レスポンス処理
| HTTPステータス | 説明 |
|---|---|
| 201 | メールが受信され、顧客は購読解除されます。APIは即座に応答を返しますが、購読解除の処理には若干の遅延がある場合があります。 レスポンスボディは、 {"id":"de445c4c-ec46-4e86-a945-ca65d59fda32"}のようなIDのみを含むJSONペイロードです。このIDは特に意味を持ちませんが、問題が発生した場合のトラブルシューティングに役立つ可能性があるため、システムのログにこの値を書き込むことをお勧めします。 |
| 400 | 必須フィールドが欠落しているか、リクエストの形式が正しくない場合、400 Bad Requestが返されます。 |
APIから期待されるレスポンスはJSONペイロードであるため、リクエストには/またはapplication/jsonのいずれかの"accept"ヘッダーを含める必要があります。
パラメーター
マップに以下のキーが存在する必要があります:
| パラメーター | 説明 |
|---|---|
| 単一のメールアドレス（生の形式） |
コマンドラインの例
Linux または MacOS X システムで curl コマンドがインストールされている場合、以下のコマンドはメールアドレス alice@example.com を購読解除します。API_KEY 環境変数があなたの API キーに設定されていると仮定します:
cURL
curl https://api.data.rokt.com/1.0/nurture/unsubscribe --header "Authorization: $API_KEY" --header "Content-Type: application/json" --data '{"email":"alice@example.com"}'
API のテスト
上記の例は、私たちの本番システムを指しています。そのため、alice@example.com のようなメールアドレスでテストすると、それらのアドレスは今後ナーチャー (nurture) メールを受信しなくなります。購読解除したくないメールアドレスでテストしないでください。