Package google.maps.mapmanagement.v2alpha

Index

MapManagement

Die Map Management API unterstützt CRUD-Vorgänge für cloudbasierte Kartenstilressourcen: MapConfigs, StyleConfigs und MapContextConfigs. Mit dieser API können Entwickler die visuelle Darstellung ihrer Karten verwalten und nach ihren Vorgaben gestalten.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

Erstellt eine MapConfig in einem Projekt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

Erstellt eine MapContextConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

Erstellt eine StyleConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

Löscht eine MapConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

Löscht eine MapContextConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

Löscht eine StyleConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

Ruft eine MapConfig ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

Ruft eine MapContextConfig ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

Ruft eine StyleConfig ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

Listet MapConfigs für ein Projekt auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

Listet MapContextConfigs auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

Listet StyleConfigs auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

Aktualisiert eine MapConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

Aktualisiert eine MapContextConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

Aktualisiert eine StyleConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

CreateMapConfigRequest

Anfrage zum Erstellen einer MapConfig.

Felder
parent

string

Erforderlich. Übergeordnetes Projekt, zu dem die MapConfig gehört. Format: projects/{$my-project-id}
map_config

MapConfig

Erforderlich. Die zu erstellende MapConfig.

CreateMapContextConfigRequest

Anfrage zum Erstellen einer MapContextConfig.

Felder
parent

string

Erforderlich. Übergeordnete MapConfig, die die MapContextConfig enthält. Format: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

Erforderlich. Die MapContextConfig, die erstellt werden soll.

CreateStyleConfigRequest

Anfrage zum Erstellen einer StyleConfig.

Felder
parent

string

Erforderlich. Übergeordnetes Projekt, zu dem die StyleConfig gehört. Format: projects/{project}
style_config

StyleConfig

Erforderlich. Die zu erstellende StyleConfig.

DeleteMapConfigRequest

Anfrage zum Löschen einer MapConfig. Wenn die MapConfig untergeordnete MapContextConfigs hat, werden diese ebenfalls gelöscht.

Felder
name

string

Erforderlich. Ressourcenname der zu löschenden MapConfig. Format: projects/{project}/mapConfigs/{map_config}
force

bool

Optional. Wenn auf „true“ gesetzt, werden auch alle MapContextConfigs aus dieser MapConfig gelöscht. Andernfalls funktioniert die Anfrage nur, wenn die MapConfig keine MapContextConfigs hat.

DeleteMapContextConfigRequest

Anfrage zum Löschen einer MapContextConfig.

Felder
name

string

Erforderlich. Der Ressourcenname der zu löschenden MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Anfrage zum Löschen einer StyleConfig.

Felder
name

string

Erforderlich. Ressourcenname der zu löschenden StyleConfig. Format: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Anfrage zum Abrufen einer MapConfig

Felder
name

string

Erforderlich. Ressourcenname der MapConfig. Format: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Anfrage zum Abrufen einer MapContextConfig.

Felder
name

string

Erforderlich. Ressourcenname der MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Anfrage zum Abrufen einer StyleConfig.

Felder
name

string

Erforderlich. Ressourcenname der StyleConfig. Format: projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Anfrage zum Auflisten von MapConfigs.

Felder
parent

string

Erforderlich. Übergeordnetes Projekt, das die MapConfigs enthält. Format: projects/{project}
page_size

int32

Optional. Die maximale Anzahl der zurückzugebenden MapConfigs. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 50 MapConfigs zurückgegeben. Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt. DERZEIT NICHT UNTERSTÜTZT.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListMapConfigs-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListMapConfigs bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. DERZEIT NICHT UNTERSTÜTZT.

ListMapConfigsResponse

Antwort auf die Anfrage zum Auflisten von MapConfigs.

Felder
map_configs[]

MapConfig

Die Liste der MapConfigs.
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten. DERZEIT NICHT UNTERSTÜTZT.

ListMapContextConfigsRequest

Anfrage zum Auflisten von MapContextConfigs.

Felder
parent

string

