Package google.maps.mapmanagement.v2alpha

Index

MapManagement

L'API Map Management est compatible avec les opérations CRUD sur les ressources de style de carte basées dans le cloud : MapConfigs, StyleConfigs et MapContextConfigs. Cette API permet aux développeurs de gérer l'apparence visuelle de leurs cartes et de les personnaliser selon leurs spécifications.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

Crée une MapConfig dans un projet.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

Crée un MapContextConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

Crée un StyleConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

Supprime une MapConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

Supprime un objet MapContextConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

Supprime un StyleConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

Permet d'obtenir une instance MapConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

Obtient une MapContextConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

Permet d'obtenir une instance StyleConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

Répertorie les MapConfigs d'un projet.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

Liste les MapContextConfigs.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

Répertorie les StyleConfigs.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

Met à jour un MapConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

Met à jour un MapContextConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

Met à jour un StyleConfig.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

CreateMapConfigRequest

Requête de création d'une ressource MapConfig.

Champs
parent

string

Obligatoire. Projet parent qui sera propriétaire de MapConfig. Format : projects/{$my-project-id}
map_config

MapConfig

Obligatoire. MapConfig à créer.

CreateMapContextConfigRequest

Requête de création d'une MapContextConfig.

Champs
parent

string

Obligatoire. MapConfig parent qui possédera MapContextConfig. Format : projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

Obligatoire. MapContextConfig à créer.

CreateStyleConfigRequest

Requête de création d'une ressource StyleConfig.

Champs
parent

string

Obligatoire. Projet parent qui sera propriétaire de StyleConfig. Format : projects/{project}
style_config

StyleConfig

Obligatoire. StyleConfig à créer.

DeleteMapConfigRequest

Requête de suppression d'une ressource MapConfig. Si MapConfig comporte des MapContextConfigs enfants, ceux-ci seront également supprimés.

Champs
name

string

Obligatoire. Nom de ressource de la MapConfig à supprimer. Format : projects/{project}/mapConfigs/{map_config}
force

bool

Facultatif. Si la valeur est définie sur "true", toutes les MapContextConfigs de MapConfig seront également supprimées. (Sinon, la requête ne fonctionnera que si MapConfig ne comporte pas de MapContextConfigs.)

DeleteMapContextConfigRequest

Requête de suppression d'une ressource MapContextConfig.

Champs
name

string

Obligatoire. Nom de ressource de la MapContextConfig à supprimer. Format : projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Requête de suppression d'une ressource StyleConfig.

Champs
name

string

Obligatoire. Nom de ressource de la StyleConfig à supprimer. Format : projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Requête permettant d'obtenir un MapConfig.

Champs
name

string

Obligatoire. Nom de ressource de MapConfig. Format : projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Requête pour obtenir un MapContextConfig.

Champs
name

string

Obligatoire. Nom de ressource de MapContextConfig. Format : projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Requête permettant d'obtenir une StyleConfig.

Champs
name

string

Obligatoire. Nom de ressource de StyleConfig. Format : projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Requête permettant de répertorier les ressources MapConfig.

Champs
parent

string

Obligatoire. Projet parent propriétaire des MapConfigs. Format : projects/{project}
page_size

int32

Facultatif. Nombre maximal de MapConfigs à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 MapConfigs au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. ACTUELLEMENT NON PRIS EN CHARGE.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListMapConfigs précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListMapConfigs doivent correspondre à l'appel ayant fourni le jeton de page. ACTUELLEMENT NON PRIS EN CHARGE.

ListMapConfigsResponse

Réponse à la liste des MapConfigs.

Champs
map_configs[]

MapConfig

Liste des MapConfigs.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages. ACTUELLEMENT NON PRIS EN CHARGE.

ListMapContextConfigsRequest

Requête permettant de répertorier les ressources MapContextConfig.

Champs
parent

string

Obligatoire. MapConfig parent qui possède les MapContextConfigs. Format : projects/{project}/mapConfigs/{map_config}
page_size

int32

Facultatif. Nombre maximal de MapContextConfigs à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 MapContextConfigs au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. ACTUELLEMENT NON PRIS EN CHARGE.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListMapContextConfigs précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListMapContextConfigs doivent correspondre à l'appel ayant fourni le jeton de page. ACTUELLEMENT NON PRIS EN CHARGE.

ListMapContextConfigsResponse

Réponse à la liste des MapContextConfigs.

Champs
map_context_configs[]

MapContextConfig

MapContextConfigs.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages. ACTUELLEMENT NON PRIS EN CHARGE.

ListStyleConfigsRequest

Requête permettant de répertorier les ressources StyleConfig.

Champs
parent

string

Obligatoire. Projet parent propriétaire des StyleConfigs. Format : projects/{project}
page_size

int32

Facultatif. Nombre maximal de StyleConfigs à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 StyleConfigs au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. ACTUELLEMENT NON PRIS EN CHARGE.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListStyleConfigs précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListStyleConfigs doivent correspondre à l'appel ayant fourni le jeton de page. ACTUELLEMENT NON PRIS EN CHARGE.
filter

