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

선택사항입니다. 표준 게재 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

선택사항입니다. 표준 게재 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

선택사항입니다. 표준 게재 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

필수 항목입니다. 만들 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가 드라이버입니다.
JAVASCRIPT 호출 SDK가 JavaScript입니다.

DeliveryVehicle

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

참고: gRPC와 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 오토바이, 모페드 또는 기타 오토바이
BICYCLE 인간 기반 운송
PEDESTRIAN 보행자 통로를 따라 이동하며 걷거나 달리는 사람 수송자입니다.

DeliveryVehicleAttribute

차량 속성을 키-값 쌍으로 설명합니다. 'key:value' 문자열 길이는 256자(영문 기준) 이하여야 합니다.

필드
key

string

속성의 키입니다.

value

string

속성의 값입니다.

통합 필드 delivery_vehicle_attribute_value. 속성 값은 문자열, 부울 또는 double 형식일 수 있습니다. delivery_vehicle_attribute_value은 다음 중 하나여야 합니다.
string_value

string

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

참고: 이는 최종적으로 지원 중단될 value 필드와 동일합니다. create 또는 update 메서드의 경우 두 필드 중 하나를 사용할 수 있지만 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

원시 차량 위치입니다 (로드 스냅퍼에서 처리하지 않음).

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 또는 WiFi 액세스 포인트
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의 통합 위치 정보 제공자.
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

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

name

string

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

GetTaskRequest

GetTask 요청 메시지

필드
header

DeliveryRequestHeader

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

name

string

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

GetTaskTrackingInfoRequest

GetTaskTrackingInfoRequest 요청 메시지

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 게재 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

선택사항입니다. 표준 게재 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

선택사항입니다. 표준 게재 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을 참조하세요. 값을 지정하지 않거나 빈 문자열을 필터링하면 모든 Tasks가 반환됩니다. 필터링할 수 있는 작업 속성에 관한 자세한 내용은 작업 나열을 참고하세요.

ListTasksResponse

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

필드
tasks[]

Task

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

next_page_token

string

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

total_size

int64

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

LocationInfo

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

필드
point

LatLng

위치의 좌표입니다.

작업

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

참고: gRPC와 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 기본값입니다. 지정되지 않거나 인식할 수 없는 Task 상태에 사용됩니다.
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

작업 속성을 키-값 쌍으로 설명합니다. 'key:value' 문자열 길이는 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

이 데이터 요소는 남은 정류장 수가 left_stop_count_threshold보다 작은 경우 최종 사용자에게 표시됩니다.

duration_until_estimated_arrival_time_threshold

Duration

이 데이터 요소는 정류장 도착예정시간이 <= 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

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

delivery_vehicle

DeliveryVehicle

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

update_mask

FieldMask

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

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

UpdateTaskRequest

UpdateTask 요청 메시지

필드
header

DeliveryRequestHeader

선택사항입니다. 표준 게재 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로 설정하지 마세요. 대신 배송 차량에서 Task가 포함된 VehicleStop를 삭제하면 Task 상태가 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에 대한 응답에서만 설정됩니다.