ゲストREST API v2 (レガシー)

ゲストの取得 (レガシー)

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

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

大事な

このREST APIの新しいバージョン(v2.1)が利用可能です。このREST APIを初めて使用する場合は、新しいバージョンを使用してください。または、すでに古いバージョンを使用している場合は、v2とv2.1の違いについて読んでアップグレードできるようにしてください。

GET /v2/guests

ゲストのメールアドレスまたはその他の識別情報を使用してゲストを取得します。

応答のitems.hrefでは、ゲスト参照は最後のスラッシュに続く文字列です。

"href": "{:placeholder-token:}<baseURL>{/:placeholder-token:}/v2/guests/{:placeholder-token:}<guestRef>{/:placeholder-token:}"

ゲスト参照を使用して、完全なゲストレコードを操作 (たとえば、取得または更新) します。

また、ゲスト参照を使用して、Sitecore CDPでゲストに関するデータを検索することもできます。 Sitecore CDPで、Guestsをクリックします。 Searchフィールドに、ゲスト参照を入力します。次に、ゲストのゲストプロファイルSitecore CDP一覧表示されます。

メールでゲストを取得する:

curl -X GET '<baseURL>/v2/[email protected]' \
-u '<username>:<password>' \
-H 'Accept: application/json'

{
  "href": "<baseURL>/v2/guests?offset=0&limit=10&[email protected]",
  "offset": 0,
  "limit": 10,
  "items": [
      {
          "href": "<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
      }
  ]
}

識別子によるゲストの取得:

curl -X GET '<baseURL>/v2/guests?identifiers.provider=BXLP&identifiers.id=123456' \
-u '<username>:<password>' \
-H 'Accept: application/json'

{
  "href": "<baseURL>/v2/guests?offset=0&limit=10&identifiers.provider=BXLP&identifiers.id=123456",
  "offset": 0,
  "limit": 10,
  "items": [
      {
          "href": "<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
      }
  ]
}

要求をカスタマイズする

コレクションは、次のクエリパラメータを使用して検索できます。

firstName
lastName
email
email.untouched
phoneNumber
identifiers.providerプラス identifiers.id

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