Package maps.fleetengine.v1

Indeks

TripService

usługi zarządzania podróżami,

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Tworzy przejazd w Fleet Engine i zwraca nowy przejazd.
DeleteTrip

rpc DeleteTrip(DeleteTripRequest) returns (Empty)

Usuwa pojedynczą podróż.

Zwraca wartość FAILED_PRECONDITION, jeśli przejazd jest aktywny i przypisany do pojazdu.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Uzyskiwanie informacji o pojedynczej podróży.
ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Raportowanie wykorzystania płatnych przejazdów.
SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

Pobierz wszystkie przejazdy konkretnego pojazdu.
UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

Aktualizuje dane podróży.

VehicleService

usługi zarządzania pojazdami,

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Tworzy nowy pojazd powiązany z dostawcą usług przewozu osób na żądanie lub dostaw. Każdy Vehicle musi mieć unikalny identyfikator pojazdu.

Podczas tworzenia Vehicle wymagane są te pola Vehicle:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Podczas tworzenia Vehicle ignorowane są te pola Vehicle:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Wszystkie pozostałe pola są opcjonalne i używane, jeśli są wypełnione.
DeleteVehicle

rpc DeleteVehicle(DeleteVehicleRequest) returns (Empty)

Usuwa pojazd z Fleet Engine.

Zwraca błąd FAILED_PRECONDITION, jeśli pojazd ma aktywne przejazdy. przypisane do niego.
GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Zwraca pojazd z Fleet Engine.
ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

Zwraca podzieloną na strony listę pojazdów powiązanych z dostawcą, które pasują do opcji żądania.
SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Zwraca listę pojazdów, które pasują do opcji żądania.
UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

Zapisuje zaktualizowane dane pojazdu w Fleet Engine.

Podczas aktualizowania Vehicle nie można zmieniać tych pól, ponieważ są one zarządzane przez serwer:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

Nie można też zaktualizować pojazdu name.

Jeśli pole attributes zostanie zaktualizowane, wszystkie atrybuty pojazdu zostaną zastąpione atrybutami podanymi w żądaniu. Jeśli chcesz zaktualizować tylko niektóre atrybuty, zapoznaj się z metodą UpdateVehicleAttributes. Podobnie pole waypoints można zaktualizować, ale musi ono zawierać wszystkie punkty pośrednie, które są obecnie w pojeździe, i żadne inne.
UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

Częściowo aktualizuje atrybuty pojazdu. Zostaną zaktualizowane tylko atrybuty wymienione w żądaniu. Pozostałe atrybuty NIE zostaną zmienione. Uwaga: w przypadku UpdateVehicle jest to inne, ponieważ całe pole attributes zostanie zastąpione polem w UpdateVehicleRequest, a atrybuty, których nie ma w żądaniu, zostaną usunięte.

BatteryInfo

Informacje o baterii urządzenia.

Pola
battery_status

BatteryStatus

stan baterii, np. czy jest naładowana lub czy się ładuje;
power_source

PowerSource

Stan źródła zasilania bateryjnego.
battery_percentage

float

Aktualny poziom baterii [0–100].

BatteryStatus

stan baterii, np. czy jest naładowana lub czy się ładuje;

Wartości w polu enum
UNKNOWN_BATTERY_STATUS Stan baterii jest nieznany.
BATTERY_STATUS_CHARGING Bateria jest ładowana.
BATTERY_STATUS_DISCHARGING Bateria się rozładowuje.
BATTERY_STATUS_FULL Bateria jest naładowana.
BATTERY_STATUS_NOT_CHARGING Bateria się nie ładuje.
BATTERY_STATUS_POWER_LOW Bateria jest słaba.

BillingPlatformIdentifier

Zestaw wartości wskazujących, na której platformie zostało wysłane żądanie.

Wartości w polu enum
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED Domyślny: Używany w przypadku nieokreślonych platform.
SERVER Platforma jest serwerem klienta.
WEB Platformą jest przeglądarka.
ANDROID Platformą jest urządzenie mobilne z Androidem.
IOS Platformą jest urządzenie mobilne z iOS.
OTHERS Inne platformy, które nie są wymienione w tym wyliczeniu.

ConsumableTrafficPolyline

Gęstość ruchu na trasie pojazdu.

Pola
speed_reading_interval[]

SpeedReadingInterval

Prędkość ruchu na odcinku od poprzedniego do bieżącego punktu trasy.
encoded_path_to_waypoint

string

Ścieżka, którą kierowca pokonuje od poprzedniego punktu do obecnego. Ta ścieżka zawiera punkty orientacyjne, dzięki czemu klienci mogą wyświetlać na niej znaczniki ruchu (patrz speed_reading_interval). Dekodowanie nie jest jeszcze obsługiwane.

CreateTripRequest

Wiadomość z prośbą o utworzenie przejazdu.

Pola
header

RequestHeader

Standardowy nagłówek żądania Fleet Engine.
parent

string

Wymagany. Musi mieć format providers/{provider}. Dostawcą musi być identyfikator projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi dokonujące tego wywołania.
trip_id

