REST Resource: providers.tasks

{
  "name": string,
  "type": enum (Type),
  "state": enum (State),
  "taskOutcome": enum (TaskOutcome),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfo)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSource),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfo)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindow)
  },
  "journeySharingInfo": {
    object (JourneySharingInfo)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfig)
  },
  "attributes": [
    {
      object (TaskAttribute)
    }
  ]
}

string

Должен быть в формате providers/{provider}/tasks/{task} .

enum ( Type )

Необходимый. Неизменный. Определяет тип Задачи. Например, перерыв или отгрузка.

enum ( State )

Необходимый. Текущее состояние выполнения Задачи.

enum ( TaskOutcome )

Результат Задания.

string ( Timestamp format)

Отметка времени, указывающая, когда результат Task был установлен поставщиком.

Временная метка в формате RFC3339 UTC "Zulu" с разрешением в наносекунды и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

object ( LocationInfo )

Место, где был установлен результат Task . Это значение обновляется как часть tasks.patch . Если поставщик явно не обновляет это значение, то Fleet Engine по умолчанию заполняет его последним известным местоположением транспортного средства ( необработанным местоположением).

enum ( TaskOutcomeLocationSource )

Указывает, откуда было получено значение taskOutcomeLocation .

string

Неизменный. Это поле облегчает хранение идентификатора, поэтому вы можете избежать использования сложного сопоставления. Вы не можете установить trackingId для задач типа UNAVAILABLE и SCHEDULED_STOP . На эти идентификаторы распространяются следующие ограничения:

• Должна быть допустимой строкой Unicode.
• Ограничено максимальной длиной 64 символа.
• Нормализован в соответствии с формой нормализации Unicode C .
• Не может содержать следующие символы ASCII: '/', ':', '?', ',' или '#'.

string

Только вывод. Идентификатор транспортного средства, выполняющего эту задачу. На идентификаторы транспортных средств доставки распространяются следующие ограничения:

• Должна быть допустимой строкой Unicode.
• Ограничено максимальной длиной 64 символа.
• Нормализован в соответствии с формой нормализации Unicode C .
• Не может содержать следующие символы ASCII: '/', ':', '?', ',' или '#'.

object ( LocationInfo )

Неизменный. Место, где Задание будет выполнено. Необязателен для UNAVAILABLE Задач, но обязателен для всех остальных Задач.

string ( Duration format)

Необходимый. Неизменный. Время, необходимое для выполнения задачи в этом месте.

Длительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся на « s ». Пример: "3.5s" .

object ( TimeWindow )

Временное окно, в течение которого задача должна быть выполнена.

object ( JourneySharingInfo )

Только вывод. Поля, относящиеся к совместному использованию поездок. Не заполняется, когда состояние CLOSED .

object ( TaskTrackingViewConfig )

Конфигурация отслеживания задач, определяющая, какие элементы данных видны конечным пользователям и при каких обстоятельствах.

object ( TaskAttribute )

Список настраиваемых атрибутов задачи. Каждый атрибут должен иметь уникальный ключ.

{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "lastLocationSnappable": boolean
}

object ( VehicleJourneySegment )

Информация об отслеживании остановок, которые назначенное транспортное средство сделает перед выполнением этой задачи. Обратите внимание, что этот список может содержать остановки от других задач.

Первый сегмент, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) или Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), содержит информацию о маршруте от последнего известного местоположения водителя до предстоящей VehicleStop . Информация о текущем маршруте обычно поступает из приложения водителя, за исключением некоторых случаев, отмеченных в документации для DeliveryVehicle.current_route_segment . Другие сегменты в Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) или Task.journeySharingInfo.remainingVehicleJourneySegments (REST) ​​заполняются Fleet Engine. Они предоставляют информацию о маршруте между оставшимися VehicleStops .

object ( DeliveryVehicleLocation )

Указывает последнее зарегистрированное местоположение назначенного транспортного средства.

boolean

Указывает, можно ли привязать lastLocation транспортного средства к currentRouteSegment . Это значение равно False, если lastLocation или currentRouteSegment не существуют. Это значение вычисляется программой Fleet Engine. Обновления от клиентов игнорируются.

{
  "routePolylinePointsVisibility": {
    object (VisibilityOption)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOption)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOption)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOption)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOption)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOption)
  }
}

object ( VisibilityOption )

Поле, определяющее, когда точки полилинии маршрута могут быть видны. Если это поле не указано, будет использоваться конфигурация видимости по умолчанию на уровне проекта для этих данных.

object ( VisibilityOption )

Поле, указывающее, когда расчетное время прибытия может быть видимым. Если это поле не указано, будет использоваться конфигурация видимости по умолчанию на уровне проекта для этих данных.

object ( VisibilityOption )

Поле, указывающее, когда предполагаемое время завершения задачи может быть видимым. Если это поле не указано, будет использоваться конфигурация видимости по умолчанию на уровне проекта для этих данных.

object ( VisibilityOption )

Поле, указывающее, когда оставшееся расстояние вождения может быть видимым. Если это поле не указано, будет использоваться конфигурация видимости по умолчанию на уровне проекта для этих данных.

object ( VisibilityOption )

Поле, указывающее, когда остается счетчик остановок, может быть видимым. Если это поле не указано, будет использоваться конфигурация видимости по умолчанию на уровне проекта для этих данных.

object ( VisibilityOption )

Поле, которое указывает, когда местоположение транспортного средства может быть видно. Если это поле не указано, будет использоваться конфигурация видимости по умолчанию на уровне проекта для этих данных.

{

  // Union field visibility_option can be only one of the following:
  "remainingStopCountThreshold": integer,
  "durationUntilEstimatedArrivalTimeThreshold": string,
  "remainingDrivingDistanceMetersThreshold": integer,
  "always": boolean,
  "never": boolean
  // End of list of possible types for union field visibility_option.
}

integer

Этот элемент данных виден конечным пользователям, если количество оставшихся остановок <= ReinstStopCountThreshold.

string ( Duration format)

Этот элемент данных виден конечным пользователям, если ETA до остановки <= durationUntilEstimatedArrivalTimeThreshold.

Длительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся на « s ». Пример: "3.5s" .

integer

Этот элемент данных виден конечным пользователям, если оставшееся расстояние в метрах <= RestantDrivingDistanceMetersThreshold.

boolean

Если установлено значение true, этот элемент данных всегда виден конечным пользователям без пороговых значений. Это поле не может иметь значение false.

boolean

Если установлено значение true, этот элемент данных всегда скрыт от конечных пользователей без пороговых значений. Это поле не может иметь значение false.