Package maps.fleetengine.delivery.v1

색인

DeliveryService

라스트 마일 배송 서비스입니다.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Task 객체를 일괄적으로 만들고 반환합니다.

CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

DeliveryVehicle를 만들고 반환합니다.

CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Task 객체를 만들고 반환합니다.

GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

지정된 DeliveryVehicle 인스턴스를 반환합니다.

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Task에 관한 정보를 가져옵니다.

GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

지정된 TaskTrackingInfo 인스턴스를 반환합니다.

ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

지정된 필터링 기준을 충족하는 모든 DeliveryVehicle를 가져옵니다.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

지정된 필터링 기준을 충족하는 모든 Task를 가져옵니다.

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

업데이트된 DeliveryVehicle 데이터를 Fleet Engine에 쓰고 DeliveryVehicleTasks를 할당합니다. DeliveryVehicle의 이름은 업데이트할 수 없습니다. remaining_vehicle_journey_segments는 업데이트할 있지만 DeliveryVehicle에 유지되려면 모든 VehicleJourneySegment가 포함되어야 합니다. task_idremaining_vehicle_journey_segments에서 검색되며, 아직 할당되지 않은 경우 해당 TasksDeliveryVehicle에 할당됩니다.

UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Task 데이터를 업데이트합니다.

BatchCreateTasksRequest

BatchCreateTask 요청 메시지

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다. 참고: 이 필드를 설정하는 경우 CreateTaskRequest 메시지의 헤더 필드는 비어 있거나 이 필드와 일치해야 합니다.

parent

string

필수 항목입니다. 모든 태스크에서 공유하는 상위 리소스입니다. 이 값은 providers/{provider} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 합니다. sample-cloud-project를 예로 들 수 있습니다. CreateTaskRequest 메시지의 상위 필드는 비어 있거나 이 필드와 일치해야 합니다.

requests[]

CreateTaskRequest

필수 항목입니다. 만들 리소스를 지정하는 요청 메시지입니다. 참고: 한 번에 최대 500개의 태스크를 만들 수 있습니다.

BatchCreateTasksResponse

BatchCreateTask 응답 메시지입니다.

필드
tasks[]

Task

생성된 할 일

CreateDeliveryVehicleRequest

CreateDeliveryVehicle 요청 메시지입니다.

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

parent

string

필수 항목입니다. providers/{provider} 형식이어야 합니다. 제공업체는 Google Cloud 프로젝트 ID여야 합니다. 예를 들면 sample-cloud-project입니다.

delivery_vehicle_id

string

필수 항목입니다. 배송 차량 ID는 고유해야 하며 다음과 같은 제한사항이 적용됩니다.

  • 유효한 유니코드 문자열이어야 합니다.
  • 최대 64자(영문 기준)로 제한됩니다.
  • 유니코드 정규화 양식 C에 따라 정규화됩니다.
  • '/', ':', '?', ',', '#'과 같은 ASCII 문자는 포함할 수 없습니다.
delivery_vehicle

DeliveryVehicle

필수 항목입니다. 만들 DeliveryVehicle 항목입니다. 새 전송 매체를 만들 때 다음 선택사항 필드를 설정할 수 있습니다.

  • 유형
  • last_location
  • 속성

참고: DeliveryVehicle의 name 필드는 무시됩니다. 다른 모든 DeliveryVehicle 필드는 설정하면 안 됩니다. 그러지 않으면 오류가 반환됩니다.

CreateTaskRequest

CreateTask 요청 메시지

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

parent

string

필수 항목입니다. providers/{provider} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 합니다. sample-cloud-project를 예로 들 수 있습니다.

task_id

string

필수 항목입니다. 작업 ID는 고유해야 하지만 배송 추적 ID가 아니어야 합니다. 배송 추적 ID를 저장하려면 tracking_id 필드를 사용합니다. 여러 작업에 동일한 tracking_id가 있을 수 있습니다. 작업 ID에는 다음과 같은 제한사항이 적용됩니다.

  • 유효한 유니코드 문자열이어야 합니다.
  • 최대 64자(영문 기준)로 제한됩니다.
  • 유니코드 정규화 양식 C에 따라 정규화됩니다.
  • '/', ':', '?', ',', '#'과 같은 ASCII 문자는 포함할 수 없습니다.
task

Task

필수 항목입니다. 만들 태스크 항목입니다. 할 일을 만들 때 다음 필드는 필수입니다.

  • type
  • state(OPEN로 설정해야 함)
  • tracking_id (UNAVAILABLE 또는 SCHEDULED_STOP 작업에는 설정하면 안 되지만 다른 모든 작업 유형에는 필수임)
  • planned_location(UNAVAILABLE 작업의 경우 선택사항)
  • task_duration

참고: 태스크의 name 필드는 무시됩니다. 다른 모든 Task 필드는 설정하면 안 됩니다. 그러지 않으면 오류가 반환됩니다.

DeliveryRequestHeader

RequestHeader에는 모든 전송 RPC 요청에 공통적인 필드가 포함됩니다.

필드
language_code

string

BCP-47 언어 코드(예: en-US 또는 sr-Latn)입니다. 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요. 지정하지 않으면 응답은 어떤 언어로든 제공될 수 있으며, 이름이 있는 경우 영어가 우선 적용됩니다. 필드 값 예: en-US

region_code

string

필수 항목입니다. 요청이 발생한 리전의 CLDR 리전 코드입니다. 필드 값 예: US

sdk_version

string

호출 SDK 버전(해당하는 경우) 버전 형식은 'major.minor.patch'입니다(예: 1.1.2).

os_version