Erforderlich. Übergeordnete MapConfig, die die MapContextConfigs enthält. Format: projects/{project}/mapConfigs/{map_config}
page_size

int32

Optional. Die maximale Anzahl der zurückzugebenden MapContextConfigs. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 50 MapContextConfigs zurückgegeben. Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt. DERZEIT NICHT UNTERSTÜTZT.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListMapContextConfigs-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListMapContextConfigs bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. DERZEIT NICHT UNTERSTÜTZT.

ListMapContextConfigsResponse

Antwort auf die Anfrage zum Auflisten von MapContextConfigs.

Felder
map_context_configs[]

MapContextConfig

Die MapContextConfigs.
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten. DERZEIT NICHT UNTERSTÜTZT.

ListStyleConfigsRequest

Anfrage zum Auflisten von StyleConfigs.

Felder
parent

string

Erforderlich. Übergeordnetes Projekt, zu dem die StyleConfigs gehören. Format: projects/{project}
page_size

int32

Optional. Die maximale Anzahl der zurückzugebenden StyleConfigs. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 50 StyleConfigs zurückgegeben. Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt. DERZEIT NICHT UNTERSTÜTZT.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListStyleConfigs-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListStyleConfigs bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. DERZEIT NICHT UNTERSTÜTZT.
filter

string

Optional. Filterausdruck für den ListStyleConfigs-Aufruf. Derzeit wird nur das Filtern nach „display_name“ unterstützt. Beispiel: display_name="My StyleConfig" gibt alle StyleConfigs mit dem Anzeigenamen „My StyleConfig“ zurück.
view

StyleConfigView

Optional. Die Teilmenge der zurückzugebenden StyleConfig. Wenn dieser Parameter nicht festgelegt ist, wird standardmäßig die Ansicht „FULL“ zurückgegeben.

ListStyleConfigsResponse

Antwort auf die Auflistung von StyleConfigs.

Felder
style_configs[]

StyleConfig

Die StyleConfigs.
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten. DERZEIT NICHT UNTERSTÜTZT.

MapConfig

Stellt eine einzelne Karte in einer Maps API-Clientanwendung dar. Die MapConfig ist die übergeordnete Ressource von MapContextConfigs und ermöglicht benutzerdefiniertes Styling in SDKs (Mobil/Web). Eine MapConfig kann mehrere MapContextConfigs haben, die jeweils das Styling für bestimmte Kartenvarianten festlegen. Nächste ID = 9;

Felder
name

string

Nur Ausgabe. ID. Der Ressourcenname dieser MapConfig. Beispiel: „projects/my-project-123/mapConfigs/234“. Nur Ausgabe.
display_name

string

Optional. Der vom Nutzer angegebene Anzeigename dieser MapConfig.
description

string

Optional. Die vom Nutzer angegebene Beschreibung dieser MapConfig.
map_id

string

Nur Ausgabe. Die Karten-ID dieser MapConfig, die zum Identifizieren der Karte in Clientanwendungen verwendet wird. Dieses schreibgeschützte Feld wird beim Erstellen der MapConfig generiert. Nur Ausgabe.
map_features

MapFeatures

Optional. Die Kartenelemente, die für diese Kartenkonfiguration gelten.
map_type

MapRenderingType

Optional. Stellt den Kartentyp der MapConfig dar. Wenn diese Option nicht festgelegt ist, wird standardmäßig der Rasterkartentyp verwendet.
create_time

Timestamp

Nur Ausgabe. Gibt die Erstellungszeit der Kartenkonfiguration an. Nur Ausgabe.
update_time

Timestamp

Nur Ausgabe. Gibt die letzte Aktualisierungszeit der Kartenkonfiguration an. Nur Ausgabe.

MapContextConfig

Kapselt die Stilkonfiguration für eine Karte. Mit MapContextConfig werden Styling-Komponenten wie StyleConfig und Datasets bestimmten Kartenvarianten einer MapConfig zugeordnet. Wenn die MapConfig in einem SDK geladen wird, werden die Stil- und Dataset-Informationen aus der MapContextConfig auf die angegebenen Kartenvarianten angewendet. Nächste ID = 10;

