Method: giftcardclass.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
指定された発行者 ID のすべてのギフトカード クラスのリストを返します。
HTTP リクエスト
GET https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ |
issuerId |
string (int64 format)
クラスを一覧表示する権限を持つ発行者の ID。
|
token |
string
maxResults が指定されていて、リスト内に maxResults 個を超えるクラスがある場合に、次の結果セットを取得するために使用されます。たとえば、200 個のクラスを含むリストがあり、maxResults を 20 に設定してリストを呼び出すと、最初の 20 個のクラスとトークンが返されます。次の 20 個のクラスを取得するには、maxResults を 20 に設定したトークンを使用してリストを再度呼び出します。
|
maxResults |
integer
リストから返される結果の最大数を指定します。maxResults が定義されていない場合は、すべての結果が返されます。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
フィールド |
resources[] |
object (GiftCardClass )
一覧表示リクエストに対応するリソース。
|
pagination |
object (Pagination )
レスポンスのページ分け。
|
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/wallet_object.issuer
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eRetrieves a list of all gift card classes for a specified issuer ID using a GET request.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination to handle large result sets using \u003ccode\u003etoken\u003c/code\u003e and \u003ccode\u003emaxResults\u003c/code\u003e query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of \u003ccode\u003eGiftCardClass\u003c/code\u003e objects and pagination details.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/wallet_object.issuer\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This endpoint retrieves gift card class lists for a specific issuer ID using a `GET` request to `https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass`. Required query parameters include the `issuerId` and optional ones like `token` and `maxResults` for pagination. The request body must be empty. A successful response includes a JSON body with a list of `GiftCardClass` resources and pagination details. The `https://www.googleapis.com/auth/wallet_object.issuer` authorization scope is needed.\n"],null,["# Method: giftcardclass.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.GiftCardClassListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nReturns a list of all gift card classes for a given issuer ID.\n\n### HTTP request\n\n`GET https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `issuerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the issuer authorized to list classes. |\n| `token` | `string` Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes. |\n| `maxResults` | `integer` Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"resources\": [ { object (/wallet/reference/rest/v1/giftcardclass#GiftCardClass) } ], \"pagination\": { object (/wallet/reference/rest/v1/Pagination) } } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `resources[]` | `object (`[GiftCardClass](/wallet/reference/rest/v1/giftcardclass#GiftCardClass)`)` Resources corresponding to the list request. |\n| `pagination` | `object (`[Pagination](/wallet/reference/rest/v1/Pagination)`)` Pagination of the response. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/wallet_object.issuer`"]]