# 仮想アイテムのリストを取得

管理用のプロジェクト内の仮想アイテムリストを取得します。

注意このエンドポイントは、ストアカタログの構築に使用しないでください。

Endpoint: GET /v2/project/{project_id}/admin/items/virtual_items
Version: 2.0.0
Security: basicAuth

## Path parameters:

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

## Query parameters:

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

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

## Response 200 fields (application/json):

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

  - `total_items_count` (integer)
    システムでのアイテムの合計数。

  - `items` (array)

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

  - `items.attributes` (array)
    属性リスト。
    Example: [{"external_id":"attribute_external_id","name":{"en":"Attribute name","de":"Attributname"},"values":[{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]}]

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

  - `items.attributes.name` (object)
    属性用のローカライズされたオブジェクト。キーはISO 3166-1で指定されています。
    Example: {"en":"Attribute name","de":"Attributname"}

  - `items.attributes.values` (array, required)
    Example: [{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]

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

  - `items.attributes.values.value` (object, required)
    値名がローカライズされたオブジェクト。キーはISO 3166-1で指定されています。

  - `items.name` (object,null)
    アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、[ドキュメント](/ja/doc/shop-builder/references/supported-languages/)で確認できます。

  - `items.description` (object,null)
    アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、[ドキュメント](/ja/doc/shop-builder/references/supported-languages/)で確認できます。

  - `items.long_description` (object,null)
    アイテムの長文説明のローカライズを含むオブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のバリアント（例：enとen-US）が提供された場合、最後に提供された値が保存されます。サポートされている言語の完全なリストは、[ドキュメント](/ja/doc/shop-builder/references/supported-languages/)で確認できます。

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

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

  - `items.groups.name` (object)
    アイテム名。キーと値のペアを含める必要があり、
キーは "^[a-z]" 書式のロケール{2}で、値は文字列です。
    Example: {"en":"Horror","de":"Horror"}

  - `items.media_list` (array)
    スクリーンショット、ゲームプレイ動画などのアイテム追加アセット。

  - `items.media_list.type` (string)
    メディアタイプ：image/video。
    Enum: "image", "video"

  - `items.media_list.url` (string)
    リソースファイル。
    Example: "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"

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

  - `items.prices` (array)
    Example: [{"currency":"USD","amount":10.5,"is_default":true,"is_enabled":true}]

  - `items.prices.amount` (number, required)
    金額。
    Example: 10.5

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

  - `items.prices.country_iso` (string)
    [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従った2文字の大文字の国名コード。[エクソーラがサポートする国](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-countries/)の詳細情報については、ドキュメントを確認してください。例：country=US
    Example: "US"

  - `items.prices.is_default` (boolean)
    Example: true

  - `items.prices.is_enabled` (boolean)
    Example: true

  - `items.vc_prices` (array)
    Example: [{"sku":"com.xsolla.gold_1","amount":10,"is_default":true}]

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

  - `items.vc_prices.amount` (number, required)
    金額。
    Example: 10

  - `items.vc_prices.is_default` (boolean)
    Example: true

  - `items.image_url` (string)
    画像URL。決済UI上で画像を正しく表示し、高速に読み込ませるために、当社の画像およびURLガイドラインを確認ください：サポートされているフォーマット：WebP（推奨）、PNG、JPGファイルサイズ：50 KB以下（WebPの場合）または150 KB以下（PNGおよびJPGの場合）画像サイズ：280 × 280 pxカラースペース：sRGBプロトコル：バージョン管理されたURLに対する、長期キャッシュを伴うHTTPS

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

  - `items.is_paid_randomized_reward` (boolean)
    アイテムが、ルートボックスなどのランダムな有料報酬であるかどうか。

  - `items.order` (integer)
    カタログにおけるアイテムの表示順。この値が大きいほど、アイテムはリストの下位に配置されます。
値が同じ場合は作成日時順でソートされ、新しいアイテムほど上方に表示されます。

  - `items.is_enabled` (boolean)
    アイテムが利用可能かどうか。falseの場合、そのアイテムをストアで購入することや、バンドルの一部、またはマーケティングキャンペーン内で取得することはできません。アイテムの可用性に関する詳細な情報は、当社の[ドキュメント](https://developers.xsolla.com/ja/items-catalog/catalog-features/items-availability/)を参照してください。

  - `items.is_show_in_store` (boolean)
    アイテムをカタログに表示するかどうか。falseかつis_enabled: true の場合、そのアイテムはカタログ上には表示されませんが、バンドルの一部やマーケティングキャンペーン内での取得は可能です。アイテムの可用性に関する詳細な情報は、当社の[ドキュメント](https://developers.xsolla.com/ja/items-catalog/catalog-features/items-availability/)を参照してください。

  - `items.regions` (array)
    アイテムが利用可能な地域の配列。配列が空であるか、または渡されなかった場合、そのアイテムはすべての地域で利用可能です。

  - `items.regions.id` (integer)
    プロジェクト内のプ地域ID。

詳細な情報については、[地域の販売制限に関するドキュメント](https://developers.xsolla.com/ja/items-catalog/catalog-features/regional-restrictions/)および[地域管理用のAPIコール](https://developers.xsolla.com/ja/api/catalog/common-regions)を参照してください。
    Example: 1

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

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

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

  - `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)
    すべてのユーザーが購入できるアイテムの最大数。

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

  - `items.limits.per_item.reserved` (integer)

  - `items.limits.per_item.sold` (integer)

  - `items.limits.recurrent_schedule` (object,null)
    制限更新期間。

  - `items.limits.recurrent_schedule.per_user` (any)
    ユーザー制限更新期間。

  - `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オブジェクト。

## Response 401 fields (application/json):

  - `statusCode` (integer)
    Example: 401

  - `errorCode` (integer)
    Example: 1020

  - `errorMessage` (string)
    Example: "[0401-1020]: Error in Authentication method occurred"