# 获取虚拟货币列表

获取用于构建目录的虚拟货币列表。

注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。

Endpoint: GET /v2/project/{project_id}/items/virtual_currency
Version: 1.0.0
Security: AuthForClient

## Path parameters:

  - `project_id` (integer, required)
    项目ID。
    Example: 44056

## Query parameters:

  - `limit` (integer)
    页面上元素数量的限制。
    Example: 50

  - `offset` (integer)
    元素编号，从该元素开始生成列表（从0开始数）。

  - `locale` (string)
    响应语言。符合ISO 639-1标准的两个小写字母的语言代码。

  - `additional_fields[]` (array)
    附加字段列表。如果在请求中发送这些字段，则它们将包含在响应中。可用字段media_list、order、long_description。

  - `country` (string)
    对于该目录要计算区域价格和限制的国家/地区。符合ISO 3166-1 alpha-2的两个大写字母的国家/地区代码。如果未明确指定国家/地区，则将根据用户的IP地址进行计算。

## Response 200 fields (application/json):

  - `items` (array)
    Example: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"description":"Big Rocket - short description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_currency","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"1"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"description":"description","groups":[{"external_id":"hair","name":"Hair"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_currency","virtual_prices":[]},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider_2","type":"virtual_currency","virtual_prices":[]}]

  - `items.attributes` (array)
    游戏对应的属性及属性值列表。

注意：这部分响应仅在您发送additional_fields[]=attributes查询参数时可用。

  - `items.attributes.external_id` (string)
    唯一属性ID。 external_id只能包含小写英文字母和数字字符、破折号和下划线。
    Example: "attribute_1"

  - `items.attributes.name` (string)
    属性名称。
    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.description` (string)
    商品描述。
    Example: "Big Rocket - description"

  - `items.groups` (array)
    商品所属分组。
    Example: [{"external_id":"accessory","name":"Accessory"}]

  - `items.groups.external_id` (string)
    Example: "accessory"

  - `items.groups.name` (string)
    Example: "Accessory"

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

  - `items.inventory_options` (object)
    定义物品库商品选项。

  - `items.inventory_options.consumable` (object,null)
    如果为消耗品，则定义消耗品属性；如果为非消耗品，则为null。

  - `items.inventory_options.consumable.usages_count` (integer,null)
    如果为消耗品，则为总剩余使用次数；如果为非消耗品，则为null。
    Example: 1

  - `items.inventory_options.expiration_period` (object,null)
    如果为到期商品，则定义到期属性；如果为非到期商品，则为null。

  - `items.inventory_options.expiration_period.type` (string)
    定义商品到期类型。
    Enum: "minute", "hour", "day", "week", "month", "year"

  - `items.inventory_options.expiration_period.value` (integer)
    定义有效期的值。
    Example: 1

  - `items.is_free` (string)
    如果为true，则该商品为免费。
    Example: "false"

  - `items.name` (string)
    商品名称。
    Example: "Big Rocket"

  - `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)的三字母代码。
    Example: "USD"

  - `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":"shotgun_raider"}]

  - `items.virtual_prices.amount` (integer)
    折扣后的商品虚拟货币价格。
    Example: 100

  - `items.virtual_prices.amount_without_discount` (integer)
    商品价格。
    Example: 200

  - `items.virtual_prices.description` (string)
    虚拟货币说明。
    Example: "Big Rocket - 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: "SHOTGUN FOR TRUE RAIDERS"

  - `items.virtual_prices.sku` (string)
    虚拟货币商品SKU。
    Example: "vc_test"

  - `items.virtual_prices.type` (string)
    虚拟货币类型。
    Example: "virtual_currency"