ゲストREST API v2 (レガシー)
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
このREST APIの新しいバージョン(v2.1)が利用可能です。このREST APIを初めて使用する場合は、新しいバージョンを使用してください。または、すでに古いバージョンを使用している場合は、v2とv2.1の違いについて読んで アップグレードできるようにしてください。
ゲストオブジェクトは、Sitecore CDPの中核エンティティです。顧客または見込み客の個人データは記録および保存され、関連するすべての取引および行動データはゲストプロファイルにリンクされます。
ゲスト属性は次のとおりです。
|
属性 |
種類 |
形容 |
使用例 |
|---|---|---|---|
|
firstSeen |
ISO 8601日付/時刻UTC |
ゲストが最初に見た日付。 |
"2025-01-01T16:17:16.000Z" |
|
lastSeen |
ISO 8601日付/時刻UTC |
ゲストが最後にブランドとやり取りした時間。ゲストが現在オンラインで、貴社のブランドとやり取りしている場合、現在のセッションが開始された日付とタイムスタンプが返されます。 |
"2025-01-01T16:17:16.000Z" |
|
guestType |
string enum (小文字) |
取得したIDのレベル。 |
次のいずれかである必要があります。
|
|
title |
string (タイトルケース) |
ゲストの肩書き。 |
"Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr" |
|
firstName |
string (タイトルケース) |
ゲストの名前。 |
"John" |
|
lastName |
string (タイトルケースを推奨) |
ゲストの姓。 |
"Doe" |
|
gender |
string (小文字) |
ゲストの性別。 |
"male", "female", "unknown" |
|
dateOfBirth |
ISO 8601日付/時刻UTC検証: 日付は過去の日付である必要があります。 |
ゲストの生年月日。 |
"1985-12-24T00:00Z" |
|
emails |
文字列のJSON配列 |
ゲストのメールアドレス。 | |
|
phoneNumbers |
文字列のJSON配列 |
ゲストの電話番号。 |
"+353161123345", "+353861123311" |
|
language |
文字列 (2文字のISO 639言語コード) |
ゲストの優先言語。 |
"EN", "FR", "DE" |
|
nationality |
string (タイトルケース) |
ゲストの国籍。 |
"Irish", "British", "Spanish", "French" |
|
passportNumber |
string (大文字) |
宿泊者のパスポート番号。 |
"PZ4A9565" |
|
passportExpiry |
糸 |
ゲストのパスポートの有効期限。 |
"2025-01-01T00:00:00.000Z" |
|
street |
文字列のJSON配列 (タイトルケース) |
ゲストの住所。 |
"Ashford House", "Tara Street", "Dublin 2" |
|
city |
string (タイトルケース) |
ゲストの都市。 |
"Dublin", "London", "Madrid", "Paris" |
|
country |
文字列(2文字、ISO 3166-1、Alpha-2国コード) |
ゲストの国。 |
"IE", "GB", "ES", "FR" |
|
postCode |
string (大文字) |
ゲストの郵便番号。 |
"D2" |
|
state |
string (タイトルケース) |
ゲストの状態。 |
"Oregon" |
|
identifiers |
JSONオブジェクトのJSON配列 |
ゲストの識別子の一覧。 |
{ "provider":"SITECORE_IDENTITY_SYSTEM", "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41", "expiryDate":"2025-08-23T16:17:16.000Z" } |
識別子モデルの属性は次のとおりです。
|
属性 |
形容 |
種類 |
使用例 |
必須/オプション |
|---|---|---|---|---|
|
provider |
識別子プロバイダー。 |
糸 |
"ProfileSystem" |
必須 |
|
id |
識別子ID。 |
糸 |
"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41" |
必須 |
|
expiryDate |
識別子の有効期限。 |
ISO 8601日付/時刻UTC |
"2025-01-01T16:17:16.000Z" |
随意 |
標準の応答属性は次のとおりです。
|
属性 |
形容 |
種類 |
使用例 |
|---|---|---|---|
|
href |
リソースの完全修飾ロケーションUniform Resource Identifier (URI)。 |
糸 |
"https://{apiEndpoint}/v2/{resourceName}/{resourceRef}" |
|
ref |
リソースの参照。 |
文字列UUID |
"9d94ee11-7043-4b71-980c-a777d00a7b46" |
|
createdAt |
リソースがSitecore CDPで作成された日時。 |
ISO 8601日付/時刻UTC |
"2025-01-01T16:17:16.000Z" |
|
modifiedAt |
リソースがSitecore CDP年に更新された日時。 |
ISO 8601日付/時刻UTC |
"2025-01-01T16:17:16.000Z" |