Package google.maps.mapmanagement.v2alpha

Indeks

MapManagement

Interfejs API zarządzania mapami obsługuje operacje CRUD na zasobach definiowania stylów map w Google Cloud: MapConfigs, StyleConfigs i MapContextConfigs. Ten interfejs API umożliwia programistom zarządzanie wyglądem map i dostosowywanie ich do własnych potrzeb.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

Tworzy w projekcie MapConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

Tworzy obiekt MapContextConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

Tworzy obiekt StyleConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

Usuwa konfigurację mapy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

Usuwa konfigurację MapContextConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

Usuwa konfigurację stylu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

Pobiera obiekt MapConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

Pobiera obiekt MapContextConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

Pobiera konfigurację stylu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

Wyświetla listę obiektów MapConfig w projekcie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

Wyświetla listę obiektów MapContextConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

Wyświetla listę obiektów StyleConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

Aktualizuje konfigurację mapy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

Aktualizuje konfigurację MapContextConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

Aktualizuje obiekt StyleConfig.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

CreateMapConfigRequest

Prośba o utworzenie pliku MapConfig.

Pola
parent

string

Wymagane. Projekt nadrzędny, do którego będzie należeć MapConfig. Format: projects/{$my-project-id}
map_config

MapConfig

Wymagane. Obiekt MapConfig do utworzenia.

CreateMapContextConfigRequest

Prośba o utworzenie obiektu MapContextConfig.

Pola
parent

string

Wymagane. Nadrzędna konfiguracja MapConfig, która będzie właścicielem konfiguracji MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

Wymagane. Obiekt MapContextConfig do utworzenia.

CreateStyleConfigRequest

Prośba o utworzenie elementu StyleConfig.

Pola
parent

string

Wymagane. Projekt nadrzędny, do którego będzie należeć StyleConfig. Format: projects/{project}
style_config

StyleConfig

Wymagane. Obiekt StyleConfig do utworzenia.

DeleteMapConfigRequest

Prośba o usunięcie pliku MapConfig. Jeśli MapConfig zawiera jakiekolwiek podrzędne MapContextConfig, one również zostaną usunięte.

Pola
name

string

Wymagane. Nazwa zasobu MapConfig do usunięcia. Format: projects/{project}/mapConfigs/{map_config}
force

bool

Opcjonalnie. Jeśli ma wartość „true”, wszystkie obiekty MapContextConfig z tego obiektu MapConfig również zostaną usunięte. (W przeciwnym razie żądanie będzie działać tylko wtedy, gdy MapConfig nie zawiera MapContextConfigs).

DeleteMapContextConfigRequest

Prośba o usunięcie obiektu MapContextConfig.

Pola
name

string

Wymagane. Nazwa zasobu MapContextConfig do usunięcia. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Prośba o usunięcie elementu StyleConfig.

Pola
name

string

Wymagane. Nazwa zasobu StyleConfig, który chcesz usunąć. Format: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Prośba o pobranie konfiguracji MapConfig.

Pola
name

string

Wymagane. Nazwa zasobu MapConfig. Format: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Prośba o pobranie obiektu MapContextConfig.

Pola
name

string

Wymagane. Nazwa zasobu MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Żądanie pobrania obiektu StyleConfig.

Pola
name

string

Wymagane. Nazwa zasobu StyleConfig. Format: projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Prośba o wyświetlenie listy MapConfigs.

Pola
parent

string

Wymagane. Projekt nadrzędny, do którego należą MapConfigs. Format: projects/{project}
page_size

int32

Opcjonalnie. Maksymalna liczba zwracanych obiektów MapConfig. Usługa może zwrócić mniej niż ta wartość. Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 50 obiektów MapConfig. Maksymalna wartość to 1000. Wartości powyżej 1000 zostaną zmienione na 1000. OBECNIE NIEOBSŁUGIWANE.
page_token

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania ListMapConfigs. Podaj ten token, aby pobrać kolejną stronę.

Podczas paginacji wszystkie inne parametry przekazane do funkcji ListMapConfigs muszą być zgodne z wywołaniem, które dostarczyło token strony. OBECNIE NIEOBSŁUGIWANE.

ListMapConfigsResponse

Odpowiedź na żądanie wyświetlenia listy konfiguracji mapy.

Pola
map_configs[]

MapConfig

