| B2bEdition |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- B2B Commerce のエディション。エディションには Lightning (LB2B)、CCRZ、または未来のフレーバーを含めることができます。この項目は、API バージョン 51.0 以降で使用できます。
|
| B2bVersion |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- この項目は省略可能です。管理パッケージの場合、B2BVersion にはメジャー、マイナー、パッチリビジョン番号が含まれています。Lightning の場合、B2BVersion には省略可能なサービスバージョンが含まれています。この項目は、API バージョン 51.0 以降で使用できます。
|
| BrowswerDeviceType |
- 型
- int
- プロパティ
- Create、Nillable
- 説明
- ブラウザとデバイス種別の識別に使用されるコード。この項目は、API バージョン 51.0 以降で使用できます。
コードの形式は「BBVVVXYZ」であり、それぞれの意味は次のとおりです。
- BB — ブラウザ種別を示す 2 桁の数字。
- INTERNET_EXPLORER: 「10」
- CHROME: 「13」
- FIREFOX: 「11」
- SAFARI: 「14」
- OPERA: 「15」
- ANDROID_WEBKIT: 「16」
- NETSCAPE: 「17」
- OTHER_WEBKIT: 「18」
- OTHER_GECKO: 「19」
- OTHER_KHTML: 「20」
- OTHER_MOBILE: 「21」
- SALESFORCE_DESKTOP: 「22」
- BLACKBERRY: 「23」
- GOOD_ACCESS: 「24」
- EDGE: 「25」
- SALESFORCE_MOBILE: 「26」
- VVV — バージョンを示す先行 0 の 3 桁の数字。
- XYZ — ブラウザ種別固有のフラグまたはオプション。XYZ のそれぞれの数字は、BrowserType に応じて異なるフラグを表します。
- X=1: パーサーが「タッチ」ブラウザを認識している場合。ここで言うタッチとは古いタッチネイティブクライアントのことであり、デバイスがタッチに対応しているという意味ではありません。
- Y=1: パーサーが互換モードのブラウザを認識した場合。IE のみが対象。
- Z=1: ブラウザが MOBILE として認識されている場合。
- Z=2: ブラウザが PHONE として認識されている場合。
- Z=3: ブラウザ TABLET として認識されている場合。
- Z=4: ブラウザが MEDIA PLAYER として認識されている場合。
- Z=6: Opera Mini のみが対象。
|
| ContextId |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 操作が実行された主要ビジネス領域の値。たとえば、カートの場合、ContextId は cartId になります。
|
| ContextId2 |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 特定の操作のコンテキスト ID を識別するために使用する別の項目。
|
| ContextMap |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 追加の操作コンテキストまたは他の診断情報を取得する JSON 文字列。
|
| CorrelationId |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- クライアントコールとサーバコール、および Commerce サブシステムへの他の非同期コールを相関させるために使用します。コールは複数のサービスおよび操作で実行される可能性があります。
|
| Count |
- 型
- int
- プロパティ
- Create、Nillable
- 説明
- 操作の影響を受けたレコードの数。
|
| EffectiveAccountId |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 操作のコンテキストにおける Commerce の有効な取引先 ID。
|
| ErrorCode |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 操作が失敗した場合に表示される API エラーコード。
|
| ErrorMessage |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 操作が失敗した場合に表示されるわかりやすいエラーメッセージ。
|
| EventDate |
- 型
- dateTime
- プロパティ
- Create、Nillable
- 説明
- イベントが発生した日付。
|
| EventIdentifier |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 対応するオブジェクトと共有される、イベントの一意の ID。たとえば、0a4779b0-0da1-4619-a373-0a36991dff90 です。この項目値は、イベントとそれに対応するオブジェクトを相関させるために使用します。
|
| EventUuid |
- 型
- string
- プロパティ
- Nillable
- 説明
- プラットフォームイベントメッセージを識別するユニバーサル一意識別子 (UUID)。この項目は、API バージョン 52.0 以降で使用できます。
|
| IsRetry |
- 型
- boolean
- プロパティ
- Create、Defaulted on create
- 説明
- イベントが再試行操作中に発生したか (true)、否か (false) を示します。デフォルト値は false です。
|
| Operation |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- イベントの発生元の操作。たとえば、CreateCart、EditCart、CreateOrder です。
|
| OperationStage |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- イベントの発生元の操作のフェーズ。この値は操作によって異なります。
|
| OperationStatus |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 操作の状況。次のような値があります。
- Success
- SystemError
- AdminError
- UserError
- DependencyError
|
| OperationTime |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 操作の時間 (分または秒単位)。
|
| OsVersion |
- 型
- int
- プロパティ
- Create、Nillable
- 説明
- オペレーティングシステムとバージョンの識別に使用されるコード。OsVersion は不明なプラットフォームの 9999 に相当します。この項目は、API バージョン 51.0 以降で使用できます。
|
| RelatedEventIdentifier |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 関連イベントの EventIdentifier (UUID)。
|
| ReplayId |
- 型
- string
- プロパティ
- Nillable
- 説明
- システムによって生成された ID 値を表し、イベントストリーム内のイベントの位置を参照します。連続するイベントに対して再生 ID の値に連番が振られるという保証はありません。登録者は再生 ID の値を保存し、再登録時にその値を使用して、保持ウィンドウ内の欠落したイベントを取得できます。
|
| ServiceName |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- イベントの発生元のサービス。Commerce でイベントが生成された場合、値は次のようになります。
- BuyerGroup
- BuyerAccount
- BuyerManagement
- Cart
- CartAsync
- Checkout
- Entitlements
- Order
- Pricing
- ProductEtl
- Products
- ReOrder
- Search
- Storefront
- Integration
- Wishlist
- ExternalManagedAccouts
- EffectiveAccountService
- EffectiveAccountUIService
|
| UserId |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- このイベントに関連付けられているユーザの ID。
|
| Username |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- 将来の使用のために予約されています。
|
| WebStoreId |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- このイベントに関連付けられている Webstore の ID。
|
| WebStoreType |
- 型
- string
- プロパティ
- Create、Nillable
- 説明
- WebStore の種別。例: B2B、B2C、OMS。この項目は、API バージョン 51.0 以降で使用できます。
|