Method: giftcardobject.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
فهرستی از تمام اشیاء کارت هدیه برای شناسه صادرکننده معین را برمی گرداند.
درخواست HTTP
GET https://walletobjects.googleapis.com/walletobjects/v1/giftCardObject
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
پارامترها |
---|
classId | string شناسه کلاسی که اشیاء آن لیست خواهد شد. |
token | string اگر maxResults مشخص شده باشد، برای دریافت مجموعه بعدی نتایج استفاده می شود، اما بیش از اشیاء maxResults در یک لیست موجود است. برای مثال، اگر لیستی از 200 شی دارید و لیست را با maxResults 20 میخوانید، لیست 20 شی اول و یک نشانه را برمیگرداند. لیست تماس دوباره با maxResults روی 20 و توکن برای دریافت 20 شی بعدی. |
maxResults | integer حداکثر تعداد نتایج برگردانده شده توسط یک لیست را مشخص می کند. اگر maxResults تعریف نشده باشد، همه نتایج برگردانده می شوند. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
فیلدها |
---|
resources[] | object ( GiftCardObject ) منابع مربوط به درخواست لیست. |
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\u003eThis endpoint retrieves all gift card objects for a specified issuer ID using a GET request.\u003c/p\u003e\n"],["\u003cp\u003eYou can use query parameters like \u003ccode\u003eclassId\u003c/code\u003e, \u003ccode\u003etoken\u003c/code\u003e, and \u003ccode\u003emaxResults\u003c/code\u003e to filter and paginate the results.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of gift card objects and pagination details in JSON format.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/wallet_object.issuer\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This describes retrieving a list of gift card objects. A `GET` request is sent to a specific URL, requiring an empty request body. The request can include optional query parameters: `classId` to filter by class, `token` for pagination, and `maxResults` to limit results. Successful responses contain a list of gift card `resources` and `pagination` information in JSON format. The operation requires the `https://www.googleapis.com/auth/wallet_object.issuer` authorization scope.\n"],null,["# Method: giftcardobject.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.GiftCardObjectListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nReturns a list of all gift card objects for a given issuer ID.\n\n### HTTP request\n\n`GET https://walletobjects.googleapis.com/walletobjects/v1/giftCardObject`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `classId` | `string` The ID of the class whose objects will be listed. |\n| `token` | `string` Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects. |\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/giftcardobject#GiftCardObject) } ], \"pagination\": { object (/wallet/reference/rest/v1/Pagination) } } ``` |\n\n| Fields ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `resources[]` | `object (`[GiftCardObject](/wallet/reference/rest/v1/giftcardobject#GiftCardObject)`)` 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`"]]