Felder
name

string

Nur Ausgabe. ID. Ressourcenname dieser MapContextConfig. Beispiel: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

Erforderlich. Der MapConfig-Ressourcenname, dem diese MapContextConfig zugeordnet ist. Format: projects/{project}/mapConfigs/{map_config}. Dieses Feld ist erforderlich und darf nicht ausgelassen werden.
style_config

string

Erforderlich. Der StyleConfig-Ressourcenname, mit dem diese MapContextConfig formatiert wird. Dieses Feld ist erforderlich und darf nicht ausgelassen werden. Format: projects/{project}/styleConfigs/{style_config}
dataset[]

string

Optional. Der Dataset-Ressourcenname, der dieser MapContextConfig zugeordnet ist. Dieses Feld ist optional und kann weggelassen werden. Wenn sie weggelassen wird, sind keine Datasets mit der MapContextConfig verknüpft. Wenn ein Dataset angegeben ist, wird es auf die MapContextConfig angewendet. Format: projects/{project}/datasets/{dataset}
alias

string

Optional. Der vom Nutzer definierte, für Menschen lesbare Name für diese MapContextConfig.
map_variants[]

MapVariant

Erforderlich. Die Kartenvarianten, auf die diese MapContextConfig angewendet werden kann. Wenn leer, wird die MapContextConfig standardmäßig nur auf die ROADMAP-Kartenvariante angewendet.
create_time

Timestamp

Nur Ausgabe. Gibt die Erstellungszeit der MapContextConfig an. Nur Ausgabe.
update_time

Timestamp

Nur Ausgabe. Gibt die letzte Aktualisierungszeit der MapContextConfig an. Nur Ausgabe.

MapVariant

Mögliche Kartenvarianten, auf die die MapContextConfig angewendet werden kann. Kartenvarianten werden in helle und dunkle Varianten unterteilt. Eine Light-Variante kann nicht mit einer Dark-Variante für dieselbe MapContextConfig kombiniert werden. Die leichten Varianten sind: ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D, PHOTOREALISTIC3D. Die dunklen Varianten sind: ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK, TRANSIT_DARK.

Das folgende Beispiel ist eine gültige Zuordnung: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

Das folgende Beispiel zeigt eine ungültige Zuordnung: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Enums
ROADMAP Der Standardkartentyp für Straßenkarten.
ROADMAP_DARK Eine dunkle Version des Kartentyps „Straßenkarte“.
SATELLITE Satellitenbilder.
TERRAIN Kartentyp „Gelände“
TERRAIN_DARK Eine dunkle Version des Kartentyps „Gelände“.
NAVIGATION Navigationskartentyp.
NAVIGATION_LOW_LIGHT Eine Version des Navigationskartentyps für schlechte Lichtverhältnisse.
TRANSIT Kartentyp für öffentliche Verkehrsmittel.
TRANSIT_DARK Eine dunkle Version des ÖPNV-Kartentyps.
ABSTRACT3D Abstrakter 3D-Kartentyp.
PHOTOREALISTIC3D Fotorealistischer 3D-Kartentyp.

MapFeatures

Stellt eine Sammlung von Kartenelementen dar, die für eine MapConfig gelten. Für eine MapConfig festgelegte Funktionen werden von allen untergeordneten MapContextConfigs übernommen. Nächste ID = 3;

Felder
simple_features[]

SimpleFeature

Optional. Das visuelle Element, das für diese Karte verwendet werden soll.
poi_boost_level

int32

Optional. POI-Boost-Stufe. „0“ bedeutet, dass keine Boosts angewendet werden, und negative Werte bedeuten, dass die Werte reduziert werden. Hervorgehobene POIs werden bei einem geringeren Zoom als standardmäßig angezeigt und umgekehrt. Derzeit werden zwei Steigerungsstufen unterstützt. Die Stufe wird also auf [-2, 2] begrenzt. Wenn nicht angegeben, wird die im Stylesheet definierte POI-Dichte verwendet, sofern vorhanden. Andernfalls wird keine POI-Kompaktheitsgrad angewendet.