string

호출 SDK가 실행 중인 운영체제 버전입니다. 필드 값 예: 4.4.1, 12.1

device_model

string

호출 SDK가 실행 중인 기기의 모델입니다. 필드 값 예: iPhone12,1, SM-G920F

sdk_type

SdkType

요청을 전송하는 SDK 유형입니다.

maps_sdk_version

string

호출하는 SDK가 종속되는 MapSDK 버전입니다(해당하는 경우). 버전 형식은 'major.minor.patch'입니다(예: 5.2.1).

nav_sdk_version

string

호출하는 SDK가 종속되는 NavSDK 버전입니다(해당하는 경우). 버전 형식은 'major.minor.patch'입니다(예: 2.1.0).

platform

Platform

호출 SDK의 플랫폼입니다.

manufacturer

string

호출 SDK의 Android 기기 제조업체입니다. Android SDK에만 적용됩니다. 필드 값 예: Samsung

android_api_level

int32

호출 SDK의 Android API 수준입니다. Android SDK에만 적용됩니다. 필드 값의 예: 23

trace_id

string

요청을 식별하기 위해 로깅 목적으로 제공할 수 있는 선택적 ID입니다.

플랫폼

호출하는 SDK의 플랫폼입니다.

열거형
PLATFORM_UNSPECIFIED 기본값입니다. 이 값은 플랫폼이 생략된 경우에 사용됩니다.
ANDROID Android에서 요청이 발생합니다.
IOS 요청이 iOS에서 발생합니다.
WEB 요청이 웹에서 발생합니다.

SdkType

가능한 SDK 유형입니다.

열거형
SDK_TYPE_UNSPECIFIED 기본값입니다. 이 값은 sdk_type가 생략된 경우에 사용됩니다.
CONSUMER 호출 SDK는 소비자입니다.
DRIVER 호출하는 SDK는 Driver입니다.
JAVASCRIPT 호출 SDK는 JavaScript입니다.

DeliveryVehicle

DeliveryVehicle 메시지 배송 차량은 배송 상품을 창고에서 배송 위치로, 그리고 수령 위치에서 창고로 운송합니다. 경우에 따라 배송 차량이 배송 상품을 수령 위치에서 배송 위치로 직접 운송하기도 합니다.

참고: gRPC API와 REST API는 서로 다른 필드 명명 규칙을 사용합니다. 예를 들어 gRPC API의 DeliveryVehicle.current_route_segment 필드와 REST API의 DeliveryVehicle.currentRouteSegment 필드는 동일한 필드를 참조합니다.

필드
name

string

이 배송 차량의 고유한 이름입니다. 형식은 providers/{provider}/deliveryVehicles/{vehicle}입니다.

last_location

DeliveryVehicleLocation

배송 차량의 마지막으로 보고된 위치입니다.

navigation_status

DeliveryVehicleNavigationStatus

배송 차량의 내비게이션 상태입니다.

current_route_segment

bytes

다음 경유지로 이동할 때 탐색에서 권장하는 경로를 지정하는 인코딩된 다중선입니다. 운전자 앱은 정류장에 도달하거나 지나갈 때, 그리고 내비게이션 경로가 변경될 때 이를 업데이트합니다. 이러한 LatLng는 차량에 할당된 모든 활성 태스크의 Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path(gRPC) 또는 Task.journeySharingInfo.remainingVehicleJourneySegments[0].path(REST)에서 반환됩니다.

다음과 같은 경우에는 이 필드가 Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path(gRPC) 또는 Task.journeySharingInfo.remainingVehicleJourneySegments[0].path(REST)를 채우는 데 사용되지 않을 수 있습니다.

  • current_route_segment의 엔드포인트가 DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) 또는 DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST)와 일치하지 않습니다.

  • 운전자 앱이 최근에 위치를 업데이트하지 않았으므로 이 필드의 마지막 업데이트 값이 오래되었을 수 있습니다.

  • 운전자 앱에서 최근에 위치를 업데이트했지만 current_route_segment가 비활성 상태이며 이전 차량 정류장을 가리킵니다.

이 경우 Fleet Engine은 이 필드의 소비자가 배송 차량의 현재 경로에 관한 최선의 정보를 사용할 수 있도록 가장 최근에 지나간 VehicleStop에서 다음 VehicleStop까지의 경로로 이 필드를 채웁니다.

current_route_segment_end_point

LatLng

current_route_segment가 끝나는 위치입니다. 이는 현재 드라이버 앱에서 채워지지 않지만 UpdateDeliveryVehicle 호출 시 제공할 수 있습니다. 다음 차량 정류장의 LatLng 또는 current_route_segment의 마지막 LatLng입니다. 그러면 Fleet Engine은 실제 VehicleStop로 보간하기 위해 최선을 다합니다.

current_route_segment 필드가 비어 있으면 UpdateDeliveryVehicle 호출에서 이 필드는 무시됩니다.

remaining_distance_meters

Int32Value

current_route_segment의 남은 운전 거리입니다. 일반적으로 Driver 앱에서 이 필드를 제공하지만 Fleet Engine에서 앱에서 전송한 값을 재정의하는 경우도 있습니다. 자세한 내용은 DeliveryVehicle.current_route_segment를 참고하세요. 이 필드는 배송 차량에 할당된 모든 활성 Task에 대해 Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) 또는 Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST)에서 반환됩니다.

current_route_segment 필드가 비어 있으면 Fleet Engine이 UpdateDeliveryVehicleRequest에서 이 필드를 무시합니다.

remaining_duration

Duration

