# 仮想通貨リストを取得する

カタログ構築のために、仮想通貨のリストを取得します。

注意すべてのプロジェクトには、応答で得られるアイテムの数に制限があります。初期値および最大値は、1応答50アイテムです。ページごとに多くのデータを取得するには、制限とオフセットフィールドを使用します。  注意事項アイテムカタログAPIコールの利用は、認証なしで可能ですが、パーソナライズされたカタログを取得するには、「認証」ヘッダーにユーザーのJWTを渡す必要があります。

Endpoint: GET /v2/project/{project_id}/items/virtual_currency
Version: 2.0.0
Security: XsollaLoginUserJWT

## Path parameters:

  - `project_id` (integer, required)
    プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。
    Example: 44056

## Query parameters:

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

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

  - `locale` (string)
    応答言語。ISO 639-1に基づく小文字の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)
    ページ数がもっとあることを示す指標として使用されます。
    Example: true

  - `items` (array)

  - `items.attributes` (array)
    アイテムに対応する属性と値のリスト。カタログのフィルタリングに使用できます。
    Example: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}

  - `items.attributes.external_id` (string)
    一意の属性ID。external_idには、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。
    Example: "attribute_1"

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

  - `items.attributes.values` (array)

  - `items.attributes.values.external_id` (string)
    属性の一意の値ID。external_idには、英小文字、ダッシュ、およびアンダースコアのみが含まれます。
    Example: "attribute_value"

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

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

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

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

  - `items.groups` (array)
    アイテムが所属するグループ。
    Example: [{"external_id":"exclusive","name":"Exclusive"}]

  - `items.groups.external_id` (string)
    このグループの一意の識別子。通常、APIリクエストや外部システムでの参照に使用されます。
    Example: "exclusive"

  - `items.groups.item_order_in_group` (integer)
    グループ内でのアイテムの位置。表示順を決定するために使用されます。
このフィールドは、additional_fields[]クエリパラメータでリクエストされた場合にのみ、応答に含まれます。
    Example: 1

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

  - `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)
    trueの場合で、アイテムは無料です。

  - `items.item_id` (integer)

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

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

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

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

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

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

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

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

制限のリセットが設定されていない場合、limit_exceeded_visibilityの値に関わらず、購入制限に達した後のアイテムはカタログに表示されません。
    Enum: "show", "hide"

  - `items.limits.per_user.recurrent_schedule` (object)
    ユーザーのアイテム制限の定期更新期間。

  - `items.limits.per_user.recurrent_schedule.interval_type` (string)
    定期更新期間のタイプ。
    Enum: "daily", "weekly", "monthly", "hourly"

  - `items.limits.per_user.recurrent_schedule.reset_next_date` (integer)
    制限がリセットされた日時（UNIXタイムスタンプ）。
    Example: 1677553200

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

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

  - `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.price` (object,null)
    アイテム価格。

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

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

  - `items.price.currency` (string)
    商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。
    Example: "USD"

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

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

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

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

  - `items.promotions.bonus` (array)

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

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

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

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

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

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

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

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

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

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

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

  - `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.promotions.name` (string)

  - `items.sku` (string)
    一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
    Example: "big_rocket"

  - `items.type` (string)
    アイテムタイプ：virtual_good/virtual_currency/bundle。
    Example: "virtual_currency"

  - `items.virtual_prices` (array)
    仮想価格。
    Example: [{"amount":100,"amount_without_discount":100,"image_url":"http://image.png","is_default":true,"sku":"com.xsolla.crystals_1"}]

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

  - `items.virtual_prices.description` (string)
    仮想通貨の説明。
    Example: "Crystals - description"

  - `items.virtual_prices.image_url` (string)
    仮想通貨のイメージ。
    Example: "http://image.png"

  - `items.virtual_prices.is_default` (boolean)
    アイテムの価格をデフォルトにするかどうか。
    Example: true

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

  - `items.virtual_prices.sku` (string)
    仮想通貨アイテムSKU。
    Example: "com.xsolla.vc_1"

  - `items.virtual_prices.type` (string)
    仮想通貨のタイプ。
    Example: "virtual_currency"

  - `items.vp_rewards` (array)