# 指定されたグループによるアイテムリストを取得

カタログを作成するために、指定されたグループからアイテムリストを取得します。


  注意
    すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。





  注意
    認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。

Endpoint: GET /v2/project/{project_id}/items/virtual_items/group/{external_id}
Version: 2.0.0
Security: XsollaLoginUserJWT

## Path parameters:

  - `project_id` (integer, required)
    プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横、またはプロジェクトの作業中にブラウザのアドレスバーで確認できます。URLの形式は以下の通りです：https://publisher.xsolla.com//projects/。
    Example: 44056

  - `external_id` (string, required)
    作成時に指定された外部アイテムグループID 。
    Example: "weapons"

## Query parameters:

  - `limit` (integer)
    ページでの要素数の制限。
    Example: 50

  - `offset` (integer)
    リストが生成される要素番号（カウントは0から始まります）。

  - `locale` (string)
    応答言語。ISO 639-1に準拠した2文字の小文字の言語コード（例：en）。nameやdescriptionなどのローカリゼーションフィールドでは5文字のロケールコード（例：en-US）がサポートされていますが、応答内では2文字のコードに正規化されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

  - `additional_fields[]` (array)
    応答に含める追加フィールド。デフォルトでは、これらのフィールドは返されません。追加フィールドを含めるには、必須の値を渡してください。
    Enum: "media_list", "order", "long_description", "custom_attributes", "item_order_in_group"

  - `country` (string)
    ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。エクソーラがサポートする国と国を決定するプロセスに関する詳細情報については、ドキュメントを確認してください。
    Example: "US"

  - `promo_code` (string)
    大文字と小文字を区別する一意のコードです。文字と数字が含まれます。
    Example: "WINTER2021"

  - `show_inactive_time_limited_items` (integer)
    ユーザーに利用可能でない、期限付きアイテムを表示します。このようなアイテムの有効期間はまだ開始されていないか、すでに期限切れです。
    Example: 1

