REST Resource: projects.trips

Zasób: Trip

podróż,

Zapis JSON
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
Pola
name

string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu podróży. Format: projects/{numer_projektu}/trips/{tripId}.

config

object (TripConfig)

Niezmienna. Konfiguracja wycieczki.

androidAppId

string

Tylko dane wejściowe. Niezmienna. Identyfikator aplikacji na Androida, która będzie korzystać z przejazdu. Musisz ustawić co najmniej jedną z tych właściwości: androidAppId lub iosAppId.

iosAppId

string

Tylko dane wejściowe. Niezmienna. Identyfikator pakietu iOS aplikacji mobilnej, która będzie korzystać z przejazdu. Musisz ustawić co najmniej jedną z tych właściwości: androidAppId lub iosAppId.

authToken

object (AuthToken)

Tylko dane wyjściowe. Nieprzezroczysty token, który autoryzuje rozpoczęcie podróży w NavConnect w Mapach Google lub Waze i przyznaje tym aplikacjom dostęp do aktualizowania podróży. Zwracany tylko przez trips.create.

state

enum (State)

Tylko dane wyjściowe. Stan podróży.

execution

object (TripExecution)

Tylko dane wyjściowe. Najnowsze dane dotyczące realizacji podróży. Może nie być ustawiona, jeśli przejazd jest w stanie błędu.

createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia przejazdu na serwerze.

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

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym serwer otrzymał najnowszą aktualizację przejazdu.

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

TripConfig

Konfiguracja wycieczki.

Zapis JSON
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string
}
Pola
enableHighFrequencyUpdates

boolean

Opcjonalnie. Czy włączyć bardzo częste aktualizacje przejazdów.

UWAGA: włączenie tej funkcji powoduje rejestrowanie przejazdu w ramach korzystania z usługi na poziomie Enterprise i podlega stawkom obowiązującym na tym poziomie.

enablePubsub

boolean

Opcjonalnie. Czy włączyć powiadomienia Pub/Sub dotyczące przejazdu.

pubsubFieldMask

string (FieldMask format)

Opcjonalnie. Jeśli ta opcja jest ustawiona, w powiadomieniach pubsub będzie uwzględniany tylko określony podzbiór pól podróży.

Jeśli nie ustawisz tego pola, wszystkie pola obiektu Trip będą uwzględniane w powiadomieniach Pub/Sub (domyślne działanie).

Następujące pola nie są obsługiwane:

  • androidAppId
  • iosAppId
  • authToken
  • config

UWAGA: to pole jest ignorowane, jeśli wartość enablePubsub to „false”.

Jest to lista w pełni kwalifikowanych nazw pól rozdzielona przecinkami. Przykład: "user.displayName,photo".

AuthToken

Token uwierzytelniania.

Zapis JSON
{
  "token": string,
  "expireTime": string
}
Pola
token

string

Tylko dane wyjściowe. Token uwierzytelniania, który należy przekazać do aplikacji mobilnej.

expireTime

string (Timestamp format)

Tylko dane wyjściowe. Czas wygaśnięcia tokena uwierzytelniania.

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

Stan

Wszystkie możliwe stany przejazdu.

Wartości w polu enum
STATE_UNSPECIFIED Stan przejazdu jest nieokreślony.
NEW Podróż została utworzona, ale jeszcze się nie rozpoczęła.
ENROUTE Przewoźnik jest w drodze do miejsca docelowego.
ARRIVED Przewoźnik dotarł do miejsca docelowego.
SUSPENDED Podróż została zawieszona.
FAILED Nie udało się ukończyć przejazdu.
CLIENT_ERROR Przejazd nie powiódł się z powodu błędu klienta.

TripExecution

Dane dotyczące realizacji przejazdu.

Zapis JSON
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
Pola
origin

object (Location)

Tylko dane wyjściowe. Miejsce rozpoczęcia podróży, które jest zwykle lokalizacją przewoźnika na początku podróży NavConnect.

destination

object (Stop)

Tylko dane wyjściowe. Miejsce docelowe podróży podane przez aplikację mobilną.

location

object (Location)

Tylko dane wyjściowe. Sygnał lokalizacji reprezentujący ostatnią znaną lokalizację przewoźnika. Jeśli jest dostępna, będzie to lokalizacja przyciągnięta do drogi.

traveledDuration

string (Duration format)

Tylko dane wyjściowe. Czas podróży do tej pory.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

remainingDuration

string (Duration format)

Tylko dane wyjściowe. Szacowany przez Google czas pozostały do końca podróży.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

traveledDistanceMeters

integer

Tylko dane wyjściowe. Odległość pokonana od punktu początkowego w metrach.

remainingDistanceMeters

integer

Tylko dane wyjściowe. Pozostała odległość do miejsca docelowego w metrach.

stopAddedInRoute

boolean

Tylko dane wyjściowe. Wskazuje, czy na trasie dodano przystanek.

Lokalizacja

Lokalizacja zgłoszona przez aplikację mobilną.

Zapis JSON
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
Pola
point

object (LatLng)

Tylko dane wyjściowe. Szerokość i długość geograficzna lokalizacji.

sourceTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym lokalizacja została pozyskana, zgodnie z informacjami podanymi przez klienta.

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

serverTime

string (Timestamp format)

Tylko dane wyjściowe. Godzina, o której serwer otrzymał tę informację o zmianie lokalizacji.

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

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 od –180,0 do +180,0.

Zatrzymaj

Przystanek w podróży, na którym należy wykonać jakieś zadanie.

Zapis JSON
{
  "point": {
    object (LatLng)
  }
}
Pola
point

object (LatLng)

Wymagane. Lokalizacja przystanku w postaci szerokości i długości geograficznej.

Metody

create

Tworzy podróż.

get

Otrzymuje przejazd.