Apex 開発者ガイド
jNewer Version Available
CommerceCatalog クラス
名前空間
CommerceCatalog のメソッド
getProduct(webstoreId, productId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia, excludeEntitlementDetails, excludePrimaryProductCategory)
API バージョン
49.0
ゲストユーザが使用可能
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductDetail getProduct(String webstoreId, String productId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia, Boolean excludeEntitlementDetails, Boolean excludePrimaryProductCategory)
パラメータ
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。 null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeEntitlementDetails
- 型: Boolean
- 商品のエンタイトルメントの詳細を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludePrimaryProductCategory
- 型: Boolean
- 商品のプライマリカテゴリパスを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
戻り値
使用方法
このメソッドではバイヤーの「商品を表示」��ンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。
getProduct(webstoreId, productId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia, excludeEntitlementDetails, excludePrimaryProductCategory, excludeVariationInfo, excludeAttributeSetInfo)
API バージョン
50.0
ゲストユーザが使用可能
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductDetail getProduct(String webstoreId, String productId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia, Boolean excludeEntitlementDetails, Boolean excludePrimaryProductCategory, Boolean excludeVariationInfo, Boolean excludeAttributeSetInfo)
パラメータ
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。 null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeEntitlementDetails
- 型: Boolean
- 商品のエンタイトルメントの詳細を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludePrimaryProductCategory
- 型: Boolean
- 商品のプライマリカテゴリパスを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeVariationInfo
- 型: Boolean
- 商品のバリエーション情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeAttributeSetInfo
- 型: Boolean
- 商品の属性セット情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
戻り値
使用方法
このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。
getProductCategory(webstoreId, productCategoryId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia)
API バージョン
49.0
ゲストユーザが使用可能
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductCategoryDetail getProductCategory(String webstoreId, String productCategoryId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia)
パラメータ
- webstoreId
- 型: String
- WebStore の ID。
- productCategoryId
- 型: String
- 商品カテゴリの ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。 null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。