current_route_segment의 남은 운전 시간입니다. 일반적으로 Driver 앱은 이 필드를 제공하지만, Fleet Engine이 앱에서 전송하는 값을 재정의하는 경우도 있습니다. 자세한 내용은 DeliveryVehicle.current_route_segment를 참고하세요. 이 필드는 전송 수단에 할당된 모든 활성 태스크의 경우 Task.remaining_vehicle_journey_segments[0].driving_duration(gRPC) 또는 Task.remainingVehicleJourneySegments[0].drivingDuration(REST)에서 반환됩니다.

current_route_segment 필드가 비어 있으면 Fleet Engine은 UpdateDeliveryVehicleRequest에서 이 필드를 무시합니다.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

차량의 가장 최근에 보고된 위치에서 시작하여 이 배송 차량에 할당된 이동 구간입니다. 이 필드는 ListDeliveryVehicles의 응답에 채워지지 않습니다.

attributes[]

DeliveryVehicleAttribute

맞춤 전송 수단 속성 목록입니다. 배달 차량에는 최대 100개의 속성이 있을 수 있으며 각 속성에는 고유한 키가 있어야 합니다.

type

DeliveryVehicleType

이 배송 차량의 유형입니다. 설정하지 않으면 기본값은 AUTO입니다.

DeliveryVehicleType

배송 차량 유형입니다.

열거형
DELIVERY_VEHICLE_TYPE_UNSPECIFIED 값이 사용되지 않습니다.
AUTO 자동차
TWO_WHEELER 오토바이, 모페드 또는 기타 2륜 차량
BICYCLE 사람이 직접 운전하는 이동 수단
PEDESTRIAN 보행자 통로를 따라 이동하며 걷거나 달리는 사람 수송자입니다.

DeliveryVehicleAttribute

차량 속성을 키-값 쌍으로 설명합니다. '키:값' 문자열 길이는 256자를 초과할 수 없습니다.

필드
key

string

속성의 키입니다.

value

string

속성의 값입니다.

통합 필드 delivery_vehicle_attribute_value. 속성의 값은 문자열, 불리언, double 유형일 수 있습니다. delivery_vehicle_attribute_value은 다음 중 하나여야 합니다.
string_value

string

문자열 유형의 속성 값입니다.

참고: 이는 value 필드와 동일하며 value 필드는 향후 지원 중단될 예정입니다. 만들기 또는 업데이트 메서드의 경우 두 필드 중 어느 쪽이든 사용할 수 있지만 string_value를 사용하는 것이 좋습니다. string_valuevalue가 모두 설정된 경우 두 속성이 동일해야 하며, 그렇지 않으면 오류가 발생합니다. 두 필드 모두 응답에 채워집니다.

bool_value

bool

불리언 유형의 속성 값입니다.

number_value

double

이중 유형 속성 값

DeliveryVehicleLocation

특정 시점의 차량 위치, 속도, 방향입니다.

필드
location

LatLng

차량의 위치입니다. 차량 엔진으로 전송되면 차량 위치가 GPS 위치가 됩니다. 응답으로 수신되는 차량 위치는 GPS 위치, 보조 위치 또는 기타 예상 위치일 수 있습니다. 소스는 location_sensor에 지정됩니다.

horizontal_accuracy
(deprecated)

DoubleValue

지원 중단됨: 대신 latlng_accuracy를 사용하세요.

latlng_accuracy

DoubleValue

반지름으로 location의 정확도(단위: 미터)입니다.

heading

Int32Value

차량이 이동하는 방향(도)입니다. 0은 북쪽을 나타냅니다. 유효한 범위는 [0,360)입니다.

bearing_accuracy
(deprecated)

DoubleValue

지원 중단됨: 대신 heading_accuracy를 사용하세요.

heading_accuracy

DoubleValue

heading의 정확성(도)입니다.

altitude

DoubleValue

WGS84를 기준으로 한 고도(단위: 미터)입니다.

vertical_accuracy
(deprecated)

DoubleValue

지원 중단됨: 대신 altitude_accuracy를 사용하세요.

altitude_accuracy

DoubleValue

altitude의 정확도입니다(단위: 미터).

speed_kmph
(deprecated)

Int32Value

차량의 속도(단위: 시간당 킬로미터)입니다. 지원 중단됨: 대신 speed를 사용하세요.

speed

DoubleValue

차량 속도(미터/초)

speed_accuracy

DoubleValue

speed의 정확도(단위: 미터/초)입니다.

update_time

Timestamp

센서의 시계에 따라 센서에서 location를 보고한 시간입니다.

server_time

Timestamp

출력 전용입니다. 서버가 위치 정보를 수신한 시간입니다.

location_sensor

DeliveryVehicleLocationSensor

위치 데이터 제공자(예: GPS)

is_road_snapped

BoolValue

location이 도로에 맞춰졌는지 여부입니다.

is_gps_sensor_enabled

BoolValue

입력 전용입니다. 휴대기기에서 GPS 센서가 사용 설정되어 있는지 나타냅니다.

time_since_update

Int32Value

입력 전용입니다. 이 위치가 처음 서버에 전송된 이후의 시간 (초)입니다. 첫 번째 업데이트의 경우 0입니다. 시간이 알 수 없는 경우(예: 앱이 다시 시작될 때) 이 값은 0으로 재설정됩니다.

num_stale_updates
(deprecated)

Int32Value

입력 전용입니다. 지원 중단됨: 이제 위치가 비활성 상태인지 확인하는 데 다른 신호가 사용됩니다.

raw_location

LatLng

원시 차량 위치(road-snapper에서 처리되지 않음)입니다.

raw_location_time

