REST Resource: selection.v1.projects.selectedRoutes

리소스: SelectedRoute

SelectedRoute는 고객이 계약된 사용 사례에 대한 정보 (예: 기간)를 주기적으로 검색하려는 특정 경로를 나타냅니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
필드
name

string

식별자. SelectedRoute의 리소스 이름입니다.

형식: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

선택사항입니다. 경로의 표시 이름입니다. 고객이 사용할 수 있는 선택사항 필드입니다. 고유하지 않아도 됩니다.
createTime

string (Timestamp format)

출력 전용입니다. 선택한 경로가 처음 생성된 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
state

enum (State)

출력 전용입니다. 선택한 경로의 상태입니다.
routeAttributes

map (key: string, value: string)

선택사항입니다. 선택한 경로의 맞춤 속성입니다. 이를 추가하면 기록 및 실시간 경로 정보를 가져올 때 경로를 필터링 / 그룹화할 수 있습니다. 경로당 최대 10개의 속성이 지원됩니다. 각 키와 값은 비어 있지 않은 문자열이어야 하며 최대 100자(영문 기준)까지 가능합니다. 키는 'goog'로 시작할 수 없습니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
통합 필드 route_type. 현재 DynamicRoute만 지원됩니다. route_type은 다음 중 하나일 수 있습니다.
dynamicRoute

object (DynamicRoute)

SelectedRoute은 동적 경로입니다.
validationError

enum (ValidationError)

출력 전용입니다. 상태가 STATE_INVALID일 때 선택한 경로의 검증 오류입니다.

DynamicRoute

경유지 (출발지, 목적지, 중간 지점)가 있는 경로를 나타냅니다. 실제 경로는 모든 경유지를 통과하지만 교통 상황에 따라 수시로 변경될 수 있습니다.

JSON 표현 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
필드
origin

object (LatLng)

필수입니다. 경로의 출발지 위치입니다.
destination

object (LatLng)

필수입니다. 경로의 종료 위치입니다.
intermediates[]

object (LatLng)

선택사항입니다. 경로를 따라 있는 중간 경유지 집합 (터미널 포인트 제외)입니다. 항상 통과 지점입니다. 최대 25개의 중간 경유지가 지원됩니다. 이러한 지점을 올바르게 추가하면 실제 경로의 변동을 줄일 수 있습니다.

LatLng

위도/경도 쌍을 나타내는 객체로 위도와 경도를 나타내는 복식 쌍으로 표현됩니다. 달리 명시되지 않는 한 이 객체는 WGS84 표준을 준수해야 합니다. 값은 정규화된 범위 내에 있어야 합니다.

JSON 표현 
{
  "latitude": number,
  "longitude": number
}
필드
latitude

number

위도입니다. 범위는 [-90.0, +90.0]입니다.
longitude

number

경도입니다. 범위는 [-180.0, +180.0]입니다.

주

선택한 경로의 상태입니다.

열거형
STATE_UNSPECIFIED 이 경로의 상태가 설정되지 않았습니다.
STATE_SCHEDULING 경로가 생성되었으며 예약 중입니다.
STATE_RUNNING 경로가 생성되었으며 활성 일정이 있습니다.
STATE_DELETING 경로가 삭제 대상으로 표시되었습니다.
STATE_VALIDATING 경로가 검증되는 중입니다.
STATE_INVALID 유효성 검사 기준 중 하나에 따라 경로가 유효하지 않습니다.

ValidationError

선택한 경로의 유효성 검사 오류입니다.

열거형
VALIDATION_ERROR_UNSPECIFIED 이 경로의 유효성 검사 오류가 설정되지 않았습니다.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION 경로가 프로젝트 관할권 외부에 있습니다.
VALIDATION_ERROR_LOW_ROAD_USAGE 경로의 도로 사용량이 적습니다 (통과하는 사람이 매우 적음).

메서드

batchCreate

 여러 SelectedRoute를 만들고 각 경로의 캐시 정보를 주기적으로 가져오는 일정을 시작합니다.

create

 SelectedRoute를 만들고 경로의 캐시 정보를 주기적으로 가져오는 일정을 시작합니다.

delete

 지정된 프로젝트의 지정된 SelectedRoute를 삭제합니다.

get

 이름으로 지정된 SelectedRoute를 가져옵니다.

list

 지정된 프로젝트의 모든 SelectedRoutes를 페이지로 나누어 나열합니다.