Method: providers.tasks.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הפונקציה מקבלת את כל הפריטים מסוג 'Task' שעומדים בקריטריונים לסינון שצוינו.
בקשת HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
| פרמטרים |
parent |
string
חובה. חייב להיות בפורמט providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.
|
פרמטרים של שאילתה
| פרמטרים |
header |
object (DeliveryRequestHeader)
זה שינוי אופציונלי. כותרת הבקשה הרגילה של Delivery API.
|
pageSize |
integer
זה שינוי אופציונלי. המספר המקסימלי של Tasks שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. אם לא מציינים את הערך הזה, השרת קובע את מספר התוצאות שיוחזרו.
|
pageToken |
string
זה שינוי אופציונלי. אסימון דף שהתקבל משיחת tasks.list קודמת. ניתן לספק זאת כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל-tasks.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.
|
filter |
string
זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשמציגים רשימה של Tasks. בכתובת http://aip.dev/160 תוכלו לראות דוגמאות לתחביר של מסננים. אם לא תציינו ערך, או אם בחרתם לסנן לפי מחרוזת ריקה, כל המשימות יוחזרו. מידע נוסף על המאפיינים של משימות שאפשר לסנן לפיהם מופיע במאמר הצגת רשימת המשימות.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התשובה tasks.list שמכילה את קבוצת המשימות שעומדות בקריטריוני הסינון של ListTasksRequest.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג JSON |
{
"tasks": [
{
object (Task)
}
],
"nextPageToken": string,
"totalSize": string
} |
| שדות |
tasks[] |
object (Task)
קבוצת המשימות שעומדות בקריטריונים לסינון הנדרשים. אם לא מוגדר מסנן, הבקשה מחזירה את כל המשימות. תגובה מוצלחת יכולה גם להיות ריקה. תגובה ריקה מציינת שלא נמצאו משימות שתואמות לקריטריוני הסינון המבוקשים.
|
nextPageToken |
string
צריך להעביר את האסימון הזה ב-ListTasksRequest כדי להמשיך להצגת התוצאות. אם כל התוצאות הוחזרו, השדה הזה הוא מחרוזת ריקה או שהוא לא מופיע בתשובה.
|
totalSize |
string (int64 format)
המספר הכולל של משימות שתואמות לקריטריוני הבקשה, בכל הדפים.
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-31 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-31 (שעון UTC)."],[[["\u003cp\u003eRetrieves all \u003ccode\u003eTask\u003c/code\u003es that meet specified filtering criteria using a \u003ccode\u003eGET\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by various parameters such as \u003ccode\u003eheader\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty, with response containing a list of \u003ccode\u003eTask\u003c/code\u003e objects, \u003ccode\u003enextPageToken\u003c/code\u003e, and \u003ccode\u003etotalSize\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUses gRPC Transcoding syntax for the request URL, with \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the provider.\u003c/p\u003e\n"],["\u003cp\u003eIf successful, response includes an array of \u003ccode\u003eTask\u003c/code\u003e objects matching the filter, potentially empty if no tasks match.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of `Task` resources using a `GET` request to the Fleet Engine API. The request URL requires a `parent` path parameter specifying the provider. Optional query parameters include `header`, `pageSize`, `pageToken`, and `filter` to refine the results. The request body must be empty. A successful response contains an array of `Task` objects, a `nextPageToken` for pagination, and `totalSize` indicating the total number of tasks.\n"],null,["# Method: providers.tasks.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListTasksResponse.SCHEMA_REPRESENTATION)\n\nGets all `Task`s that meet the specified filtering criteria.\n\n### HTTP request\n\n`GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Must be in the format `providers/{provider}`. The `provider` must be the Google Cloud Project ID. For example, `sample-cloud-project`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `header` | `object (`[DeliveryRequestHeader](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader)`)` Optional. The standard Delivery API request header. |\n| `pageSize` | `integer` Optional. The maximum number of Tasks to return. The service may return fewer than this value. If you don't specify this value, then the server determines the number of results to return. |\n| `pageToken` | `string` Optional. A page token received from a previous `tasks.list` call. You can provide this to retrieve the subsequent page. When paginating, all other parameters provided to `tasks.list` must match the call that provided the page token. |\n| `filter` | `string` Optional. A filter query to apply when listing Tasks. See \u003chttp://aip.dev/160\u003e for examples of filter syntax. If you don't specify a value, or if you filter on an empty string, then all Tasks are returned. For information about the Task properties that you can filter on, see [List tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/journeys/tasks/find-tasks#filter_listed_tasks). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe `tasks.list` response that contains the set of Tasks that meet the filter criteria in the `ListTasksRequest`.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"tasks\": [ { object (/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks#Task) } ], \"nextPageToken\": string, \"totalSize\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `tasks[]` | `object (`[Task](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks#Task)`)` The set of Tasks that meet the requested filtering criteria. When no filter is specified, the request returns all tasks. A successful response can also be empty. An empty response indicates that no Tasks were found meeting the requested filter criteria. |\n| `nextPageToken` | `string` Pass this token in the `ListTasksRequest` to continue to list results. If all results have been returned, then this field is either an empty string, or it doesn't appear in the response. |\n| `totalSize` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The total number of Tasks that match the request criteria, across all pages. |"]]