Lista MapConfig.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron. OBECNIE NIEOBSŁUGIWANE.

ListMapContextConfigsRequest

Prośba o wyświetlenie listy MapContextConfigs.

Pola
parent

string

Wymagane. Nadrzędna konfiguracja MapConfig, która jest właścicielem konfiguracji MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}
page_size

int32

Opcjonalnie. Maksymalna liczba zwracanych obiektów MapContextConfig. Usługa może zwrócić mniej niż ta wartość. Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 50 obiektów MapContextConfig. Maksymalna wartość to 1000. Wartości powyżej 1000 zostaną zmienione na 1000. OBECNIE NIEOBSŁUGIWANE.
page_token

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania ListMapContextConfigs. Podaj ten token, aby pobrać kolejną stronę.

Podczas paginacji wszystkie inne parametry przekazane do funkcji ListMapContextConfigs muszą być zgodne z wywołaniem, które dostarczyło token strony. OBECNIE NIEOBSŁUGIWANE.

ListMapContextConfigsResponse

Odpowiedź na żądanie wyświetlenia listy konfiguracji MapContextConfig.

Pola
map_context_configs[]

MapContextConfig

MapContextConfigs.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron. OBECNIE NIEOBSŁUGIWANE.

ListStyleConfigsRequest

Żądanie wyświetlenia listy StyleConfigs.

Pola
parent

string

Wymagane. Projekt nadrzędny, do którego należą StyleConfigs. Format: projects/{project}
page_size

int32

Opcjonalnie. Maksymalna liczba zwracanych obiektów StyleConfig. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwracanych będzie maksymalnie 50 obiektów StyleConfig. Maksymalna wartość to 1000. Wartości powyżej 1000 zostaną zmienione na 1000. OBECNIE NIEOBSŁUGIWANE.
page_token

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania ListStyleConfigs. Podaj ten token, aby pobrać kolejną stronę.

Podczas paginacji wszystkie inne parametry przekazane do funkcji ListStyleConfigs muszą być zgodne z wywołaniem, które dostarczyło token strony. OBECNIE NIEOBSŁUGIWANE.
filter

string

Opcjonalnie. Wyrażenie filtra dla wywołania ListStyleConfigs. Obecnie obsługuje tylko filtrowanie według pola display_name. Przykład: display_name="My StyleConfig" zwróci wszystkie obiekty StyleConfig o wyświetlanej nazwie „My StyleConfig”.
view

StyleConfigView

Opcjonalnie. Podzbiór elementu StyleConfig do zwrócenia. Jeśli to pole nie jest ustawione, domyślnie zwracany jest widok FULL.

ListStyleConfigsResponse

Odpowiedź na żądanie wyświetlenia listy konfiguracji stylu.

Pola
style_configs[]

StyleConfig

StyleConfigs.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron. OBECNIE NIEOBSŁUGIWANE.

MapConfig

Reprezentuje pojedynczą mapę w aplikacji klienckiej interfejsu API Map Google. MapConfig jest zasobem nadrzędnym dla MapContextConfigs i umożliwia dostosowywanie stylów w pakietach SDK (na urządzenia mobilne i do internetu). Obiekt MapConfig może zawierać wiele obiektów MapContextConfig, z których każdy stosuje styl do określonych wariantów mapy. Next ID = 9;

Pola
name

string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu tego obiektu MapConfig. Na przykład: „projects/my-project-123/mapConfigs/234”. Tylko dane wyjściowe.
display_name

string

Opcjonalnie. Wyświetlana nazwa tej konfiguracji MapConfig określona przez użytkownika.
description

string

Opcjonalnie. Opis tej konfiguracji MapConfig określony przez użytkownika.
map_id

string

Tylko dane wyjściowe. Identyfikator mapy w tym obiekcie MapConfig, który służy do identyfikowania mapy w aplikacjach klienckich. To pole tylko do odczytu jest generowane podczas tworzenia pliku MapConfig. Tylko dane wyjściowe.
map_features

MapFeatures

Opcjonalnie. Funkcje mapy, które mają zastosowanie do tej konfiguracji mapy.
map_type

MapRenderingType

Opcjonalnie. Reprezentuje typ mapy w konfiguracji mapy. Jeśli ta opcja nie jest ustawiona, domyślnie używany jest typ mapy rastrowej.
create_time

Timestamp