## Response 200 fields (application/json):

  - `has_more` (boolean)
    ページ数がもっとあることを示す指標として使用されます。

  - `items` (array)
    Example: [{"sku":"com.xsolla.big_rocket_1","name":"Big Rocket","groups":[{"external_id":"weapons","name":"weapons"}],"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"type":"virtual_good","description":"Big Rocket - description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"virtual_prices":[{"amount":100,"sku":"com.xsolla.vc_1","is_default":true,"amount_without_discount":100,"image_url":"http://image.png","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","description":"description"}],"can_be_bought":true,"virtual_item_type":"non_renewing_subscription","promotions":[{"name":"Bonus promotion","date_start":"2020-04-15T16:16:00+03:00","date_end":"2026-04-15T16:16:00+03:00","discount":{"percent":"50.00"},"bonus":[{"quantity":1,"name":"Xsolla Minigun","image_url":"https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png","sku":"com.xsolla.minigun_1","type":"virtual_good"}]}],"limits":{"per_user":{"total":5,"available":3,"recurrent_schedule":{"interval_type":"weekly","reset_next_date":1746057600},"limit_exceeded_visibility":"show"},"per_item":null},"periods":[{"date_from":"2020-08-11T10:00:00+03:00","date_until":"2020-08-11T20:00:00+03:00"}]},{"sku":"com.xsolla.shotgun_raider","name":"SHOTGUN FOR TRUE RAIDERS","groups":[{"external_id":"weapons","name":{"en":"weapons"}}],"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"type":"virtual_good","description":"description","image_url":"http://image.png","is_free":false,"price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"virtual_prices":[{"amount":100,"sku":"com.xsolla.vc_1","is_default":true,"amount_without_discount":100,"image_url":"http://image.png","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","description":"description"},{"amount":200,"sku":"com.xsolla.vc_2","is_default":false,"amount_without_discount":200,"image_url":"http://image.png","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","description":"description"}],"can_be_bought":true,"virtual_item_type":"non_renewing_subscription","promotions":[],"limits":null,"periods":[]}]

  - `items.sku` (string)
    一意のアイテムID。SKUには、英大文字、英小文字、数字、ピリオド、ダッシュ、アンダースコアのみを含めることができます。
    Example: "com.xsolla.big_rocket_1"

  - `items.name` (string)
    アイテム名。
    Example: "Big Rocket"

  - `items.groups` (array)
    アイテムが所属するグループ。

  - `items.groups.external_id` (string)
    作成時に指定された[外部アイテムグループID](/ja/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id) 。
    Example: "exclusive"

  - `items.groups.name` (string)
    グループ名。
    Example: "Exclusive"

  - `items.groups.item_order_in_group` (integer)
    グループ内でのアイテムの配置位置は 表示順序を決定します。
additional_fields[]クエリパラメータを介してリクエストされた場合にのみ返されます。
    Example: 1

  - `items.attributes` (array)
    アイテムに対応する属性と値のリスト。カタログのフィルタリングに使用できます。

  - `items.attributes.external_id` (string)
    一意の属性ID。external_idには、英大文字、英小文字、数字、ダッシュ、アンダースコアのみを含めることができます。

  - `items.attributes.name` (object)
    属性名。
    Example: "Genre"

  - `items.attributes.values` (array)

  - `items.attributes.values.external_id` (string)
    属性の一意の値ID。external_idには、英小文字、数字、ダッシュ、アンダースコアのみを含めることができます。

  - `items.attributes.values.value` (string)
    属性値。
    Example: "Strategy"

  - `items.type` (string)
    アイテムタイプ：consumable/expiration/permanent/lootboxes/physical。
    Example: "virtual_good"

  - `items.description` (string)
    アイテムの説明。
    Example: "Big Rocket - description"

  - `items.image_url` (string)
    画像URL。
    Example: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"

  - `items.is_free` (boolean)
    アイテムが無料かどうか。

  - `items.price` (object)
    アイテム価格。

  - `items.price.amount` (string)
    割引後のアイテム価格。
    Example: "100.99"

  - `items.price.amount_without_discount` (string)
    アイテム価格。
    Example: "100.99"

  - `items.price.currency` (string)
    商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。
    Example: "USD"

  - `items.virtual_prices` (array)
    仮想価格。

  - `items.virtual_prices.amount` (integer)
    仮想通貨建てのアイテム価格。
    Example: 100

  - `items.virtual_prices.amount_without_discount` (integer)
    割引適用前の仮想通貨建てのアイテム価格。仮想通貨の価格には割引が適用されないため、常にamountと等しくなります。
    Example: 200

  - `items.virtual_prices.sku` (string)
    仮想通貨SKU。
    Example: "vc_gold"

  - `items.virtual_prices.is_default` (boolean)
    仮想通貨でのデフォルト価格であるかどうか。
    Example: true

  - `items.virtual_prices.image_url` (string,null)
    仮想通貨の画像URL。
    Example: "http://image.png"

  - `items.virtual_prices.name` (string)
    仮想通貨名。
    Example: "Gold"

  - `items.virtual_prices.type` (string)
    アイテムタイプ。仮想通貨の場合はvirtual_currencyになります。
    Example: "virtual_currency"

  - `items.virtual_prices.description` (string,null)
    仮想通貨の説明。
    Example: "In-game currency used to purchase weapons and upgrades"

  - `items.can_be_bought` (boolean)
    trueの場合、ユーザーはアイテムを購入することができます。

  - `items.virtual_item_type` (string)
    仮想アイテムタイプ。

指定可能な値：
- consumable — 使用後にインベントリから消滅するアイテム（例：弾薬など）。
- non_consumable — 期間の制限なくインベントリに残り続けるアイテム。
- non_renewing_subscription — 制限された期間内に限り、サービスやコンテンツへのアクセス権を付与する期間限定アイテム。
    Enum: "consumable", "non_consumable", "non_renewing_subscription"

  - `items.promotions` (array)
    カート内の特定アイテムに適用されるプロモーション。この配列は、以下のケースで返されます：

* 特定のアイテムに対して、割引キャンペーンが構成されている場合。

* 選択されたアイテムの割引設定を持つプロモーションコードが適用された場合。

アイテムレベルのプロモーションが適用されない場合は、空の配列が返されます。

  - `items.promotions.name` (string)

  - `items.promotions.date_start` (string,null)

  - `items.promotions.date_end` (string,null)

  - `items.promotions.discount` (object,null)

  - `items.promotions.discount.percent` (string,null)

  - `items.promotions.discount.value` (string,null)

  - `items.promotions.bonus` (array)

  - `items.promotions.bonus.sku` (string)

  - `items.promotions.bonus.quantity` (integer)

  - `items.promotions.bonus.type` (string)
    ボーナスアイテムタイプ。
    Enum: "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft"

  - `items.promotions.bonus.name` (string)
    ボーナスアイテムの名前です。ボーナスアイテムのタイプphysical_goodでは使用できません。

  - `items.promotions.bonus.image_url` (string)
    ボーナスアイテムの画像URLです。ボーナスアイテムのタイプphysical_goodでは使用できません。

  - `items.promotions.bonus.bundle_type` (string)
    ボーナスバンドルアイテムタイプ。ボーナスアイテムタイプbundleのみで利用可能です。
    Enum: "standard", "virtual_currency_package"

  - `items.promotions.limits` (object)

  - `items.promotions.limits.per_user` (object)

  - `items.promotions.limits.per_user.available` (integer)

  - `items.promotions.limits.per_user.total` (integer)

  - `items.limits` (object,null)
    アイテム制限。

  - `items.limits.per_user` (object,null)
    ユーザーのアイテム制限。

  - `items.limits.per_user.total` (integer)
    1ユーザーあたりのユーザーが購入できるアイテムの最大数。
    Example: 5

  - `items.limits.per_user.available` (integer)
    現在のユーザーが購入できるアイテムの残り数。
    Example: 3

  - `items.limits.per_user.recurrent_schedule` (any)

  - `items.limits.per_user.limit_exceeded_visibility` (string)
    購入制限に達してから次回の制限リセットまでの間、カタログ内でのアイテムの表示・非表示を決定します。

これは、recurrent_schedule配列で定期的な制限リセットが設定されているアイテムに適用されます。

購入制限のリセットが設定されていない場合、購入制限に達した後は、limit_exceeded_visibilityの値に関わらず、そのアイテムはカタログに表示されなくなります。

指定可能な値：
- show — 購入制限に達した後も、カタログ取得用のAPIコールに対してアイテム情報が返却されます。クライアント側のカタログ取得APIコールにおいては、制限に達した時点でアイテムにcan_be_bought: falseフラグが付与されて返されます。次回のリセット日時はreset_next_dateに格納されて返却されます。
- hide — 購入制限に達した時点から、制限値がリセットされるまでの間、カタログ取得用のAPIコールにおいてアイテムは返されなくなります。
    Enum: "show", "hide"

  - `items.limits.per_item` (object,null)
    アイテムのアイテム制限。

  - `items.limits.per_item.total` (integer)
    すべてのユーザーが購入できるアイテムの最大数。
    Example: 5

  - `items.limits.per_item.available` (integer)
    すべてのユーザーが購入できるアイテムの残り数。
    Example: 3

  - `items.periods` (array)
    アイテム販売期間。

  - `items.periods.date_from` (string,null)
    指定されたアイテムの販売開始日。
    Example: "2020-08-11T10:00:00+03:00"

  - `items.periods.date_until` (string,null)
    指定されたアイテムが販売できなくなる日付。nullを指定することもできます。
    Example: "2020-08-11T20:00:00+03:00"

  - `items.custom_attributes` (object)
    アイテムの属性と値を含むJSONオブジェクト。

  - `items.vp_rewards` (array)
    アイテムのバリューポイント報酬のリスト。

  - `items.vp_rewards.item_id` (integer)
    内部の一意のアイテムID。

  - `items.vp_rewards.sku` (string)
    一意のバリューポイントID。

  - `items.vp_rewards.amount` (integer)
    バリューポイントの量。

  - `items.vp_rewards.name` (string)
    バリューポイント名。

  - `items.vp_rewards.image_url` (string)
    画像URL。

  - `items.vp_rewards.is_clan` (boolean)
    バリューポイントがクランリワードチェーンで使用されるかどうか。

  - `items.loyalty_rewards` (array)
    アイテムを購入した際の報酬としてユーザーが付与されるロイヤルティポイント。

  - `items.loyalty_rewards.name` (string)
    ロイヤリティポイント名。

  - `items.loyalty_rewards.sku` (string)
    ロイヤルティポイントのSKUです。ロイヤルティポイントで支払う注文を作成する場合など、他のAPIコールのloyalty_point_skuパラメータにこの値を渡してください。

  - `items.loyalty_rewards.description` (string)
    ロイヤルティポイントの説明。

  - `items.loyalty_rewards.image_url` (string,null)
    画像URL。

  - `items.loyalty_rewards.amount` (integer)
    アイテムを購入した際にユーザーが付与されるロイヤルティポイントの数。

  - `items.loyalty_prices` (array)
    アイテムの購入に使用できるロイヤルティポイント。

  - `items.loyalty_prices.name` (string)
    ロイヤリティポイント名。

  - `items.loyalty_prices.sku` (string)
    ロイヤルティポイントのSKUです。ロイヤルティポイントで支払う注文を作成する場合など、他のAPIコールのloyalty_point_skuパラメータにこの値を渡してください。

  - `items.loyalty_prices.description` (string)
    ロイヤルティポイントの説明。

  - `items.loyalty_prices.image_url` (string,null)
    画像URL。

  - `items.loyalty_prices.amount` (integer)
    指定されたロイヤルティポイントでのアイテム価格。

## Response 404 fields (application/json):

  - `statusCode` (integer)
    HTTPレスポンスステータスコード。
    Example: 404

  - `errorCode` (integer)
    エクソーラエラーコード
    Example: 4403

  - `errorMessage` (string)
    エラーの簡潔な説明。
    Example: "[0401-4403]: Item group not found"


