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
ไม่บังคับ จำนวนงานสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากคุณไม่ระบุค่านี้ เซิร์ฟเวอร์จะกำหนดจำนวนผลลัพธ์ที่จะแสดง
|
pageToken |
string
ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการโทร tasks.list ครั้งก่อน คุณสามารถจัดเตรียมข้อมูลนี้เพื่อเรียกหน้าถัดไปได้ เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ tasks.list ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ
|
filter |
string
ไม่บังคับ คําค้นหาตัวกรองที่จะนำไปใช้เมื่อแสดงรายการ Tasks ดูตัวอย่างไวยากรณ์ตัวกรองได้ที่ http://aip.dev/160 หากคุณไม่ระบุค่าหรือกรองสตริงว่าง ระบบจะแสดงผล Tasks ทั้งหมด สำหรับข้อมูลเกี่ยวกับพร็อพเพอร์ตี้ของงานที่คุณกรองได้ โปรดดูแสดงรายการงาน
|
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
การตอบกลับ tasks.list ที่มีชุดงานที่ตรงกับเกณฑ์ตัวกรองใน ListTasksRequest
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
{
"tasks": [
{
object (Task)
}
],
"nextPageToken": string,
"totalSize": string
} |
| ช่อง |
tasks[] |
object (Task)
ชุดของงานที่ตรงกับเกณฑ์การกรองที่ขอ เมื่อไม่มีการระบุตัวกรอง คำขอจะแสดงผลงานทั้งหมด หรือเว้นว่างไว้ก็ได้ การตอบกลับที่ว่างเปล่าหมายความว่าไม่พบ Tasks ที่ตรงตามเกณฑ์ตัวกรองที่ขอ
|
nextPageToken |
string
ส่งโทเค็นนี้ใน ListTasksRequest เพื่อแสดงรายการผลลัพธ์ต่อไป หากมีการแสดงผลลัพธ์ทั้งหมด หมายความว่าช่องนี้จะเป็นสตริงว่างเปล่า หรือไม่แสดงในคำตอบ
|
totalSize |
string (int64 format)
จำนวนงานทั้งหมดที่ตรงกับเกณฑ์คำขอในทุกหน้า
|
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 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. |"]]