Tylko dane wyjściowe. Określa czas utworzenia konfiguracji mapy. Tylko dane wyjściowe.
update_time

Timestamp

Tylko dane wyjściowe. Oznacza czas ostatniej aktualizacji konfiguracji mapy. Tylko dane wyjściowe.

MapContextConfig

Zawiera konfigurację stylu mapy. Element MapContextConfig łączy komponenty stylów, takie jak StyleConfig i zbiory danych, z konkretnymi wariantami mapy w obiekcie MapConfig. Gdy MapConfig zostanie wczytany w pakiecie SDK, informacje o stylu i zbiorze danych z MapContextConfig zostaną zastosowane do określonych wariantów mapy. Next ID = 10;

Pola
name

string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu tej konfiguracji MapContextConfig. Przykład: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

Wymagane. Nazwa zasobu MapConfig, z którym jest powiązana ta konfiguracja MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}. To pole jest wymagane i nie można go pominąć.
style_config

string

Wymagane. Nazwa zasobu StyleConfig, który określa styl tego elementu MapContextConfig. To pole jest wymagane i nie można go pominąć. Format: projects/{project}/styleConfigs/{style_config}
dataset[]

string

Opcjonalnie. Nazwa zasobu zbioru danych powiązanego z tym obiektem MapContextConfig. To pole jest opcjonalne i można je pominąć. Jeśli ten parametr zostanie pominięty, ze zbiorem danych MapContextConfig nie będą powiązane żadne zbiory danych. Jeśli określony jest zbiór danych, zostanie on zastosowany do MapContextConfig. Format: projects/{project}/datasets/{dataset}
alias

string

Opcjonalnie. Zdefiniowana przez użytkownika nazwa tej konfiguracji MapContextConfig, która jest czytelna dla człowieka.
map_variants[]

MapVariant

Wymagane. Warianty mapy, do których można zastosować ten element MapContextConfig. Jeśli jest pusta, konfiguracja MapContextConfig zostanie domyślnie zastosowana tylko do wariantu mapy ROADMAP.
create_time

Timestamp

Tylko dane wyjściowe. Oznacza czas utworzenia konfiguracji MapContextConfig. Tylko dane wyjściowe.
update_time

Timestamp

Tylko dane wyjściowe. Oznacza czas ostatniej aktualizacji obiektu MapContextConfig. Tylko dane wyjściowe.

MapVariant

Możliwe warianty mapy, do których można zastosować MapContextConfig. Warianty mapy są podzielone na warianty jasne i ciemne. Wariant jasny nie może być sparowany z wariantem ciemnym w przypadku tej samej konfiguracji MapContextConfig. Dostępne warianty to: ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D, PHOTOREALISTIC3D. Warianty ciemne to: ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK, TRANSIT_DARK.

Prawidłowe sparowanie wygląda np. tak: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

Nieprawidłowa para: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Wartości w polu enum
ROADMAP Domyślny typ mapy drogowej.
ROADMAP_DARK Ciemna wersja typu mapy drogowej.
SATELLITE zdjęcia satelitarne,
TERRAIN Typ mapy terenu.
TERRAIN_DARK Ciemna wersja typu mapy terenowej.
NAVIGATION Typ mapy nawigacyjnej.
NAVIGATION_LOW_LIGHT Wersja mapy nawigacyjnej w słabym oświetleniu.
TRANSIT Typ mapy transportu publicznego.
TRANSIT_DARK Ciemna wersja typu mapy transportu publicznego.
ABSTRACT3D Abstrakcyjny typ mapy 3D.
PHOTOREALISTIC3D Typ fotorealistycznej mapy 3D.

MapFeatures

Reprezentuje zbiór funkcji mapy, które mają zastosowanie do konfiguracji mapy. Funkcje ustawione w MapConfig są dziedziczone przez wszystkie podrzędne MapContextConfig. Next ID = 3;

Pola
simple_features[]

SimpleFeature

Opcjonalnie. Funkcja wizualna, która ma być używana na tej mapie.
poi_boost_level

int32

