Nurture Unsubscribe API
目的目的 への直接リンク
Nurture Unsubscribe APIは、広告主やパートナーが購読解除された顧客を即座にRoktシステムに送り返し、すべての広告主コミュニケーションをリアルタイムで削除することを可能にします。さらに、Nurture Unsubscribe APIは、Roktが広告主に購読解除を送信するためにも使用できます。
どのような利点がありますか？どのような利点がありますか？ への直接リンク
- 効率性。 メールリストがリアルタイムで更新されていることを確認します。
- 正確性。 最新のリストを維持し、オプトインしたままの顧客のみがメールコミュニケーションを受け取ることを保証します。
Import Nurture Unsubscribe APIは誰に適していますか？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キーの取得APIキーの取得 への直接リンク
- アカウントのOP1 - Dataに移動します。
- 左のナビゲーションでSettingsをクリックします。
- Settingsの下のサブメニューでWebhook API Keyをクリックします。
- アカウントにすでにAPIキーがある場合は、ページに表示されます。それ以外の場合は、Create API Keyをクリックして生成します。
セキュリティノート
このAPIキーの目的は、Roktアカウントに影響を与えるAPIへのアクセスを可能にすることですので、この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 のテストAPI のテスト への直接リンク
上記の例は、私たちの本番システムを指しています。そのため、alice@example.com のようなメールアドレスでテストすると、それらのアドレスはもう育成メールを受信しなくなります。購読解除したくないメールアドレスでテストしないでください。