REST Resource: selection.v1.projects.selectedRoutes

Zasób: SelectedRoute

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

Zapis 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)
}
Pola
name

string

Identyfikator. Nazwa zasobu SelectedRoute.

Format: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

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

string (Timestamp format)

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

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
state

enum (State)

Tylko dane wyjściowe. Stan wybranej trasy.
routeAttributes

map (key: string, value: string)

Opcjonalnie. Atrybuty niestandardowe wybranej trasy. Dodanie ich umożliwia filtrowanie lub 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 znaku goog.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }
Pole zbiorcze route_type. Obecnie obsługiwana jest tylko forma DynamicRoute. route_type może mieć tylko jedną z tych wartości:
dynamicRoute

object (DynamicRoute)

Symbol SelectedRoute oznacza trasę dynamiczną.
validationError

enum (ValidationError)

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

DynamicRoute

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

Zapis JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Pola
origin

object (LatLng)

Wymagane. Miejsce początkowe trasy.
destination

object (LatLng)

Wymagane. Lokalizacja końcowa trasy.
intermediates[]

object (LatLng)

Opcjonalnie. Zestaw punktów pośrednich 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 między rzeczywistą trasą a trasą wyznaczoną przez aplikację.

LatLng

Obiekt reprezentujący parę szerokości i długości geograficznej. Jest to para liczb zmiennoprzecinkowych podwójnej precyzji, które reprezentują stopnie szerokości i długości geograficznej. O ile nie określono inaczej, ten obiekt musi być zgodny ze standardem WGS84. Wartości muszą mieścić się w znormalizowanych zakresach.

Zapis JSON 
{
  "latitude": number,
  "longitude": number
}
Pola
latitude

number

Szerokość geograficzna w stopniach. Musi mieścić się w zakresie od –90,0 do +90,0.
longitude

number

Długość geograficzna w stopniach. Musi mieścić się w zakresie [-180,0, +180,0].

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).

Metody

batchCreate

 Tworzy wiele zasobów SelectedRoute i uruchamia harmonogram okresowego pobierania informacji o pamięci podręcznej dla każdej trasy.

batchDelete

 Usuwa wiele zasobów SelectedRoute w określonym projekcie.

batchUpdate

 Aktualizuje wiele zasobów SelectedRoute określonych przez ich nazwy.

create

 Tworzy obiekt SelectedRoute i uruchamia harmonogram okresowego pobierania informacji o trasie z pamięci podręcznej.

delete

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

get

 Pobiera obiekt SelectedRoute o podanej nazwie.

list

 Wyświetla wszystkie zasoby SelectedRoute w określonym projekcie z podziałem na strony.

patch

 Aktualizuje obiekt SelectedRoute zgodnie z jego nazwą.