string

Facultatif. Expression de filtre pour l'appel ListStyleConfigs. Actuellement, seul le filtrage par display_name est pris en charge. Par exemple, display_name="My StyleConfig" renverra tous les StyleConfigs dont le nom à afficher est "My StyleConfig".
view

StyleConfigView

Facultatif. Sous-ensemble de StyleConfig à renvoyer. Si ce paramètre n'est pas défini, le comportement par défaut consiste à renvoyer la vue COMPLÈTE.

ListStyleConfigsResponse

Réponse à la liste StyleConfigs.

Champs
style_configs[]

StyleConfig

StyleConfigs.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages. ACTUELLEMENT NON PRIS EN CHARGE.

MapConfig

Représente une seule carte dans une application cliente de l'API Maps. MapConfig est la ressource parente de MapContextConfigs et permet de personnaliser le style dans les SDK (mobile/Web). Un MapConfig peut comporter plusieurs MapContextConfigs, chacun appliquant un style à des variantes de carte spécifiques. ID suivant : 9

Champs
name

string

Uniquement en sortie. Identifiant. Nom de ressource de cette MapConfig. Par exemple : "projects/my-project-123/mapConfigs/234". Uniquement en sortie.
display_name

string

Facultatif. Nom à afficher de cette MapConfig, tel que spécifié par l'utilisateur.
description

string

Facultatif. Description de cette MapConfig, telle que spécifiée par l'utilisateur.
map_id

string

Uniquement en sortie. ID de carte de cette MapConfig, utilisé pour identifier la carte dans les applications clientes. Ce champ en lecture seule est généré lorsque le MapConfig est créé. Uniquement en sortie.
map_features

MapFeatures

Facultatif. Fonctionnalités de carte qui s'appliquent à cette configuration de carte.
map_type

MapRenderingType

Facultatif. Représente le type de carte de MapConfig. Si cette option n'est pas définie, le comportement par défaut consiste à utiliser le type de carte raster.
create_time

Timestamp

Uniquement en sortie. Indique l'heure de création de la configuration de la carte. Uniquement en sortie.
update_time

Timestamp

Uniquement en sortie. Indique l'heure de la dernière mise à jour de la configuration de la carte. Uniquement en sortie.

MapContextConfig

Encapsule la configuration du style d'une carte. MapContextConfig associe des composants de style, tels que StyleConfig et Datasets, à des variantes de carte spécifiques d'un MapConfig. Lorsque MapConfig est chargé dans un SDK, les informations de style et d'ensemble de données de MapContextConfig sont appliquées aux variantes de carte spécifiées. ID suivant = 10 ;

Champs
name

string

Uniquement en sortie. Identifiant. Nom de ressource de cette MapContextConfig. Par exemple : projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

Obligatoire. Nom de la ressource MapConfig à laquelle cette MapContextConfig est associée. Format : projects/{project}/mapConfigs/{map_config}. Ce champ est obligatoire et ne peut pas être omis.
style_config

string

Obligatoire. Nom de la ressource StyleConfig qui définit le style de cette MapContextConfig. Ce champ est obligatoire et ne peut pas être omis. Format : projects/{project}/styleConfigs/{style_config}
dataset[]

string

Facultatif. Nom de ressource de l'ensemble de données associé à cette MapContextConfig. Ce champ est facultatif et peut être omis. Si elle est omise, aucun ensemble de données ne sera associé à MapContextConfig. Si un ensemble de données est spécifié, il sera appliqué à MapContextConfig. Format : projects/{project}/datasets/{dataset}
alias

string

Facultatif. Nom lisible défini par l'utilisateur pour cette MapContextConfig.
map_variants[]

MapVariant

Obligatoire. Variantes de carte auxquelles cette MapContextConfig peut être appliquée. Si ce champ est vide, MapContextConfig ne sera appliqué par défaut qu'à la variante de carte "ROADMAP".
create_time

Timestamp

Uniquement en sortie. Indique la date et l'heure de création de MapContextConfig. Uniquement en sortie.
update_time

Timestamp

Uniquement en sortie. Indique la date et l'heure de la dernière mise à jour de MapContextConfig. Uniquement en sortie.

MapVariant

Variantes de carte possibles auxquelles MapContextConfig peut être appliqué. Les variantes de carte sont regroupées en variantes claires et sombres. Une variante claire ne peut pas être associée à une variante sombre pour le même MapContextConfig. Les variantes claires sont les suivantes : ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D, PHOTOREALISTIC3D. Les variantes sombres sont les suivantes : ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK et TRANSIT_DARK.

