Method: providers.tasks.batchCreate

新しい Task オブジェクトを作成して返します。

HTTP リクエスト

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks:batchCreate

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

パスパラメータ

パラメータ
parent

string

必須。すべてのタスクで共有される親リソース。この値は、providers/{provider} の形式にする必要があります。provider には、Google Cloud プロジェクト ID を指定する必要があります。例: sample-cloud-projectCreateTaskRequest メッセージの親フィールドは、空にするか、このフィールドと一致させる必要があります。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "header": {
    object (DeliveryRequestHeader)
  },
  "requests": [
    {
      object (CreateTaskRequest)
    }
  ]
}
フィールド
header

object (DeliveryRequestHeader)

(省略可)標準の Delivery API リクエスト ヘッダー。注: このフィールドを設定する場合、CreateTaskRequest メッセージのヘッダー フィールドは空にするか、このフィールドと一致する必要があります。

requests[]

object (CreateTaskRequest)

必須。作成するリソースを指定するリクエスト メッセージ。注: 1 つのバッチで作成できるタスクは最大 500 件です。

レスポンスの本文

BatchCreateTask レスポンス メッセージ。

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

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

object (Task)

作成されたタスク。

CreateTaskRequest

tasks.create リクエスト メッセージ。

JSON 表現
{
  "header": {
    object (DeliveryRequestHeader)
  },
  "parent": string,
  "taskId": string,
  "task": {
    object (Task)
  }
}
フィールド
header

object (DeliveryRequestHeader)

(省略可)標準の Delivery API リクエスト ヘッダー。

parent

string

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

taskId

string

必須。タスク ID は一意である必要がありますが、配送追跡 ID は使用できません。配送追跡 ID を保存するには、trackingId フィールドを使用します。複数のタスクに同じ trackingId を指定できます。タスク ID には次の制限があります。

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

object (Task)

必須。作成するタスク エンティティ。タスクを作成する場合、以下のフィールドが必要です。

  • type
  • stateOPEN に設定する必要があります)
  • trackingIdUNAVAILABLE タスクまたは SCHEDULED_STOP タスクでは設定できませんが、他のすべてのタスクタイプでは必須)
  • plannedLocationUNAVAILABLE タスクの場合は省略可)
  • taskDuration

注: タスクの name フィールドは無視されます。それ以外の Task フィールドは設定しないでください。設定しないとエラーが返されます。