Opcjonalnie. Poziom wzmocnienia POI, gdzie 0 oznacza brak wzmocnienia, a wartości ujemne oznaczają osłabienie. Wyróżnione punkty POI są wyświetlane przy mniejszym powiększeniu niż domyślne, a punkty niewyróżnione – przy większym. Obecnie obsługuje 2 poziomy wzmocnienia, więc poziom jest ograniczony do zakresu [–2, 2]. Jeśli nie zostanie określona, użyta zostanie gęstość punktów POI zdefiniowana w arkuszu stylów (jeśli istnieje). W przeciwnym razie gęstość punktów POI nie będzie stosowana.

SimpleFeature

Jest to zbiór elementów mapy, które wpływają na jej wewnętrzną strukturę.

Wartości w polu enum
SIMPLE_FEATURE_UNSPECIFIED Nieokreślony element wizualny.
FLATTEN_BUILDINGS Spłaszcza wszystkie budynki na mapie.
ICONIC_ICONS Wpływa na sposób renderowania ikon.

MapRenderingType

Typ mapy do wyrenderowania. Jeśli nie zostanie podany, domyślnie przyjmuje wartość RASTER.

Wartości w polu enum
RASTER Mapa wyrenderowana przy użyciu implementacji rastrowej.
VECTOR Mapa wyrenderowana za pomocą WebGL.

StyleConfig

Reprezentuje pojedynczy styl w aplikacji klienckiej interfejsu API Map Google. Obiekt StyleConfig zawiera arkusz stylów, który określa wygląd mapy. Next ID = 9;

Pola
name

string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu tego obiektu StyleConfig. Na przykład: „projects/my-project-123/styleConfigs/234”.
display_name

string

Opcjonalnie. Wyświetlana nazwa tego obiektu StyleConfig określona przez użytkownika.
description

string

Opcjonalnie. Opis tego obiektu StyleConfig określony przez użytkownika.
style_id

string

Tylko dane wyjściowe. Unikalny identyfikator tego stylu. Jest to pole tylko do odczytu, które jest generowane podczas tworzenia elementu StyleConfig. Tylko dane wyjściowe.
json_style_sheet

string

Opcjonalnie. Reprezentacja JSON arkusza stylów dla tego obiektu StyleConfig. Jeśli nie zostanie określony, użyty zostanie podstawowy styl mapy Google. Więcej informacji o akceptowalnym formacie JSON znajdziesz na stronie https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference.
create_time

Timestamp

Tylko dane wyjściowe. Określa czas utworzenia elementu StyleConfig.
update_time

Timestamp

Tylko dane wyjściowe. Oznacza czas ostatniej aktualizacji elementu StyleConfig.

StyleConfigView

Określa, który podzbiór elementu StyleConfig ma zostać zwrócony.

Wartości w polu enum
STYLE_CONFIG_VIEW_UNSPECIFIED Nieokreślony widok.
FULL Uwzględnij w odpowiedzi arkusz stylów json_style_sheet.
METADATA_ONLY Wyklucz arkusz stylów json_style_sheet z odpowiedzi.

UpdateMapConfigRequest

Wysyłanie prośby o zaktualizowanie pliku MapConfig.

Pola
map_config

MapConfig

Wymagane. Obiekt MapConfig do zaktualizowania.

Pole name w obiekcie MapConfig służy do identyfikowania obiektu MapConfig, który ma zostać zaktualizowany. Format: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

Opcjonalnie. Konkretne pole do zaktualizowania w MapConfig. Jeśli nie zostanie określony, MapConfig zostanie zaktualizowany w całości. Prawidłowe pola:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Prośba o zaktualizowanie obiektu MapContextConfig.

Pola
map_context_config

MapContextConfig

Wymagane. Obiekt MapContextConfig do zaktualizowania.

Pole name w obiekcie MapContextConfig służy do identyfikowania obiektu MapContextConfig, który ma zostać zaktualizowany. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

Opcjonalnie. Lista pól do zaktualizowania. Jeśli nie zostanie określony, obiekt MapContextConfig zostanie zaktualizowany w całości. Prawidłowe pola:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Prośba o zaktualizowanie elementu StyleConfig.

Pola
style_config

StyleConfig

Wymagane. Obiekt StyleConfig do zaktualizowania.

Pole name w obiekcie StyleConfig służy do identyfikowania obiektu StyleConfig, który ma zostać zaktualizowany. Format: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

Opcjonalnie. Lista pól do zaktualizowania. Jeśli nie zostanie określony, StyleConfig zostanie zaktualizowany w całości. Prawidłowe pola:

  • display_name
  • description
  • json_style_sheet