Timestamp

원시 위치와 연결된 타임스탬프입니다.

raw_location_sensor

DeliveryVehicleLocationSensor

원시 위치의 소스입니다. 기본값은 GPS입니다.

raw_location_accuracy

DoubleValue

raw_location의 반경을 미터 단위로 나타낸 정확도입니다.

supplemental_location

LatLng

통합 앱에서 제공하는 보조 위치입니다.

supplemental_location_time

Timestamp

보조 위치와 연결된 타임스탬프입니다.

supplemental_location_sensor

DeliveryVehicleLocationSensor

보조 위치의 소스입니다. 기본값은 CUSTOMER_SUPPLIED_LOCATION입니다.

supplemental_location_accuracy

DoubleValue

supplemental_location의 정확도(반지름, 미터)입니다.

road_snapped
(deprecated)

bool

지원 중단됨: 대신 is_road_snapped를 사용하세요.

DeliveryVehicleLocationSensor

위치를 파악하는 데 사용된 센서 또는 방법입니다.

열거형
UNKNOWN_SENSOR 센서가 지정되지 않았거나 알 수 없습니다.
GPS GPS 또는 GPS 보조 기능
NETWORK 보조 GPS, 휴대폰 기지국 ID 또는 Wi-Fi 액세스 포인트
PASSIVE 휴대폰 기지국 ID 또는 Wi-Fi 액세스 포인트
ROAD_SNAPPED_LOCATION_PROVIDER 휴대기기에서 도로 위치일 가능성이 가장 높다고 판단한 위치입니다.
CUSTOMER_SUPPLIED_LOCATION 독립적인 출처에서 고객이 제공한 위치입니다. 일반적으로 이 값은 Driver SDK를 실행하는 휴대기기가 아닌 소스에서 제공된 위치에 사용됩니다. 원본 소스가 다른 enum 값 중 하나로 설명된 경우 해당 값을 사용합니다. CUSTOMER_SUPPLIED_LOCATION으로 표시된 위치는 일반적으로 DeliveryVehicle의 last_location.supplemental_location_sensor를 통해 제공됩니다.
FLEET_ENGINE_LOCATION Fleet Engine에서 사용 가능한 신호를 기반으로 계산한 위치입니다. 출력 전용입니다. 이 값은 요청에서 수신되면 거부됩니다.
FUSED_LOCATION_PROVIDER Android의 Fused Location Provider
CORE_LOCATION Apple 운영체제의 위치 제공업체입니다.

DeliveryVehicleNavigationStatus

차량의 내비게이션 상태입니다.

열거형
UNKNOWN_NAVIGATION_STATUS 탐색 상태가 지정되지 않았습니다.
NO_GUIDANCE 운전자 앱의 탐색이 FREE_NAV 모드입니다.
ENROUTE_TO_DESTINATION 세부 경로 안내를 사용할 수 있으며 운전자 앱 내비게이션이 GUIDED_NAV 모드로 전환되었습니다.
OFF_ROUTE 차량이 추천 경로에서 벗어났습니다.
ARRIVED_AT_DESTINATION 차량이 목적지에서 약 50m 이내에 있습니다.

GetDeliveryVehicleRequest

GetDeliveryVehicle 요청 메시지

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

name

string

필수 항목입니다. providers/{provider}/deliveryVehicles/{delivery_vehicle} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 합니다. sample-cloud-project를 예로 들 수 있습니다.

GetTaskRequest

GetTask 요청 메시지입니다.

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

name

string

필수 항목입니다. providers/{provider}/tasks/{task} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 합니다. sample-cloud-project를 예로 들 수 있습니다.

GetTaskTrackingInfoRequest

GetTaskTrackingInfoRequest 요청 메시지입니다.

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

name

string

필수 항목입니다. providers/{provider}/taskTrackingInfo/{tracking_id} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 하며 tracking_id는 할 일과 연결된 추적 ID여야 합니다. 이름의 예는 providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id일 수 있습니다.

ListDeliveryVehiclesRequest

ListDeliveryVehicles 요청 메시지

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

parent

string

필수 항목입니다. providers/{provider} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 합니다. sample-cloud-project를 예로 들 수 있습니다.

page_size

int32

선택사항입니다. 반환할 최대 차량 수입니다. 서비스가 이 수보다 더 적게 반환할 수 있습니다. 이 숫자를 지정하지 않으면 서버에서 반환할 결과 수를 결정합니다.

page_token

string

선택사항입니다. 이전 ListDeliveryVehicles 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 제공해야 합니다.

페이지를 매길 때 ListDeliveryVehicles에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

filter

string

선택사항입니다. 배송 차량을 나열할 때 적용할 필터 쿼리입니다. 필터 문법의 예는 http://aip.dev/160을 참고하세요. 값을 지정하지 않거나 필터에 빈 문자열을 지정하면 모든 전송 수단이 반환됩니다.

ListDeliveryVehicles에 지원되는 유일한 쿼리는 차량 속성(예: attributes.<key> = <value> 또는 attributes.<key1> = <value1> AND attributes.<key2> = <value2>)에 관한 쿼리입니다. 또한 모든 속성은 문자열로 저장되므로 속성에 대해 지원되는 유일한 비교는 문자열 비교입니다. 숫자 또는 불리언 값과 비교하려면 값을 문자열로 처리되도록 명시적으로 따옴표로 묶어야 합니다(예: attributes.<key> = "10" 또는 attributes.<key> = "true").

필터 쿼리에 허용되는 최대 제한 수는 50개입니다. 제한은 attribute.<KEY> <COMPARATOR> <VALUE> 형식의 쿼리의 일부입니다. 예를 들어 attributes.foo = bar은 1개의 제한입니다.

