Xsolla-logo

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

get/v2/project/{project_id}/items/virtual_items/group/{external_id}

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

注意

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



このエンドポイントは認証なしでアクセスでき、一般的なデータを返します。しかし、認証は、利用可能なユーザー制限やプロモーションのような、パーソナライズされた結果のためのユーザー固有の詳細で応答の質を高めます。
SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

プロジェクトID。このパラメータは、ドメインページのプロジェクト名の横にあります。

Example: 44056
external_id
required
string
Default: "all"

グループexternal ID。

query Parameters
limit
integer

ページでの要素数の制限。

Example: limit=50
offset
integer

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

Example: offset=0
locale
string
Default: "en"

応答言語。ISO 639-1に基づく小文字の2文字言語コード。

additional_fields[]
Array of strings

追加フィールドのリスト。これらのフィールドは、リクエストの中で送信すると、応答に含まれます。

Items Enum: "media_list" "order" "long_description" "custom_attributes"
country
string

ISO 3166-1 alpha-2に基づく大文字の2文字国名コード。アイテム作成時に地域別の価格と制限を指定した場合、そのカタログの価格と制限を表示します。

注意

国を明示的に指定しない場合、ユーザーのIPアドレスに基づいて設定されます。

Example: country=US
promo_code
string [ 1 .. 128 ] characters

大文字と小文字を区別する一意のコードです。文字と数字が含まれます。

Example: promo_code=WINTER2021
show_inactive_time_limited_items
integer
Default: 0

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

Example: show_inactive_time_limited_items=1
Responses
200

指定されたグループのリストは正常に受信されました。

404

グループが見つかりませんでした。external_idが正しく、グループがオフになったり削除されたりしていないことを確認してください。

Request samples
Response samples
application/json
{
  • "has_more": false,
  • "items": [
    ]
}