string

Wymagany. Unikalny identyfikator przejazdu. Z zastrzeżeniem tych ograniczeń:

  • Musi to być prawidłowy ciąg znaków Unicode.
  • Maksymalna długość to 64 znaki.
  • Znormalizowane zgodnie z formą normalizacji Unicode C.
  • Nie może zawierać żadnego z tych znaków ASCII: „/”, „:”, „?”, „,” ani „#”.
trip

Trip

Wymagany. Encja podróży do utworzenia.

Podczas tworzenia wycieczki wymagane są te pola:

  • trip_type
  • pickup_point

Jeśli podasz te pola, zostaną one użyte:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Wszystkie pozostałe pola Trip są ignorowane. Na przykład wszystkie podróże zaczynają się od trip_status o wartości NEW, nawet jeśli w żądaniu utworzenia podasz trip_status o wartości CANCELED.

Tylko przejazdy EXCLUSIVE obsługują intermediate_destinations.

Jeśli w przypadku wspólnego przejazdu ustawisz wartość vehicle_id, musisz podać listę Trip.vehicle_waypoints, aby określić kolejność pozostałych punktów na trasie pojazdu. W przeciwnym razie kolejność punktów na trasie będzie nieokreślona.

Jeśli określisz Trip.vehicle_waypoints, lista musi zawierać wszystkie pozostałe punkty trasy przejazdów pojazdu bez dodatkowych punktów. Musisz uporządkować te punkty w taki sposób, aby w przypadku danej podróży punkt odbioru znajdował się przed miejscami docelowymi, a wszystkie miejsca docelowe znajdowały się przed punktem docelowym. Punkty pośrednie podróży EXCLUSIVE nie mogą się przeplatać z punktami pośrednimi innych podróży.

Używane są pola trip_id, waypoint_type i location, a wszystkie pozostałe pola TripWaypoint w vehicle_waypoints są ignorowane.

CreateVehicleRequest

CreateVehicle wiadomość z prośbą.

Pola
header

RequestHeader

Standardowy nagłówek żądania Fleet Engine.
parent

string

Wymagany. Musi mieć format providers/{provider}. Dostawcą musi być identyfikator projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi dokonujące tego wywołania.
vehicle_id

string

Wymagany. Unikalny identyfikator pojazdu. Z zastrzeżeniem tych ograniczeń:

  • Musi to być prawidłowy ciąg znaków Unicode.
  • Maksymalna długość to 64 znaki.
  • Znormalizowane zgodnie z formą normalizacji Unicode C.
  • Nie może zawierać żadnego z tych znaków ASCII: „/”, „:”, „?”, „,” ani „#”.
vehicle

Vehicle

Wymagany. Jednostka pojazdu do utworzenia. Podczas tworzenia obiektu Vehicle wymagane są te pola:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Podczas tworzenia pojazdu te pola są ignorowane:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Wszystkie pozostałe pola są opcjonalne i używane, jeśli są wypełnione.

DeleteTripRequest

Wiadomość z prośbą DeleteTrip.

Pola
header

RequestHeader

Opcjonalnie. Standardowy nagłówek żądania Fleet Engine.
name

string

Wymagany. Musi mieć format providers/{provider}/trips/{trip}. Dostawcą musi być identyfikator projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi dokonujące tego wywołania.

DeleteVehicleRequest

Komunikat żądania DeleteVehicle.

Pola
header

RequestHeader

Opcjonalnie. Standardowy nagłówek żądania Fleet Engine.
name

string

Wymagany. Musi mieć format providers/{provider}/vehicles/{vehicle}. {provider} musi być identyfikatorem projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi dokonujące tego wywołania.

DeviceSettings

Informacje o różnych ustawieniach na urządzeniu mobilnym.

Pola
location_power_save_mode

LocationPowerSaveMode

Jak funkcje lokalizacji mają działać na urządzeniu, gdy włączone jest oszczędzanie baterii.
is_power_save_mode

bool

Informacja, czy urządzenie jest obecnie w trybie oszczędzania energii.
is_interactive

bool

Czy urządzenie jest w stanie interaktywnym.
battery_info

BatteryInfo

Informacje o stanie baterii.

GetTripRequest

Wiadomość z prośbą GetTrip.

Pola
header

RequestHeader

Standardowy nagłówek żądania Fleet Engine.
name

string

Wymagany. Musi mieć format providers/{provider}/trips/{trip}. Dostawcą musi być identyfikator projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi dokonujące tego wywołania.
view

TripView

Podzbiór pól podróży, które mają zostać zwrócone, i ich interpretacja.
current_route_segment_version

Timestamp

Wskazuje minimalną sygnaturę czasową (wyłączną), dla której pobierane są dane Trip.route lub Trip.current_route_segment. Jeśli dane trasy nie uległy zmianie od tej sygnatury czasowej, pole trasy nie jest ustawione w odpowiedzi. Jeśli nie podano wartości minimalnej, dane trasy są zawsze pobierane.
remaining_waypoints_version
(deprecated)

