Package google.maps.roads.selection.v1

색인

RoadsSelection

Roads Selection API의 서비스 정의입니다.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

여러 SelectedRoute 생성 요청입니다.

필드
parent

string

선택사항입니다. 선택한 모든 경로에서 공유되는 프로젝트 리소스입니다. 형식: projects/{project} 이 값이 설정된 경우 CreateSelectedRouteRequest 메시지의 상위 필드는 비어 있거나 이 필드와 일치해야 합니다.

requests[]

CreateSelectedRouteRequest

필수입니다. 생성할 선택된 경로를 지정하는 요청 메시지입니다. 선택한 경로를 최대 1,000개까지 일괄적으로 만들 수 있습니다.

BatchCreateSelectedRoutesResponse

여러 SelectedRoute를 생성한 후의 응답입니다.

필드
selected_routes[]

SelectedRoute

SelectedRoutes가 생성되었습니다.

CreateSelectedRouteRequest

SelectedRoute 생성 요청입니다.

필드
parent

string

필수입니다. SelectedRoute가 생성될 프로젝트입니다. 형식: projects/{project}

selected_route

SelectedRoute

필수입니다. 만들 SelectedRoute입니다.

selected_route_id

string

선택사항입니다. SelectedRoute에 사용할 ID이며, SelectedRoute의 리소스 이름의 마지막 구성요소가 됩니다.

이 값은 4~63자(영문 기준)여야 하며 유효한 문자는 'a-z', 'A-Z', '0-9' 또는 '-'입니다. 제공되지 않거나 비어 있으면 리소스 생성 후 UUID가 생성됩니다.

DeleteSelectedRouteRequest

SelectedRoute 삭제 요청입니다.

필드
name

string

필수입니다. 삭제할 SelectedRoute의 이름입니다. 형식: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

SelectedRoute을 가져오기 위한 요청입니다.

필드
name

string

필수입니다. 가져올 SelectedRoute의 이름입니다. 형식: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

SelectedRoute 목록을 요청합니다.

필드
parent

string

필수입니다. 모든 SelectedRoute가 쿼리될 프로젝트인 상위 요소입니다. 형식: projects/{project}/selectedRoutes

page_size

int32

선택사항입니다. 지정된 페이지에 반환되어야 하는 결과 수입니다. 설정하지 않으면 기본값은 100입니다. 값이 0이면 기본값으로 설정됩니다. 최댓값은 5,000이며, 5,000을 초과하는 값은 5,000으로 설정됩니다.

page_token

string

선택사항입니다. 이전 ListSelectedRoutes 호출에서 받은 페이지 토큰입니다.

ListSelectedRoutesResponse

SelectedRoute를 나열하는 응답입니다.

필드
selected_routes[]

SelectedRoute

요청에 지정된 프로젝트에 저장된 SelectedRoutes 페이지입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 없습니다.

SelectedRoute

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

필드
name

string

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

형식: projects/{project}/selectedRoutes/{selected_route}

display_name

string

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

create_time

Timestamp

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

state

State

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

route_attributes

map<string, string>

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

통합 필드 route_type. 현재 DynamicRoute만 지원됩니다. route_type은 다음 중 하나일 수 있습니다.
dynamic_route

DynamicRoute

SelectedRoute은 동적 경로입니다.

validation_error

ValidationError

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

DynamicRoute

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

필드
origin

LatLng

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

destination

LatLng

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

intermediates[]

LatLng

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

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

열거형
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 경로의 도로 사용량이 적습니다 (통과하는 사람이 매우 적음).