サービスAPIヘッダー
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore XCは、HTTPリクエスト ヘッダーと、サービスAPIを介して渡されたヘッダー プロパティまたはフィールドを使用して、呼び出しのコンテキストを確立します。これらのヘッダーとプロパティは、CommerceContextクラスのメソッドとプロパティとして使用でき、すべての呼び出しに含める必要があります。
Sitecore XCは、標準の既知のヘッダーをすぐにサポートしており、特定のプラグインに対して追加のヘッダーを確立できる拡張ポイントを表しています。プラグインは、アクションを実行するときにこれらのヘッダーを参照できます。
一部のヘッダーは、特定のアクションにのみ関連します。ただし、ヘッダーが特定の呼び出しに使用されていない場合や必要ない場合でも、ヘッダーを含めることができます。
次の表に、すぐに使用できるヘッダーとヘッダー プロパティまたは属性を示します。
|
ヘッダー/ヘッダープロパティ名 |
形容 |
|---|---|
|
コンテンツタイプ |
受信者に送信されるエンティティ本文のメディアタイプを示す標準のエンティティヘッダーフィールド。 |
|
環境 |
要求の対象となる環境。 |
|
ショップ名 |
アクセスしている現在のショップの名前 (文字列)。 |
|
ショッパーID |
買い物客の一意の識別子 (通常は文字列として表されるGUID)。 |
|
カスタマーID |
買い物客が登録されている場合は、登録済みの顧客の一意の識別子を表す追加の識別子が渡されます (通常は文字列として表されるGUID)。 |
|
通貨 |
レスポンスで返す通貨 (文字列)。 |
|
言語 |
応答に必要な言語 (文字列)。 |
|
エフェクティブ・デート |
日付ベースの計算中に使用する発効日。これは、現在ではない日時に発生したインタラクションas if結果を確認したいという架空のシナリオをサポートします。 EffectivateDateが渡されない場合は、デフォルトでDateTime.UtcNowが使用されます。 |
|
ジオロケーション |
買い物客の位置情報を特定するためのプロパティ(ロケーションベースのパーソナライゼーションやマーケティングキャンペーンなど)
|
|
役割 |
呼び出し元のロールのリストで、パイプ記号 ("|" ) で区切られます。これにより、クエリで許可されるアクションと返される情報、またはクエリをまったく実行できるかどうか (文字列) を決定できます。 |
|
登録済み |
顧客がアカウントにログインしているかどうかを示すフラグ (ブール値は文字列で表されます)。 |
|
パイプ記号 ("|" ") で区切られたフラグの一覧で、必要な結果を取得するためにコマンドの動作を変更します。 |