Method: providers.tasks.batchCreate
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Crée et affiche un lot d'objets Task
.
Requête HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks:batchCreate
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres |
parent |
string
Obligatoire. Ressource parente partagée par toutes les tâches. Cette valeur doit être au format providers/{provider} . provider doit être l'ID du projet Google Cloud. Par exemple, sample-cloud-project . Le champ parent des messages CreateTaskRequest doit être vide ou correspondre à ce champ.
|
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Champs |
header |
object (DeliveryRequestHeader )
Facultatif. En-tête de requête standard de l'API Delivery. Remarque: Si vous définissez ce champ, le champ d'en-tête des messages CreateTaskRequest doit être vide ou correspondre à ce champ.
|
requests[] |
object (CreateTaskRequest )
Obligatoire. Message de requête spécifiant les ressources à créer. Remarque: Vous ne pouvez créer qu'un maximum de 500 tâches par lot.
|
Corps de la réponse
Message de réponse BatchCreateTask
.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
{
"tasks": [
{
object (Task )
}
]
} |
Champs |
tasks[] |
object (Task )
Les tâches créées.
|
CreateTaskRequest
Message de requête tasks.create
.
Représentation JSON |
{
"header": {
object (DeliveryRequestHeader )
},
"parent": string,
"taskId": string,
"task": {
object (Task )
}
} |
Champs |
parent |
string
Obligatoire. Doit se présenter sous la forme providers/{provider} . provider doit être l'ID du projet Google Cloud. Par exemple, sample-cloud-project .
|
taskId |
string
Obligatoire. L'ID de tâche doit être unique, mais ne doit pas correspondre à un numéro de suivi d'envoi. Pour stocker un ID de suivi d'envoi, utilisez le champ trackingId . Notez que plusieurs tâches peuvent avoir le même trackingId . Les ID de tâche sont soumis aux restrictions suivantes:
- Doit être une chaîne Unicode valide.
- Limité à 64 caractères maximum.
- Normalisé selon la forme de normalisation C Unicode.
- Ne doit pas contenir l'un des caractères ASCII suivants: '/', ':', '?', ',' ou '#'.
|
task |
object (Task )
Obligatoire. Entité Task à créer. Lorsque vous créez une tâche, les champs suivants sont obligatoires:
type
state (doit être défini sur OPEN )
trackingId (ne doit pas être défini pour les tâches UNAVAILABLE ou SCHEDULED_STOP , mais est obligatoire pour tous les autres types de tâches)
plannedLocation (facultatif pour les tâches UNAVAILABLE )
taskDuration
Vous pouvez éventuellement définir les champs suivants:
targetTimeWindow
taskTrackingViewConfig
attributes
Remarque: Le champ name de la tâche est ignoré. Tous les autres champs de la tâche ne doivent pas être définis. Sinon, une erreur est renvoyée.
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/31 (UTC).
[null,null,["Dernière mise à jour le 2025/08/31 (UTC)."],[[["\u003cp\u003eCreates up to 500 \u003ccode\u003eTask\u003c/code\u003e objects at once using the \u003ccode\u003eBatchCreateTasks\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eRequires a \u003ccode\u003eparent\u003c/code\u003e resource in the URL path, indicating the Google Cloud Project ID.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes an optional \u003ccode\u003eheader\u003c/code\u003e and a required list of \u003ccode\u003erequests\u003c/code\u003e, each defining a \u003ccode\u003eTask\u003c/code\u003e to create.\u003c/p\u003e\n"],["\u003cp\u003eThe response returns a list of created \u003ccode\u003eTask\u003c/code\u003e objects within the \u003ccode\u003etasks\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eEach individual \u003ccode\u003eCreateTaskRequest\u003c/code\u003e requires a \u003ccode\u003etaskId\u003c/code\u003e, \u003ccode\u003etype\u003c/code\u003e, \u003ccode\u003estate\u003c/code\u003e, \u003ccode\u003etrackingId\u003c/code\u003e, and other relevant fields depending on the task type.\u003c/p\u003e\n"]]],["This document details how to create a batch of `Task` objects via a `POST` HTTP request to `https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks:batchCreate`. The `parent` path parameter is required and specifies the provider. The request body should contain a `header` and an array of `requests`, where each request includes a `CreateTaskRequest`. Each `CreateTaskRequest` requires a `parent`, `taskId`, and a `task` entity with specific fields. The response body returns an array of the created `Task` objects.\n"],null,["# Method: providers.tasks.batchCreate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchCreateTasksResponse.SCHEMA_REPRESENTATION)\n- [CreateTaskRequest](#CreateTaskRequest)\n - [JSON representation](#CreateTaskRequest.SCHEMA_REPRESENTATION)\n\nCreates and returns a batch of new `Task` objects.\n\n### HTTP request\n\n`POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks:batchCreate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource shared by all tasks. This value must be in the format `providers/{provider}`. The `provider` must be the Google Cloud Project ID. For example, `sample-cloud-project`. The parent field in the `CreateTaskRequest` messages must either be empty, or it must match this field. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"header\": { object (/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader) }, \"requests\": [ { object (/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks/batchCreate#CreateTaskRequest) } ] } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `header` | `object (`[DeliveryRequestHeader](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader)`)` Optional. The standard Delivery API request header. Note: If you set this field, then the header field in the `CreateTaskRequest` messages must either be empty, or it must match this field. |\n| `requests[]` | `object (`[CreateTaskRequest](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks/batchCreate#CreateTaskRequest)`)` Required. The request message that specifies the resources to create. Note: You can create a maximum of 500 tasks in a batch. |\n\n### Response body\n\nThe `BatchCreateTask` response message.\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) } ] } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------------------------------------------------------------------------------|\n| `tasks[]` | `object (`[Task](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks#Task)`)` The created Tasks. |\n\nCreateTaskRequest\n-----------------\n\nThe `tasks.create` request message.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"header\": { object (/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader) }, \"parent\": string, \"taskId\": string, \"task\": { object (/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks#Task) } } ``` |\n\n| Fields ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `header` | `object (`[DeliveryRequestHeader](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader)`)` Optional. The standard Delivery API request header. |\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| `taskId` | `string` Required. The Task ID must be unique, but it should be not a shipment tracking ID. To store a shipment tracking ID, use the `trackingId` field. Note that multiple tasks can have the same `trackingId`. Task IDs are subject to the following restrictions: - Must be a valid Unicode string. - Limited to a maximum length of 64 characters. - Normalized according to [Unicode Normalization Form C](http://www.unicode.org/reports/tr15/). - May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'. |\n| `task` | `object (`[Task](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks#Task)`)` Required. The Task entity to create. When creating a Task, the following fields are required: - `type` - `state` (must be set to `OPEN`) - `trackingId` (must not be set for `UNAVAILABLE` or `SCHEDULED_STOP` tasks, but required for all other task types) - `plannedLocation` (optional for `UNAVAILABLE` tasks) - `taskDuration` The following fields can be optionally set: - `targetTimeWindow` - `taskTrackingViewConfig` - `attributes` Note: The Task's `name` field is ignored. All other Task fields must not be set; otherwise, an error is returned. |"]]