SimpleFeature

Dies ist die Menge der Kartenfunktionen, die sich auf die intrinsische Struktur der Karte auswirken.

Enums
SIMPLE_FEATURE_UNSPECIFIED Nicht angegebene visuelle Funktion.
FLATTEN_BUILDINGS Alle Gebäude auf der Karte werden flach dargestellt.
ICONIC_ICONS Beeinflusst, wie Symbole gerendert werden.

MapRenderingType

Der Typ der zu rendernden Karte. Das Standardverhalten ist RASTER, wenn nicht anders angegeben.

Enums
RASTER Eine Karte, die mit der rasterbasierten Implementierung gerendert wurde.
VECTOR Eine mit WebGL gerenderte Karte.

StyleConfig

Stellt einen einzelnen Stil in einer Maps API-Clientanwendung dar. Die StyleConfig enthält das Stylesheet, das die visuelle Darstellung der Karte definiert. Nächste ID = 9;

Felder
name

string

Nur Ausgabe. ID. Der Ressourcenname dieser StyleConfig. Beispiel: „projects/my-project-123/styleConfigs/234“.
display_name

string

Optional. Der vom Nutzer angegebene Anzeigename dieser StyleConfig.
description

string

Optional. Die vom Nutzer angegebene Beschreibung dieser StyleConfig.
style_id

string

Nur Ausgabe. Die eindeutige Kennung dieses Stils. Dies ist ein schreibgeschütztes Feld, das beim Erstellen der StyleConfig generiert wird. Nur Ausgabe.
json_style_sheet

string

Optional. JSON-Darstellung des Stylesheets für diese StyleConfig. Wenn keine Angabe erfolgt, wird der Google-Standardkartenstil verwendet. Weitere Informationen zum zulässigen JSON-Format finden Sie unter https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference.
create_time

Timestamp

Nur Ausgabe. Gibt den Erstellungszeitpunkt der StyleConfig an.
update_time

Timestamp

Nur Ausgabe. Gibt die letzte Aktualisierungszeit der StyleConfig an.

StyleConfigView

Welche Teilmenge der StyleConfig zurückgegeben werden soll.

Enums
STYLE_CONFIG_VIEW_UNSPECIFIED Nicht angegebene Ansicht.
FULL Fügen Sie das json_style_sheet in die Antwort ein.
METADATA_ONLY Schließen Sie das json_style_sheet aus der Antwort aus.

UpdateMapConfigRequest

Anfrage zum Aktualisieren einer MapConfig.

Felder
map_config

MapConfig

Erforderlich. Die zu aktualisierende MapConfig.

Das Feld name von MapConfig wird verwendet, um die zu aktualisierende MapConfig zu identifizieren. Format: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

Optional. Das Feld, das für die MapConfig aktualisiert werden soll. Wenn nicht angegeben, wird die MapConfig vollständig aktualisiert. Gültige Felder sind:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Anfrage zum Aktualisieren einer MapContextConfig.

Felder
map_context_config

MapContextConfig

Erforderlich. Die MapContextConfig, die aktualisiert werden soll.

Das Feld name von MapContextConfig wird verwendet, um die zu aktualisierende MapContextConfig zu identifizieren. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

Optional. Die Liste der zu aktualisierenden Felder. Wenn nicht angegeben, wird die MapContextConfig vollständig aktualisiert. Gültige Felder sind:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Anfrage zum Aktualisieren einer StyleConfig.

Felder
style_config

StyleConfig

Erforderlich. Die zu aktualisierende StyleConfig.

Das Feld name von StyleConfig wird verwendet, um die zu aktualisierende StyleConfig zu identifizieren. Format: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

Optional. Die Liste der zu aktualisierenden Felder. Wenn nicht angegeben, wird die StyleConfig vollständig aktualisiert. Gültige Felder sind:

  • display_name
  • description
  • json_style_sheet