Timestamp

Wycofane: zawsze pobierane są wartości Trip.remaining_waypoints. Użyj ikony remaining_waypoints_route_version, aby określić, kiedy mają być pobierane dane Trip.remaining_waypoints.traffic_to_waypoint i Trip.remaining_waypoints.path_to_waypoint.
route_format_type

PolylineFormatType

Zwracany format bieżącej trasy: LAT_LNG_LIST_TYPE (w Trip.route) lub ENCODED_POLYLINE_TYPE (w Trip.current_route_segment). Domyślnie jest to LAT_LNG_LIST_TYPE.
current_route_segment_traffic_version

Timestamp

Wskazuje minimalną sygnaturę czasową (wyłączną), dla której pobierana jest wartość Trip.current_route_segment_traffic. Jeśli dane o ruchu nie uległy zmianie od tej sygnatury czasowej, w odpowiedzi nie jest ustawione pole current_route_segment_traffic. Jeśli nie podano wartości minimalnej, dane o ruchu są zawsze pobierane. Pamiętaj, że dane o ruchu są dostępne tylko dla klientów korzystających z usługi Przejazdy i dostawy na żądanie.
remaining_waypoints_route_version

Timestamp

Wskazuje minimalny sygnaturę czasową (wyłączną), dla której pobierane są dane Trip.remaining_waypoints.traffic_to_waypoint i Trip.remaining_waypoints.path_to_waypoint. Jeśli od tego momentu dane nie uległy zmianie, w odpowiedzi nie są ustawiane powyższe pola. Jeśli parametr remaining_waypoints_route_version nie jest określony, ruch i ścieżka są zawsze pobierane.

GetVehicleRequest

GetVehicle wiadomość z prośbą.

Pola
header

RequestHeader

Standardowy nagłówek żądania Fleet Engine.
name

string

Wymagany. Musi mieć format providers/{provider}/vehicles/{vehicle}. Dostawcą musi być identyfikator projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi dokonujące tego wywołania.
current_route_segment_version

Timestamp

Wskazuje minimalną sygnaturę czasową (wyłączną), dla której pobierana jest wartość Vehicle.current_route_segment. Jeśli trasa nie uległa zmianie od tego momentu, w odpowiedzi nie jest ustawione pole current_route_segment. Jeśli nie podano wartości minimalnej, zawsze pobierana jest wartość current_route_segment.
waypoints_version

Timestamp

Wskazuje minimalny sygnaturę czasową (wyłączną), dla której pobierane są dane Vehicle.waypoints. Jeśli punkty pośrednie nie uległy zmianie od tej sygnatury czasowej, w odpowiedzi nie są ustawiane dane vehicle.waypoints. Jeśli to pole nie zostanie określone, zawsze pobierana jest wartość vehicle.waypoints.

LicensePlate

Informacje o tablicy rejestracyjnej pojazdu. Aby uniknąć przechowywania informacji umożliwiających identyfikację, w ramach podmiotu przechowywane są tylko minimalne informacje o tablicy rejestracyjnej.

Pola
country_code

string

Wymagany. Kod kraju/regionu CLDR. Na przykład US w przypadku Stanów Zjednoczonych lub IN w przypadku Indii.
last_character

string

Ostatnia cyfra numeru rejestracyjnego lub „-1”, jeśli w numerze rejestracyjnym nie ma wartości liczbowej.

  • „ABC 1234” -> „4”
  • „AB 123 CD” -> „3”
  • „ABCDEF” -> „-1”

ListVehiclesRequest

ListVehicles wiadomość z prośbą.

Pola
header

RequestHeader

Standardowy nagłówek żądania Fleet Engine.
parent

string

Wymagany. Musi mieć format providers/{provider}. Dostawcą musi być identyfikator projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi dokonujące tego wywołania.
page_size

int32

Maksymalna liczba pojazdów do zwrócenia. Wartość domyślna: 100.
page_token

string

Wartość parametru next_page_token podana przez poprzednie wywołanie funkcji ListVehicles, aby można było przechodzić między grupami pojazdów. Wartość jest niezdefiniowana, jeśli kryteria filtra żądania nie są takie same jak kryteria filtra poprzedniego wywołania funkcji ListVehicles.
minimum_capacity

Int32Value

Określa wymaganą minimalną pojemność pojazdu. Wszystkie zwrócone pojazdy będą miały wartość maximum_capacity równą lub większą od tej wartości. Jeśli jest ustawiona, musi być większa od lub równa 0.
trip_types[]

TripType

Ogranicza odpowiedź do pojazdów, które obsługują co najmniej 1 z określonych typów przejazdu.
maximum_staleness

Duration

Ogranicza odpowiedź do pojazdów, które w określonym czasie wysłały do Fleet Engine aktualizacje lokalizacji. Pojazdy stacjonarne, które nadal przesyłają swoje lokalizacje, nie są uważane za nieaktualne. Jeśli jest podany, musi być prawidłowym dodatnim czasem trwania.
vehicle_type_categories[]