サービスAPIヘッダー

Sitecore XCはHTTPリクエストヘッダーやサービスAPIを通じて渡されるヘッダープロパティ、またはフィールドを使って呼び出しのコンテキストを設定します。これらのヘッダーやプロパティはCommerceContextクラスのメソッドおよびプロパティとして利用可能であり、すべての呼び出しに含めなければなりません。

Sitecore XCは標準的な既知ヘッダーを標準化してサポートしており、特定のプラグインに対して追加のヘッダーを設定できる拡張性ポイントを表しています。プラグインはアクションを行う際にこれらのヘッダーを参照できます。

一部のヘッダーは特定のアクションでのみ関連します。ただし、特定の呼び出しで使われていなくても、ヘッダーを含めることは可能です。

以下の表は、ボックス一開始で対応されるヘッダーおよびヘッダープロパティまたは属性を一覧にしています。

ヘッダー/ヘッダープロパティ名

概要

コンテンツタイプ

受信者に送られるエンティティボディのメディアタイプを示す標準的なエンティティヘッダーフィールドです。

環境

依頼対象の環境。

ショップネーム

アクセス中の現在のショップ名(文字列)。

ショッパーID

ショッパーの一意識別子(通常は文字列で表現されるGUID)。

カスタマーID

ショッパーが登録されている場合、登録顧客の一意識別子(通常は文字列で表されるGUID)を表す追加の識別子が渡されます。

通貨

応答で返す通貨(文字列)。

言語

応答に求められる言語(文字列)。

発効日

日付ベースの計算時に使う有効日付。これは、相互作用が現在ではない日付や時間で起こったか のように 結果を見られるという仮定のシナリオをサポートします。

EffectivateDateが入力されない場合は、デフォルトでDateTime.UtcNowが使用されます。

ジオロケーション

ショッパーの位置を特定するプロパティ(例えば、位置情報に基づくパーソナライズやマーケティングキャンペーンなど)

• 市外局域番号
• ビジネスネーム
• 都市
• Dnsアドレス
• Ipアドレス
• IspName(アイスプネーム)
• 緯度
• 経度
• メトロコード
• 方針
• 郵便番号
• 地域
• タイムゾーン

役割

呼び出し元の役割のリストで、パイプ記号("|")で区切られます。これにより、どのアクションが許され、クエリでどの情報が返されるか、あるいはクエリ自体が実行可能かどうか(文字列)が決定されます。

登録済み

顧客がアカウントにログインしているかどうかを示すフラグ(ブールは文字列で表されます)。

ポリシーキー

パイプ記号("|")で区切られたフラグのリストで、コマンドの動作を変えて必要な結果を得ることができます。