Method: giftcardclass.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מחזירה רשימה של כל הסוגים של כרטיסי המתנה לפי מזהה מנפיק נתון.
בקשת HTTP
GET https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים |
issuerId |
string (int64 format)
המזהה של המנפיק המורשה לפרסם סיווגים.
|
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
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 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`"]]