viewport

Viewport

선택사항입니다. 마지막으로 알려진 위치가 뷰포트로 정의된 직사각형 영역에 있는 차량으로 반환되는 차량을 제한하는 필터입니다.

ListDeliveryVehiclesResponse

ListDeliveryVehicles 응답 메시지입니다.

필드
delivery_vehicles[]

DeliveryVehicle

요청된 필터링 기준을 충족하는 배송 차량 집합입니다. 필터를 지정하지 않으면 요청에서 모든 배송 차량을 반환합니다. 성공적인 응답은 비워둘 수도 있습니다. 빈 응답은 요청된 필터 기준을 충족하는 배송 차량이 없음을 나타냅니다.

next_page_token

string

이 토큰을 ListDeliveryVehiclesRequest에 전달하여 결과를 계속 표시할 수 있습니다. 모든 결과가 반환되면 이 필드는 응답에 없거나 빈 문자열이 됩니다.

total_size

int64

모든 페이지에서 요청 기준과 일치하는 총 배송 차량 수입니다.

ListTasksRequest

ListTasks 요청 메시지입니다.

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

parent

string

필수 항목입니다. providers/{provider} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 합니다. sample-cloud-project를 예로 들 수 있습니다.

page_size

int32

선택사항입니다. 반환할 최대 Tasks 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 이 값을 지정하지 않으면 서버에서 반환할 결과 수를 결정합니다.

page_token

string

선택사항입니다. 이전 ListTasks 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 ListTasks에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

filter

string

선택사항입니다. 할 일을 나열할 때 적용할 필터 쿼리입니다. 필터 문법의 예는 http://aip.dev/160을 참고하세요. 값을 지정하지 않거나 빈 문자열로 필터링하면 모든 할 일이 반환됩니다. 필터링할 수 있는 작업 속성에 대한 자세한 내용은 작업 목록을 참고하세요.

ListTasksResponse

ListTasksRequest의 필터 기준을 충족하는 작업 집합이 포함된 ListTasks 응답입니다.

필드
tasks[]

Task

요청된 필터링 기준을 충족하는 태스크 집합입니다. 필터를 지정하지 않으면 요청에서 모든 작업을 반환합니다. 성공적인 응답이 비어 있을 수도 있습니다. 빈 응답은 요청된 필터 기준을 충족하는 할 일이 없음을 나타냅니다.

next_page_token

string

ListTasksRequest에 이 토큰을 전달하여 결과를 계속 표시합니다. 모든 결과가 반환된 경우 이 필드는 빈 문자열이거나 응답에 표시되지 않습니다.

total_size

int64

모든 페이지에서 요청 기준과 일치하는 작업의 총 개수입니다.

LocationInfo

추가 식별자가 있는 위치입니다.

필드
point

LatLng

위치의 좌표입니다.

작업

Delivery API의 Task는 추적할 단일 작업을 나타냅니다. 일반적으로 배송 관련 태스크와 휴식 시간 태스크는 구분됩니다. 배송에는 여러 작업이 연결될 수 있습니다. 예를 들어 승차에 대한 작업 하나와 하차 또는 환승에 대한 작업이 하나 있을 수 있습니다. 또한 차량마다 배송에 따라 다른 작업을 처리할 수 있습니다. 예를 들어 한 차량은 픽업을 처리하여 배송을 허브로 배송하고, 다른 차량은 허브에서 하차 위치로 동일한 배송을 운전합니다.

참고: gRPC API와 REST API는 서로 다른 필드 명명 규칙을 사용합니다. 예를 들어 gRPC API의 Task.journey_sharing_info 필드와 REST API의 Task.journeySharingInfo 필드는 동일한 필드를 참조합니다.

필드
name

string

providers/{provider}/tasks/{task} 형식이어야 합니다.

type

Type

필수 항목입니다. 변경할 수 없습니다. 할 일의 유형을 정의합니다. 예를 들어 휴식 또는 배송이 있습니다.

state

State

필수 항목입니다. 태스크의 현재 실행 상태입니다.

task_outcome

TaskOutcome

태스크의 결과입니다.

task_outcome_time

Timestamp

제공업체가 Task의 결과를 설정한 시점을 나타내는 타임스탬프입니다.

task_outcome_location

LocationInfo

Task의 결과가 설정된 위치입니다. 이 값은 UpdateTask의 일부로 업데이트됩니다. 이 값이 제공업체에 의해 명시적으로 업데이트되지 않으면 Fleet Engine은 기본적으로 마지막으로 확인된 차량 위치(원시 위치)로 채웁니다.

task_outcome_location_source

TaskOutcomeLocationSource

task_outcome_location 값의 출처를 나타냅니다.

tracking_id

string

변경할 수 없습니다. 이 필드는 ID를 저장하는 것을 용이하게 하여 복잡한 매핑을 사용하지 않아도 됩니다. UNAVAILABLESCHEDULED_STOP 유형의 작업에는 tracking_id을(를) 설정할 수 없습니다. 이러한 ID에는 다음과 같은 제한사항이 적용됩니다.

  • 유효한 유니코드 문자열이어야 합니다.
  • 최대 64자(영문 기준)로 제한됩니다.
  • 유니코드 정규화 양식 C에 따라 정규화됩니다.
  • '/', ':', '?', ',', '#'과 같은 ASCII 문자는 포함할 수 없습니다.
delivery_vehicle_id

string

