Method: giftcardobject.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מחזירה רשימה של כל האובייקטים של כרטיס המתנה לפי מזהה מנפיק נתון.
בקשת HTTP
GET https://walletobjects.googleapis.com/walletobjects/v1/giftCardObject
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים |
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 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\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`"]]