プロファイル・コマンドAPI
プロファイル・コマンドAPIを使用し、ユーザーに代わりオプトアプトを実行することができます。
- ユーザー・プロファイル・サービスからプロファイルの履歴データを削除します。
- 今後のプロファイル・データはユーザー・プロファイル・サービスに追加されます。
- ユーザーのIDは一貫した同じものを送っていただく必要があります。新しいユーザーIDを作成した場合は、新しいユーザーとして処理されます。
ユーザーに代わりオプトアウトを実行する場合は、以下のURLから始まるプロファイル・コマンドAPIをコールしてください。
https://{environment}.richrelevance.com/profile-command/{version}
注記: URLには環境（ゲートウェイ、ステージング・ゲートウェイ、又はQAゲートウェイ）、バージョン、及びパラメーターが必要です。URLリスエストの例については以下を参照してください。
OAuth署名
POST {baseUrl}/oath2/token
提供されたクライアン証明書を使用して認証を行い、Authorization Bearer Tokenをリクエストしてください。他のエンドポイントへのアクセスを可能にするトークンを得るためには/oauth2/tokenエンドポイントを最初にコールしてください。弊社サイドからはclient_idとclient_secretを使用して送られます。このAPIからのレスポンスにはクライアントのトークンが含まれます。このトークンはマニュアルで無効にしない限り有効です。レスポンスはJSONとして提供されます。
商品APIおよびカタログAPIへのすべてのリクエストでは「Authorization: bearer MY_TOKEN」を送信してください。トークンの有効期限が切れた場合は、client_idとclient_securityを使用して新しいトークンを再取得してください。
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
| grant_type | 必須（文字列） | アクセス用のトークン・タイプです。常にclient_credentialsです。 |
| client_id | 必須（文字列） | クライアントのIDです。 |
| client_secret | 必須（文字列） |
例
リクエスト:
以下の例のプレースホルダー内のclient_idとclient_secretをそれぞれ該当するものに置き換えてください。
curl -X POST \ https://{environment}.richrelevance.com/profile-command/v1/oauth2/token \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'grant_type=client_credentials&client_id={clientId}&client_secret={clientSecret}'
正しいレスポンス例:
{
"token_type": "bearer",
"access_token": "AABBCCDD"
}
エラー・レスポンス:
{
"error_description": "Invalid client authentication",
"error": "invalid_client"
}
または
{
"error_description": "Invalid grant_type",
"error": "unsupported_grant_type"
}
クライアントAPIキー及びシークレット
クライアント・キーやクライアント・シークレットを作成する際には、弊社担当者までお問い合わせください。clientApiKeyはclientSecretはclientApiKeyに対する特定の値でダッシュボードから確認できますが、Eメールか電話でお知らせします。
client_secretは安全に保管してください。絶対に他者と共有せず、HTTPSでのみ使用してください。
オプトアウトの更新
PUT {baseUrl}/optOut/{userId}
PUT: 特定のIDのユーザーのオプトアウトを有効化または無効化します。
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
| userId | 必須（文字列） | データの送信を代わって行うユーザIDの送信に使用されるパス・パラメーターです。 |
| type | 必須（文字列） | 現在使用できる値はoptOutのみです。将来的には他のタイプのデータを送信できるようになります。 |
| enableOptOut | 必須（文字列） | ブール trueまたはfalseです。trueの場合、ユーザーをオプトアプトします。falseの場合、オプトアウトは実行しません。 |
例
リクエスト:
以下の例のプレースホルダー内のaccess_tokenとclient_secretをそれぞれ該当するものに置き換えてください。
curl -X PUT \
https://{environment}.richrelevance.com/profile-command/v1/optOut/{userId} \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
"type": "optOut",
"enableOptOut": true
}'
正しいレスポンス:
{}
エラー・レスポンス:
{
"error_description": "The access token is invalid or has expired",
"error": "invalid_token"
}