メインコンテンツまでスキップ

Nurture Unsubscribe API

目的​

Nurture Unsubscribe APIは、広告主やパートナーがすぐに購読解除した顧客をRoktシステムに送り、広告主のコミュニケーションをリアルタイムで削除することを可能にします。さらに、Nurture Unsubscribe APIは、Roktが広告主に購読解除を送信するために使用することもできます。

どのような利点がありますか？​

  1. 効率性。 メールリストをリアルタイムで更新しましょう。
  2. 正確性。 最新のリストを維持して、購読解除しない顧客のみがメールコミュニケーションを受け取るようにしましょう。

Import Nurture Unsubscribe APIはどのような方に適していますか？​

  1. Roktのパワードランディングページではなく、独自の購読解除ランディングページを持つ広告主。
  2. Roktが生成した顧客に対してRoktパワードのメールナーチャリングシリーズと同時に独自のメールコミュニケーションを送信する広告主。

素晴らしいですね。何をすればいいですか？​

エンジニアリソースを活用してAPIを設置してください。APIの設定に関するドキュメントは、アカウントマネージャーにお問い合わせください。大量の処理を行い、ナーチャーリストが優先される場合は、時間をかけて事前に投資する価値があります。

エンジニアリング作業が完了したら、どのように機能しますか？​

ナーチャー解除APIが設定されたら、準備完了です。お客様がRoktのメールナーチャーや広告主のコミュニケーションから解除されるたびに、両方のシステムがリアルタイムで更新されます。

それが機能しているかどうか、どのように知ることができますか？​

解除された顧客はOne Platformで確認することができます。ホームページからアカウントにアクセスし、左のナビゲーションメニューからCampaigns > Customer Dataページに移動し、Unsubscribesタブをクリックしてください。

Screenshot 1

認証​

APIは、リクエストの一部として認証ヘッダーを必要とします。これは、Roktプラットフォームにアクセスするための許可を持っていることを確認するためです。認証ヘッダーの値は、アカウントの固有のAPIキーである必要があります。これは、Rokt APIにアクセスするための資格情報として機能します。

APIキーの取得​

  1. アカウントのOP1 - Dataに移動します。
  2. 左のナビゲーションでSettingsをクリックします。
  3. SettingsのサブメニューでWebhook API Keyをクリックします。
  4. アカウントにAPIキーがすでにある場合は、ページ上に表示されます。それ以外の場合は、Create API Keyをクリックして生成します。

セキュリティ上の注意
このAPIキーの目的は、Roktアカウントに影響を与えるAPIへのアクセスを可能にするためですので、他の資格情報（パスワードなど）と同様に扱う必要があります。

APIエンドポイント​

エンドポイントURLhttps://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ペイロードであるため、リクエストにはacceptヘッダに/またはapplication/jsonを含める必要があります。

パラメータ​

次のキーはマップ内に存在する必要があります:

パラメータ説明
email単一のメールアドレス (raw形式)

コマンドラインの例​

curlコマンドがインストールされているLinuxまたはMacOS Xシステム上で、以下のコマンドを実行すると、API_KEY環境変数がAPIキーに設定されている場合、メールアドレスalice@example.comが購読解除されます:

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のようなメールアドレスでテストすると、これらのアドレスはもはやナーチャリングメールを受け取らなくなります。購読解除されたくないメールアドレスでテストしないでください。

この記事は役に立ちましたか？