출력 전용입니다. 이 작업을 실행 중인 차량의 ID입니다. 전송 차량 ID에는 다음과 같은 제한사항이 적용됩니다.

  • 유효한 유니코드 문자열이어야 합니다.
  • 최대 64자(영문 기준)로 제한됩니다.
  • 유니코드 정규화 양식 C에 따라 정규화됩니다.
  • '/', ':', '?', ',', '#'과 같은 ASCII 문자는 포함할 수 없습니다.
planned_location

LocationInfo

변경할 수 없습니다. 태스크가 완료될 위치입니다. UNAVAILABLE 태스크에는 선택사항이지만 다른 모든 태스크에는 필수입니다.

task_duration

Duration

필수 항목입니다. 변경할 수 없습니다. 이 위치에서 태스크를 실행하는 데 필요한 시간입니다.

target_time_window

TimeWindow

작업을 완료해야 하는 기간입니다.

journey_sharing_info

JourneySharingInfo

출력 전용입니다. 여정 공유 관련 입력란 상태가 CLOSED인 경우 채워지지 않습니다.

task_tracking_view_config

TaskTrackingViewConfig

어떤 상황에서 최종 사용자에게 어떤 데이터 요소가 표시되는지 지정하는 작업 추적 구성입니다.

attributes[]

TaskAttribute

맞춤 작업 속성 목록입니다. 각 속성에는 고유 키가 있어야 합니다.

JourneySharingInfo

특정 필드를 공유하는 여정

필드
remaining_vehicle_journey_segments[]

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 간의 경로 정보를 제공합니다.

last_location

DeliveryVehicleLocation

할당된 차량의 마지막으로 보고된 위치를 나타냅니다.

last_location_snappable

bool

차량의 lastLocation을 current_route_segment에 스냅할 수 있는지 여부를 나타냅니다. last_location 또는 current_route_segment가 존재하지 않으면 이 값은 False입니다. 이 값은 Fleet Engine에서 계산됩니다. 클라이언트의 업데이트는 무시됩니다.

작업의 상태입니다. Tasks의 진행 상황을 나타냅니다.

열거형
STATE_UNSPECIFIED 기본값입니다. 지정되지 않았거나 인식되지 않는 작업 상태에 사용됩니다.
OPEN 작업이 아직 배송 차량에 할당되지 않았거나 배송 차량이 아직 Task의 할당된 차량 정류장을 지나지 않았습니다.
CLOSED 차량이 이 작업의 차량 정류장을 지나갈 때

TaskOutcome

작업 실행 시도의 결과입니다. TaskState가 닫히면 TaskOutcome은 작업이 성공적으로 완료되었는지 여부를 나타냅니다.

열거형
TASK_OUTCOME_UNSPECIFIED 값이 설정되기 전의 할 일 결과입니다.
SUCCEEDED 작업이 완료되었습니다.
FAILED 할 일을 완료할 수 없거나 취소되었습니다.

TaskOutcomeLocationSource

task_outcome_location를 채운 소스의 ID입니다.

열거형
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED 설정되기 전의 작업 결과입니다.
PROVIDER 제공업체가 task_outcome_location를 지정했습니다.
LAST_VEHICLE_LOCATION 제공업체에서 task_outcome_location를 지정하지 않았으므로 Fleet Engine에서 마지막으로 알려진 차량 위치를 사용했습니다.

유형

작업 유형입니다.

열거형
TYPE_UNSPECIFIED 기본적으로 작업 유형을 알 수 없습니다.
PICKUP 수령 작업은 고객으로부터 배송 상품을 수령하기 위해 취해진 조치입니다. 차고 또는 급지대 차량 픽업은 SCHEDULED_STOP 유형을 사용해야 합니다.
DELIVERY 배송 작업은 최종 고객에게 배송하기 위해 취해지는 작업입니다. 창고 또는 피더 차량 하차는 SCHEDULED_STOP 유형을 사용해야 합니다.
SCHEDULED_STOP 예약된 중지 작업은 계획 목적으로 사용됩니다. 예를 들어 피더 차량 또는 창고에서 배송 상품을 픽업하거나 배송하는 것을 나타낼 수 있습니다. 최종 고객이 수령하거나 발송하는 배송에는 사용해서는 안 됩니다.
UNAVAILABLE 차량을 수리할 수 없음을 의미하는 작업입니다. 예를 들어 운전자가 휴식을 취하거나 차량에 연료를 주입할 때 이러한 상황이 발생할 수 있습니다.

TaskAttribute

태스크 속성을 키-값 쌍으로 설명합니다. '키:값' 문자열 길이는 256자를 초과할 수 없습니다.

필드
key

string

속성의 키입니다. 키에는 콜론 문자(:)가 포함될 수 없습니다.

통합 필드 task_attribute_value. 속성의 값은 문자열, 불리언, double 유형일 수 있습니다. 설정하지 않으면 TaskAttribute string_value가 빈 문자열 ''로 저장됩니다. task_attribute_value는 다음 중 하나여야 합니다.
string_value

string

문자열 유형의 속성 값입니다.

bool_value

bool

불리언 유형의 속성 값입니다.

number_value

double

이중 유형 속성 값

TaskTrackingInfo

TaskTrackingInfo 메시지 메시지에는 표시하는 데 사용되는 작업 추적 정보가 포함됩니다. 추적 ID가 여러 작업과 연결된 경우 Fleet Engine은 휴리스틱을 사용하여 선택할 작업의 TaskTrackingInfo를 결정합니다.

필드
name

string

providers/{provider}/taskTrackingInfo/{tracking} 형식이어야 하며 여기서 tracking는 추적 ID를 나타냅니다.

tracking_id

