Method: giftcardclass.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
فهرستی از تمام کلاسهای کارت هدیه برای شناسه صادرکننده معین را برمیگرداند.
درخواست HTTP
GET https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
پارامترها |
---|
issuerId | string ( int64 format) شناسه صادرکننده مجاز برای فهرست کردن طبقات. |
token | string اگر maxResults مشخص شده باشد، برای دریافت مجموعه بعدی نتایج استفاده میشود، اما بیش از کلاسهای maxResults در یک لیست موجود است. به عنوان مثال، اگر لیستی از 200 کلاس دارید و لیست را با maxResults 20 فراخوانی می کنید، لیست 20 کلاس اول و یک توکن را برمی گرداند. لیست تماس دوباره با maxResults روی 20 تنظیم شده و توکن برای دریافت 20 کلاس بعدی. |
maxResults | integer حداکثر تعداد نتایج برگردانده شده توسط یک لیست را مشخص می کند. اگر maxResults تعریف نشده باشد، همه نتایج برگردانده می شوند. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
فیلدها |
---|
resources[] | object ( GiftCardClass ) منابع مربوط به درخواست لیست. |
pagination | object ( Pagination ) صفحه بندی پاسخ. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/wallet_object.issuer
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\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`"]]