1. APIを使用した訪問者プロファイルの削除

訪問者プロファイルの削除APIリファレンス

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

APIを使用して、Sitecore Searchでログに記録されている訪問者プロファイルを削除できます。このAPIの使用に役立つように、前提条件が記載され、サンプルのリクエストとレスポンスを含む、APIを使用した訪問者プロファイルの削除を参照してください。

API URLと方法

APIはapplication/JSONを受け入れ、1つのエンドポイントを公開し、1つのメソッドをサポートします。

DELETE https://api.rfksrv.com/user/v1/users-history/<domainID>?ids=<ID1,ID2>

データモデルとパラメーター

このAPIのデータモデルは次のとおりです。

{
  "method": "DELETE",
  "url": "https://api.rfksrv.com/user/v1/users-history/<domainID>?ids=<comma-separated visitor identifiers>
  "headers": {
    "Authorization": "API key or access token"
  }
}

APIには、次のURLパラメーターがあります。

種類

形容

domainID

必須。

数値ドメイン識別子。 domainIDを表示するには、Searchのドメイン名ドロップダウンメニューをクリックします。

例: 673223107

ids

必須。

プロファイルを削除する訪問者の一意の識別子。 イベントAPIモデルSearchおよびレコメンデーションAPIモデルで指定されているように、以前に送信Searchした次の一意の訪問者識別子のいずれかを渡すことができます。

  • uuid

  • user_id

  • cuid

  • eid

  • fbid

  • email

1つのリクエストで複数の訪問者プロファイルを削除するには、IDをカンマで区切って渡します。IDタイプを混在させることができます。

例えば、3つの訪問者プロファイルを削除するには、次のものを渡すことができます。

sample_user_id,jane.doe%40company.com,sample_fbid

request_id

随意。

内部追跡に使用できるこの要求の識別子。任意の一意の文字列を渡します。

request_idを渡さない場合、要求が成功するとSearchが生成します。

APIには、次のヘッダー パラメーターがあります。

種類

形容

Authorization

必須。

userスコープを持つキーまたはアクセス トークンAPI。この値は、SearchのDeveloper Resourcesセクションから取得できます。

例: 01-6425ce111-3999a6a12b3dfc6b9371857beeadf31897269c8a

APIには、次の応答パラメーターがあります。

種類

形容

request_id

この要求の一意の識別子。これは、応答が成功した場合に表示されます。

要求でrequest_idを渡すと、応答にそのIDが表示されます。

リクエストでrequest_idを渡さない場合は、応答にSearch生成されたIDが表示されます。

例: hsn1255sd652gDFdii0827

リクエストが失敗すると、エラーコードとエラーメッセージが表示されます。

この記事を改善するための提案がある場合は、 お知らせください!