string

변경할 수 없습니다. 할 일의 추적 ID입니다. * 유효한 유니코드 문자열이어야 합니다. * 최대 64자(영문 기준)로 제한됩니다. * 유니코드 정규화 양식 C에 따라 정규화됩니다. * '/', ':', '?', ',', '#' 등의 ASCII 문자는 포함할 수 없습니다.

vehicle_location

DeliveryVehicleLocation

차량의 마지막 위치입니다.

route_polyline_points[]

LatLng

연결되면 이 작업의 위치에 대한 차량의 예상 경로의 폴리라인을 형성하는 점의 목록입니다.

remaining_stop_count

Int32Value

태스크 정류장에 도달할 때까지 차량에 남은 정류장 수를 나타냅니다(태스크 정류장 포함). 예를 들어 차량의 다음 정류장이 작업 정류장인 경우 값은 1입니다.

remaining_driving_distance_meters

Int32Value

관심 VehicleStop까지의 총 남은 거리(단위: 미터)입니다.

estimated_arrival_time

Timestamp

정류장 위치에 도착할 것으로 예상되는 시간을 나타내는 타임스탬프입니다.

estimated_task_completion_time

Timestamp

할 일의 예상 완료 시간을 나타내는 타임스탬프입니다.

state

State

태스크의 현재 실행 상태입니다.

task_outcome

TaskOutcome

작업 실행 시도의 결과입니다.

task_outcome_time

Timestamp

제공업체가 작업의 결과를 설정했음을 나타내는 타임스탬프입니다.

planned_location

LocationInfo

변경할 수 없습니다. 태스크가 완료될 위치입니다.

target_time_window

TimeWindow

작업을 완료해야 하는 기간입니다.

attributes[]

TaskAttribute

작업에 설정된 맞춤 속성입니다.

TaskTrackingViewConfig

작업의 데이터 요소가 최종 사용자에게 표시되어야 하는 시점을 정의하는 구성 메시지입니다.

필드
route_polyline_points_visibility

VisibilityOption

경로 폴리라인 포인트가 표시될 수 있는 시점을 지정하는 필드입니다. 이 필드를 지정하지 않으면 이 데이터의 프로젝트 수준 기본 공개 범위 구성이 사용됩니다.

estimated_arrival_time_visibility

VisibilityOption

예상 도착 시간이 표시될 수 있는 시점을 지정하는 필드입니다. 이 필드를 지정하지 않으면 이 데이터의 프로젝트 수준 기본 공개 범위 구성이 사용됩니다.

estimated_task_completion_time_visibility

VisibilityOption

예상 작업 완료 시간을 표시할 수 있는 시점을 지정하는 필드입니다. 이 필드를 지정하지 않으면 이 데이터의 프로젝트 수준 기본 공개 상태 구성이 사용됩니다.

remaining_driving_distance_visibility

VisibilityOption

남은 운전 거리를 표시할 수 있는 시점을 지정하는 필드입니다. 이 필드를 지정하지 않으면 이 데이터의 프로젝트 수준 기본 공개 범위 구성이 사용됩니다.

remaining_stop_count_visibility

VisibilityOption

남은 정류장 수를 표시할 수 있는 시점을 지정하는 필드입니다. 이 필드를 지정하지 않으면 이 데이터의 프로젝트 수준 기본 공개 상태 구성이 사용됩니다.

vehicle_location_visibility

VisibilityOption

차량 위치를 표시할 수 있는 시기를 지정하는 필드입니다. 이 필드를 지정하지 않으면 이 데이터의 프로젝트 수준 기본 공개 범위 구성이 사용됩니다.

VisibilityOption

데이터 요소가 최종 사용자에게 표시되어야 하는 시점을 정의하는 옵션 메시지입니다.

필드
통합 필드 visibility_option. 선택한 특정 공개 상태 옵션입니다. visibility_option은 다음 중 하나여야 합니다.
remaining_stop_count_threshold

int32

이 데이터 요소는 남은 정지 횟수가 remaining_stop_count_threshold 이하인 경우 최종 사용자에게 표시됩니다.

duration_until_estimated_arrival_time_threshold

Duration

이 데이터 요소는 정류장까지의 예상 도착 시간(ETA)이 duration_until_estimated_arrival_time_threshold보다 작은 경우 최종 사용자에게 표시됩니다.

remaining_driving_distance_meters_threshold

int32

이 데이터 요소는 남은 운전 거리(미터 단위)가 <= left_driving_distance_meters_threshold 미만이면 최종 사용자에게 표시됩니다.

always

bool

true로 설정하면 이 데이터 요소가 임곗값 없이 항상 최종 사용자에게 표시됩니다. 이 필드는 false로 설정할 수 없습니다.

never

bool

true로 설정되면 이 데이터 요소는 기준점 없이 최종 사용자에게 항상 숨겨집니다. 이 필드는 false로 설정할 수 없습니다.

TimeWindow

기간입니다.

필드
start_time

Timestamp

필수 항목입니다. 기간의 시작 시간입니다(해당 값 포함).

end_time

Timestamp

필수 항목입니다. 기간의 종료 시간 (해당 시간 포함)입니다.

UpdateDeliveryVehicleRequest

UpdateDeliveryVehicle 요청 메시지

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

delivery_vehicle

DeliveryVehicle

필수 항목입니다. 적용할 DeliveryVehicle 항목 업데이트입니다. 참고: DeliveryVehicle의 이름은 업데이트할 수 없습니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 DeliveryVehicle 필드를 나타내는 필드 마스크입니다. update_mask는 하나 이상의 필드를 포함해야 합니다.

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "remaining_vehicle_journey_segments"

