Package google.maps.roads.selection.v1

Indeks

RoadsSelection

Definicja usługi interfejsu Roads Selection API.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

Tworzy wiele obiektów SelectedRoute i uruchamia harmonogram, aby okresowo pobierać informacje z pamięci podręcznej dla każdej z tras.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

Tworzy obiekt SelectedRoute i uruchamia harmonogram okresowego pobierania informacji z pamięci podręcznej dotyczących trasy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

Usuwa określony element SelectedRoute z określonego projektu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

Pobiera obiekt SelectedRoute określony przez jego nazwę.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

Wyświetla listę wszystkich obiektów SelectedRoutes w określonym projekcie z podziałem na strony.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

BatchCreateSelectedRoutesRequest

Prośba o utworzenie wielu SelectedRoute.

Pola
parent

string

Opcjonalnie. Zasób projektu udostępniany przez wszystkie wybrane trasy. Format: projects/{project}. Jeśli to pole jest ustawione, pole nadrzędne w wiadomościach CreateSelectedRouteRequest musi być puste lub zgodne z tym polem.
requests[]

CreateSelectedRouteRequest

Wymagany. Wiadomość z prośbą o utworzenie wybranej trasy. W jednej partii można utworzyć maksymalnie 1000 wybranych tras.

BatchCreateSelectedRoutesResponse

Odpowiedź na utworzenie wielu SelectedRoute.

Pola
selected_routes[]

SelectedRoute

Utworzono SelectedRoutes.

CreateSelectedRouteRequest

Prośba o utworzenie SelectedRoute.

Pola
parent

string

Wymagany. Projekt, w którym zostanie utworzony SelectedRoute. Format: projects/{project}
selected_route

SelectedRoute

Wymagany. SelectedRoute do utworzenia.
selected_route_id

string

Opcjonalnie. Identyfikator do użycia w przypadku SelectedRoute, który stanie się ostatnim komponentem nazwy zasobu SelectedRoute.

Ta wartość powinna zawierać od 4 do 63 znaków, a prawidłowe znaki to: „a–z”, „A–Z”, „0–9” lub „-”. Jeśli nie zostanie podana lub będzie pusta, po utworzeniu zasobu zostanie wygenerowany identyfikator UUID.

DeleteSelectedRouteRequest

Prośba o usunięcie SelectedRoute.

Pola
name

string

Wymagany. Nazwa obiektu SelectedRoute do usunięcia. Format: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Prośba o uzyskanie SelectedRoute.

Pola
name

string

Wymagany. Nazwa SelectedRoute do pobrania. Format: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Prośba o wyświetlenie listy SelectedRoute.

Pola
parent

string

Wymagany. Element nadrzędny, czyli projekt, z którego będą wysyłane zapytania do wszystkich SelectedRoute. Format: projects/{project}/selectedRoutes
page_size

int32

Opcjonalnie. Liczba wyników, które powinny zostać zwrócone na danej stronie. Jeśli nie zostanie ustawiona, domyślna wartość to 100. Jeśli podasz wartość 0, zostanie ustawiona wartość domyślna. Maksymalna wartość to 5000. Każda wartość powyżej 5000 zostanie ustawiona na 5000.
page_token

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania ListSelectedRoutes.

ListSelectedRoutesResponse

Odpowiedź zawierająca listę SelectedRoute.

Pola
selected_routes[]

SelectedRoute

Strona SelectedRoutes zapisana w projekcie określonym w żądaniu.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli to pole jest puste, nie ma kolejnych stron.

SelectedRoute

Obiekt SelectedRoute reprezentuje konkretną trasę, dla której klient chce okresowo pobierać informacje (np. czas trwania) w przypadku zastosowań objętych umową.

Pola
name

string

Identyfikator. Nazwa zasobu SelectedRoute.

Format: projects/{project}/selectedRoutes/{selected_route}
display_name

string

Opcjonalnie. Wyświetlana nazwa trasy. Jest to pole opcjonalne, z którego może korzystać klient. Nie musi być niepowtarzalna.
create_time

Timestamp

Tylko dane wyjściowe. Czas pierwszego utworzenia wybranej trasy.
state

State

Tylko dane wyjściowe. Stan wybranej trasy.
route_attributes

map<string, string>

Opcjonalnie. Atrybuty niestandardowe wybranej trasy. Dodanie ich umożliwia filtrowanie i grupowanie tras podczas pobierania informacji o trasach historycznych i w czasie rzeczywistym. Każda trasa może mieć maksymalnie 10 atrybutów. Każdy klucz i każda wartość powinny być niepustym ciągiem znaków i mogą mieć maksymalnie 100 znaków. Klucze nie mogą zaczynać się od „goog”.
Pole unii route_type. Obecnie obsługiwana jest tylko wartość DynamicRoute. route_type może mieć tylko jedną z tych wartości:
dynamic_route

DynamicRoute

Symbol SelectedRoute oznacza trasę dynamiczną.
validation_error

ValidationError

Tylko dane wyjściowe. Błąd weryfikacji wybranej trasy, gdy stan to STATE_INVALID.

DynamicRoute

Reprezentuje trasę z punktami pośrednimi (miejsce wyjazdu, miejsce docelowe i punkty pośrednie). Rzeczywista trasa na pewno będzie przebiegać przez wszystkie punkty pośrednie, ale może się od czasu do czasu zmieniać ze względu na różne warunki ruchu.

Pola
origin

LatLng

Wymagany. Miejsce rozpoczęcia trasy.
destination

LatLng

Wymagany. Lokalizacja końcowa trasy.
intermediates[]

LatLng

Opcjonalnie. Zestaw pośrednich punktów na trasie (z wyłączeniem punktów końcowych). Są to zawsze punkty przejazdu. Obsługiwanych jest maksymalnie 25 punktów pośrednich. Prawidłowe dodanie tych informacji może zmniejszyć różnice w rzeczywistej trasie.

Stan

Stan wybranej trasy.

Wartości w polu enum
STATE_UNSPECIFIED Stan tej trasy nie jest ustawiony.
STATE_SCHEDULING Trasa została utworzona i jest planowana.
STATE_RUNNING Trasa została utworzona i ma aktywny harmonogram.
STATE_DELETING Trasa została oznaczona do usunięcia.
STATE_VALIDATING Trasa jest w trakcie weryfikacji.
STATE_INVALID Trasa jest nieprawidłowa ze względu na jedno z kryteriów weryfikacji.

ValidationError

Błąd weryfikacji wybranej trasy.

Wartości w polu enum
VALIDATION_ERROR_UNSPECIFIED Błąd weryfikacji tej trasy nie jest ustawiony.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION Trasa znajduje się poza jurysdykcją projektu.
VALIDATION_ERROR_LOW_ROAD_USAGE Trasa jest mało uczęszczana (przejeżdża nią bardzo mało osób).