Method: providers.tasks.search

非推奨: 代わりに taskTrackingInfo.get を使用してください。

HTTP リクエスト

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks:search

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。providers/{provider} の形式で指定してください。プロバイダには Google Cloud プロジェクト ID を指定する必要があります。例: sample-cloud-project

クエリ パラメータ

パラメータ
header

object (DeliveryRequestHeader)

（省略可）標準の Delivery API リクエスト ヘッダー。
trackingId

string

必須。リクエストされている関連するタスクのセットの識別子。トラッキング ID には次の制限があります。

  • 有効な Unicode 文字列を指定してください。
  • 最大文字数は 64 文字です。
  • Unicode 正規化フォーム C に従って正規化されています。
  • ASCII 文字「/」、「:」、「?」、「,」、「#」を含めることはできません。
pageSize

integer

（省略可）返されるタスクの最大数。サービスはこの値より少ない値を返すことがあります。この値を指定しない場合は、サーバーが返す結果の数が決まります。
pageToken

string

（省略可）前回の tasks.search 呼び出しから受け取ったページトークン。後続のページを取得するには、この値を指定する必要があります。

ページ分割を行う場合、tasks.search に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

tasks.search レスポンス。これには、SearchTasksRequest の検索条件を満たす一連のタスクが含まれます。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string
}
フィールド
tasks[]

object (Task)

リクエストされた trackingId に対するタスクのセット。成功のレスポンスは空にすることもできます。空のレスポンスは、指定された trackingId に関連付けられたタスクがないことを示します。
nextPageToken

string

結果の一覧表示を続けるには、このトークンを SearchTasksRequest に渡します。すべての結果が返された場合、このフィールドは空の文字列であるか、レスポンスに含まれません。