UpdateTaskRequest

UpdateTask 요청 메시지입니다.

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 Delivery API 요청 헤더입니다.

task

Task

필수 항목입니다. 업데이트와 관련된 작업입니다. 다음 필드는 Fleet Engine에서 유지 관리합니다. Task.update를 사용하여 업데이트하지 마세요.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

참고: task_outcome 값은 설정하면 변경할 수 없습니다.

작업이 배송 수단에 할당된 경우 Task.update를 사용하여 작업 상태를 CLOSED로 설정하지 마세요. 대신 전송 수단에서 태스크가 포함된 VehicleStop를 삭제하면 태스크 상태가 CLOSED로 자동 설정됩니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 태스크 필드를 나타내는 필드 마스크입니다. 참고: update_mask에는 하나 이상의 필드가 포함되어야 합니다.

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "task_outcome,task_outcome_time,task_outcome_location"

VehicleJourneySegment

이전 정류장에서 현재 정류장까지 차량의 이동 구간을 나타냅니다. 첫 번째 정류장인 경우 차량의 현재 위치에서 이 정류장까지의 거리입니다.

필드
stop

VehicleStop

정류장 위치와 정류장과 연결된 Task를 지정합니다. 이 이동 구간이 JourneySharingInfo의 일부인 경우 VehicleStop의 일부 필드가 표시되지 않을 수 있습니다.

driving_distance_meters

Int32Value

출력 전용입니다. 이전 정류장부터 이 정류장까지의 이동 거리입니다. 현재 정류장이 이동 구간 목록의 첫 번째 정류장인 경우 출발점은 이 정류장이 목록에 추가될 때 기록된 차량의 위치입니다. 이 이동 구간이 JourneySharingInfo의 일부인 경우 이 필드가 없을 수 있습니다.

driving_duration

Duration

출력 전용입니다. 이전 정류장에서 이 정류장까지의 이동 시간입니다. 현재 정류장이 이동 구간 목록의 첫 번째 정류장인 경우 출발점은 이 정류장이 목록에 추가될 때 기록된 차량의 위치입니다.

이 필드가 경로 Task.remaining_vehicle_journey_segments[0].driving_duration(gRPC) 또는 Task.remainingVehicleJourneySegments[0].drivingDuration(REST)에 정의된 경우 DeliveryVehicle.remaining_duration(gRPC) 또는 DeliveryVehicle.remainingDuration(REST)의 값으로 채워질 수 있습니다. 이렇게 하면 이전 정류장부터의 운전 시간이 아닌 운전자 앱의 마지막으로 알려진 위치에서의 남은 운전 시간을 제공합니다.

path[]

LatLng

출력 전용입니다. 이전 정류장에서 이 정류장까지의 경로입니다. 현재 정류장이 경로 구간 목록의 첫 번째 정류장인 경우, 이 정류장이 목록에 추가될 당시 차량의 현재 위치에서 이 정류장까지의 경로입니다. 이 이동 구간이 JourneySharingInfo의 일부인 경우 이 필드가 없을 수 있습니다.

이 필드가 경로 Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path(gRPC) 또는 Task.journeySharingInfo.remainingVehicleJourneySegments[0].path(REST)에 정의된 경우 DeliveryVehicle.current_route_segment(gRPC) 또는 DeliveryVehicle.currentRouteSegment(REST)에서 디코딩된 LatLng로 채워질 수 있습니다. 이렇게 하면 이전 정류장 경로가 아닌 운전자 앱의 마지막으로 알려진 위치에서 출발하는 운전 경로가 제공됩니다.

VehicleStop

차량이 정차하여 하나 이상의 Task를 실행하는 지점을 설명합니다.

필드
planned_location

LocationInfo

필수 항목입니다. 정류장 위치입니다. Task의 위치는 이 위치와 정확히 일치하지 않을 수 있지만 가까운 거리에 있습니다. 이 필드는 GetTask 호출의 응답에 채워지지 않습니다.

tasks[]

TaskInfo

이 정류장에서 실행할 Task 목록입니다. 이 필드는 GetTask 호출의 응답에 채워지지 않습니다.

state

State

VehicleStop의 상태입니다. 이 필드는 GetTask 호출의 응답에 채워지지 않습니다.

VehicleStop의 현재 상태입니다.

열거형
STATE_UNSPECIFIED 알 수 없음
NEW 생성되었지만 현재 라우팅되지 않음
ENROUTE 할당되었으며 라우팅이 활성 상태입니다.
ARRIVED 정류장에 도착했습니다. 차량이 다음 정류장으로 경로를 변경할 때 이전의 모든 정류장이 완료되었다고 가정합니다.

TaskInfo

이 정류장에서 수행된 작업에 대한 추가 정보입니다.

필드
task_id

string

작업 ID입니다. 이 필드는 GetTask 호출의 응답에 채워지지 않습니다. 작업 ID에는 다음과 같은 제한사항이 적용됩니다.

  • 유효한 유니코드 문자열이어야 합니다.
  • 최대 길이는 64자(영문 기준)로 제한됩니다.
  • 유니코드 정규화 양식 C에 따라 정규화됩니다.
  • '/', ':', '?', ',', '#'과 같은 ASCII 문자는 포함할 수 없습니다.
task_duration

Duration

출력 전용입니다. 작업을 수행하는 데 필요한 시간입니다.

target_time_window

TimeWindow

출력 전용입니다. 작업을 완료해야 하는 기간입니다. 이는 GetDeliveryVehicle에 대한 응답에서만 설정됩니다.