Par exemple, voici un appariement valide : {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

L'association suivante n'est pas valide : {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Enums
ROADMAP Type de carte routière par défaut.
ROADMAP_DARK Version sombre du type de carte "Roadmap".
SATELLITE Images satellite.
TERRAIN Type de carte en relief.
TERRAIN_DARK Version sombre du type de carte en relief.
NAVIGATION Type de carte de navigation.
NAVIGATION_LOW_LIGHT Version basse luminosité du type de carte de navigation.
TRANSIT Type de carte des transports en commun.
TRANSIT_DARK Version sombre du type de carte des transports en commun.
ABSTRACT3D Type de carte 3D abstraite.
PHOTOREALISTIC3D Type de carte 3D photoréaliste.

MapFeatures

Représente une collection d'éléments cartographiques qui s'appliquent à une MapConfig. Les fonctionnalités définies sur un MapConfig sont héritées par tous ses MapContextConfigs enfants. Identifiant suivant : 3

Champs
simple_features[]

SimpleFeature

Facultatif. Fonctionnalité visuelle à utiliser pour cette carte.
poi_boost_level

int32

Facultatif. Niveau de boost des points d'intérêt. 0 signifie qu'il n'y a pas de boost et les valeurs négatives indiquent un déboost. Les POI mis en avant sont affichés à un niveau de zoom inférieur à celui par défaut, et inversement pour les POI non mis en avant. Actuellement, deux niveaux de renforcement sont pris en charge. Le niveau est donc limité à [-2, 2]. Si aucune valeur n'est spécifiée, la densité de POI définie dans la feuille de style sera utilisée, le cas échéant. Sinon, aucune densité de POI ne sera appliquée.

SimpleFeature

Il s'agit de l'ensemble des éléments cartographiques qui affectent la structure intrinsèque de la carte.

Enums
SIMPLE_FEATURE_UNSPECIFIED Caractéristique visuelle non spécifiée.
FLATTEN_BUILDINGS Aplatit tous les bâtiments de la carte.
ICONIC_ICONS Influe sur la façon dont les icônes sont affichées.

MapRenderingType

Type de carte à afficher. Si aucun comportement n'est spécifié, le comportement par défaut est RASTER.

Enums
RASTER Carte affichée à l'aide de l'implémentation basée sur le raster.
VECTOR Carte affichée à l'aide de WebGL.

StyleConfig

Représente un style unique dans une application cliente de l'API Maps. StyleConfig contient la feuille de style qui définit l'apparence visuelle de la carte. ID suivant : 9

Champs
name

string

Uniquement en sortie. Identifiant. Nom de ressource de cette StyleConfig. Par exemple : "projects/my-project-123/styleConfigs/234".
display_name

string

Facultatif. Nom à afficher de cette StyleConfig, tel que spécifié par l'utilisateur.
description

string

Facultatif. Description de cette StyleConfig, telle que spécifiée par l'utilisateur.
style_id

string

Uniquement en sortie. Identifiant unique de ce style. Il s'agit d'un champ en lecture seule qui est généré lorsque StyleConfig est créé. Uniquement en sortie.
json_style_sheet

string

Facultatif. Représentation JSON de la feuille de style pour cette StyleConfig. Si aucune valeur n'est spécifiée, le style de carte Google de base sera utilisé. Pour en savoir plus sur le format JSON acceptable, consultez https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference.
create_time

Timestamp

Uniquement en sortie. Indique l'heure de création de StyleConfig.
update_time

Timestamp

Uniquement en sortie. Indique la date et l'heure de la dernière mise à jour de StyleConfig.

StyleConfigView

Sous-ensemble de StyleConfig à renvoyer.

Enums
STYLE_CONFIG_VIEW_UNSPECIFIED Vue non spécifiée.
FULL Incluez la feuille de style json dans la réponse.
METADATA_ONLY Excluez la feuille de style json de la réponse.

UpdateMapConfigRequest

Requête de mise à jour d'une ressource MapConfig.

Champs
map_config

MapConfig

Obligatoire. MapConfig à mettre à jour.

Le champ name de MapConfig permet d'identifier le MapConfig à mettre à jour. Format : projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

Facultatif. Champ spécifique à mettre à jour pour MapConfig. Si ce paramètre n'est pas spécifié, l'intégralité de MapConfig sera mise à jour. Les champs valides sont les suivants :

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Requête de mise à jour d'une ressource MapContextConfig.

Champs
map_context_config

MapContextConfig

Obligatoire. MapContextConfig à mettre à jour.

Le champ name de MapContextConfig permet d'identifier le MapContextConfig à mettre à jour. Format : projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

Facultatif. Liste des champs à mettre à jour. Si ce paramètre n'est pas spécifié, l'intégralité de MapContextConfig sera mise à jour. Les champs valides sont les suivants :

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Requête de mise à jour d'une StyleConfig.

Champs
style_config

StyleConfig

Obligatoire. StyleConfig à mettre à jour.

Le champ name de StyleConfig permet d'identifier le StyleConfig à mettre à jour. Format : projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

Facultatif. Liste des champs à mettre à jour. Si elle n'est pas spécifiée, la StyleConfig sera mise à jour dans son intégralité. Les champs valides sont les suivants :

  • display_name
  • description
  • json_style_sheet