REST Resource: selection.v1.projects.selectedRoutes

Zasób: SelectedRoute

SelectedRoute reprezentuje konkretną trasę, dla której klient chce okresowo pobierać informacje (np. czas trwania) w przypadkach użycia objętych umową.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
Pola
name

string

Identyfikator. Nazwa zasobu SelectedRoute.

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

string

Opcjonalnie: Wyświetlana nazwa trasy. To pole jest opcjonalne i może być używane przez klienta. Nie musi być unikalna. Długość jest ograniczona do 100 znaków (liczonych w punktach kodowych Unicode).
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas 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. W przypadku każdej trasy obsługiwanych jest maksymalnie 25 atrybutów. Każdy klucz i wartość powinny być niepustym ciągiem znaków i mogą zawierać maksymalnie 100 znaków (liczonych w punktach kodowych Unicode). Klucze nie mogą zaczynać się od goog.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }
Obsługiwana jest tylko wartość DynamicRoute. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
dynamicRoute

object (DynamicRoute)

SelectedRoute to trasa dynamiczna.
Koniec pól wykluczających się wzajemnie.
validationError

enum (ValidationError)

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

boolean

Opcjonalnie: Jeśli ustawisz wartość true, wybrana trasa może być dynamicznie zmieniana na podstawie informacji o natężeniu ruchu w czasie rzeczywistym zgodnie z wprowadzonymi punktami orientacyjnymi. Jeśli ustawisz wartość false, wybrana trasa będzie stałą trasą, która nie uwzględnia natężenia ruchu i podąża ścieżką obliczoną w momencie tworzenia. Jeśli nie zostanie podana, domyślnie będzie to false, co oznacza, że jest to stała trasa.

DynamicRoute

Reprezentuje trasę z punktami pośrednimi (początek, miejsce docelowe i punkty pośrednie). Rzeczywista trasa na pewno będzie przebiegać przez wszystkie punkty pośrednie. Jeśli parametr dynamicRouting ma wartość false, rzeczywista trasa pozostaje niezmieniona niezależnie od warunków na drodze. Jeśli parametr dynamicRouting ma wartość true, rzeczywista trasa może się zmieniać w zależności od warunków na drodze.

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

object (LatLng)

Wymagane. Lokalizacja początkowa trasy.
destination

object (LatLng)

Wymagane. Lokalizacja końcowa trasy.
intermediates[]

object (LatLng)

Opcjonalnie: Zbiór punktów pośrednich na trasie (z wyłączeniem punktów końcowych). Zawsze są to punkty, przez które przejeżdżasz. 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ą wyświetlaną okresowo.

LatLng

Obiekt reprezentujący parę szerokości i długości geograficznej. Jest ona wyrażona jako 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 [-90,0, +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 na podstawie jednego 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 jest poza jurysdykcją projektu.
VALIDATION_ERROR_LOW_ROAD_USAGE Trasa jest rzadko używana (korzysta z niej bardzo mało osób).

Metody

batchCreate

 Tworzy wiele zasobów SelectedRoute i uruchamia harmonogram, aby okresowo pobierać informacje 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 SelectedRoute i uruchamia harmonogram okresowego pobierania informacji z pamięci podręcznej dotyczących trasy.

delete

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

get

 Pobiera SelectedRoute określony przez jego nazwę.

list

 Wyświetla listę wszystkich zasobów SelectedRoute w określonym projekcie ze stronicowaniem.

patch

 Aktualizuje SelectedRoute zgodnie z podaną nazwą.