Method: providers.tasks.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
指定されたフィルタ条件を満たすすべての Task
を取得します。
HTTP リクエスト
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
parent |
string
必須。providers/{provider} の形式で指定してください。provider は Google Cloud プロジェクト ID にする必要があります。例: sample-cloud-project
|
クエリ パラメータ
パラメータ |
header |
object (DeliveryRequestHeader )
省略可。標準の Delivery API リクエスト ヘッダー。
|
pageSize |
integer
省略可。返されるタスクの最大数。サービスが返す値はこれよりも少ないことがあります。この値を指定しない場合、返される結果の数はサーバーが決定します。
|
pageToken |
string
省略可。前回の tasks.list 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得できます。 ページ分割を行う場合、tasks.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
|
filter |
string
省略可。タスクを一覧表示するときに適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。値を指定しない場合、または空の文字列でフィルタする場合は、すべてのタスクが返されます。フィルタできるタスク プロパティについては、タスクの一覧表示をご覧ください。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
ListTasksRequest
のフィルタ条件を満たすタスクのセットを含む tasks.list
レスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
{
"tasks": [
{
object (Task )
}
],
"nextPageToken": string,
"totalSize": string
} |
フィールド |
tasks[] |
object (Task )
リクエストされたフィルタ条件を満たすタスクのセット。フィルタが指定されていない場合、リクエストはすべてのタスクを返します。成功のレスポンスは空にすることもできます。空のレスポンスは、リクエストされたフィルタ条件を満たすタスクが見つからなかったことを示します。
|
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. |"]]