j1.0.10
API の概要
カスタムオブジェクトには、サードパーティの構成情報や Product Information Management (PIM) システム用の特別なフィールド値など、ビジネス固有の構成情報が格納されます。
たとえば、標準の B2C Commerce 商品属性に従業員 ID 情報が含まれていない場合は、従業員 ID 用のカスタム属性を作成し、この API を使用してその情報を取得できます。SLAS トークンをリクエストする際に、このカスタムオブジェクト情報へのアクセスを指定します。
Business Manager を使用して、オブジェクトの定義やオブジェクトに含まれる値など、カスタムオブジェクトタイプを設定します。
Shopper Custom Objects API を使用して、カスタムオブジェクト情報を取得します。オブジェクトタイプ ID と、オブジェクトの主キー属性を指定できます。
認証と認可
カスタムオブジェクトタイプへのアクセス権を付与するには、SLAS トークンの生成に使用するクライアント ID に、関連するスコープを含めます。詳細については、スコープカタログを参照してください。
sfcc.shopper-custom-objects.{object_type}
重要:
追加のスコープ名前空間を使用して、特定のトークンがアクセスできるカスタムオブジェクトタイプを正確に定義できます。リクエストされたカスタム object_type は、スコープで指定されている object-type と完全に一致する必要があります。SLAS では、最大 20 個のカスタムオブジェクトスコープを処理できます。
たとえば、特定のカスタムオブジェクトタイプ (employee_details など) へのアクセスを制限するには、object_type として含めます。この場合、employee_details カスタムオブジェクトタイプにのみアクセスできます。
sfcc.shopper-custom-objects.employee_details
すべてのカスタムオブジェクトタイプへのグローバルアクセス権を付与するには、次を指定します。
sfcc.shopper-custom-objects
複数のカスタムオブジェクトタイプにアクセスするには、SLAS トークンに含める SLAS API クライアントスコープで、次のように該当するスコープを定義します。
sfcc.shopper-custom-objects.employee_details
sfcc.shopper-custom-objects.employee_performance
ユースケース
カスタムオブジェクトタイプの作成と表示
カスタムオブジェクトタイプは Business Manager で作成します。
- 管理 -> サイトの開発 -> カスタムオブジェクトタイプ に移動します。
- カスタムオブジェクトタイプのリスト セクションに、使用可能なカスタムオブジェクトがリストされます。
- 新しいカスタムオブジェクトタイプを作成するには、新規 を選択し、該当する情報を入力します。これにより、Shopper Custom Objects API エンドポイントへの呼び出しに含まれる
custom_object_type情報が作成されます。
さらに、カスタムオブジェクトタイプには追加情報を提供するキーを定義できます。たとえば、employee_details カスタムオブジェクトタイプに対する employee_id キーを定義できます。
カスタムオブジェクト情報のリクエスト
カスタムオブジェクトタイプの情報をリクエストするには、以下の API URL の custom-objects/ の後にカスタムオブジェクトタイプを指定します。
https://{{short-code}}/custom-object/shopper-custom-objects/v1/organizations/{organization_id}/custom-objects/{custom_object_type}/{key}
key は省略可能なパラメーターで、使用可能な場合は追加のカスタムオブジェクトタイプ情報を取得します。
たとえば、カスタムオブジェクトタイプ employee_details のカスタムオブジェクトタイプキー employee_id を取得するには、次のようにします。
https://{{short-code}}/custom-object/shopper-custom-objects/v1/organizations/{organization_id}/custom-objects/employee_details/employee_id?siteId=RefArch.
フックの使用
フックの使用方法の詳細については、フックによる拡張性を参照してください。
制約
カスタムオブジェクトのスコープ: SLAS では、最大 20 個のカスタムオブジェクトスコープを処理できます。
カスタムオブジェクト: 最大 27 個のカスタムオブジェクト。
詳細については、Governance およびクォータを参照してください。
トラブルシューティング
リクエストするカスタムオブジェクトタイプは、たとえば次のように、大文字と小文字を含めて SLAS トークン内の情報と完全に一致している必要があります。
スコープが sfcc.custom-object-type.employee_details の場合、employee_details は Shopper Custom Objects リクエスト内の情報と一致している必要があります。
https://…/custom-object/shopper-custom-objects/v1/organizations/f_ecom_bgmj_stg/custom-objects/employee_details/{key}?siteId`
SLAS トークンリクエストに shopper-custom-objects を含めずに、その後 Shopper Custom Objects API を呼び出した場合は、401 エラーが返されます。
カスタムオブジェクトに対して key 情報が定義されていないのに key 情報を指定した場合は、404 レスポンスコードが返されます。
Let us know so we can improve!