Package google.maps.mapmanagement.v2alpha

Índice

MapManagement

La API de Map Management admite operaciones de CRUD en recursos de diseño de mapas basado en Cloud: MapConfigs, StyleConfigs y MapContextConfigs. Con esta API, los desarrolladores pueden administrar el aspecto visual de sus mapas y diseñarlos según sus especificaciones.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

Crea un objeto MapConfig en un proyecto.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

Crea un MapContextConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

Crea un objeto StyleConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

Borra un MapConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

Borra un MapContextConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

Borra un objeto StyleConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

Obtiene un MapConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

Obtiene un MapContextConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

Obtiene un objeto StyleConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

Enumera los MapConfigs de un proyecto.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

Enumera MapContextConfigs.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

Enumera los objetos StyleConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

Actualiza un MapConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

Actualiza un MapContextConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

Actualiza un objeto StyleConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

CreateMapConfigRequest

Es una solicitud para crear un MapConfig.

Campos
parent

string

Obligatorio. Es el proyecto principal que será propietario del MapConfig. Formato: projects/{$my-project-id}
map_config

MapConfig

Obligatorio. Es el MapConfig que se creará.

CreateMapContextConfigRequest

Es la solicitud para crear un MapContextConfig.

Campos
parent

string

Obligatorio. Es el MapConfig principal que será propietario del MapContextConfig. Formato: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

Obligatorio. MapContextConfig que se creará.

CreateStyleConfigRequest

Es la solicitud para crear un objeto StyleConfig.

Campos
parent

string

Obligatorio. Es el proyecto principal que será propietario del objeto StyleConfig. Formato: projects/{project}
style_config

StyleConfig

Obligatorio. Es el objeto StyleConfig que se creará.

DeleteMapConfigRequest

Es la solicitud para borrar un MapConfig. Si el MapConfig tiene algún MapContextConfig secundario, estos también se borrarán.

Campos
name

string

Obligatorio. Nombre del recurso de MapConfig que se borrará. Formato: projects/{project}/mapConfigs/{map_config}
force

bool

Opcional. Si se establece como verdadero, también se borrarán los MapContextConfigs de este MapConfig. (De lo contrario, la solicitud solo funcionará si MapConfig no tiene MapContextConfigs).

DeleteMapContextConfigRequest

Es la solicitud para borrar un MapContextConfig.

Campos
name

string

Obligatorio. Nombre del recurso de MapContextConfig que se borrará. Formato: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Solicitud para borrar un objeto StyleConfig.

Campos
name

string

Obligatorio. Es el nombre del recurso de StyleConfig que se borrará. Formato: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Es una solicitud para obtener un MapConfig.

Campos
name

string

Obligatorio. Es el nombre del recurso de MapConfig. Formato: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Es una solicitud para obtener un MapContextConfig.

Campos
name

string

Obligatorio. Es el nombre del recurso de MapContextConfig. Formato: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Es una solicitud para obtener un objeto StyleConfig.

Campos
name

string

Obligatorio. Es el nombre del recurso de StyleConfig. Formato: projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Solicitud para enumerar MapConfigs.

Campos
parent

string

Obligatorio. Es el proyecto principal que posee los MapConfigs. Formato: projects/{project}
page_size

int32

Opcional. Es la cantidad máxima de objetos MapConfig que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50 MapConfigs. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000. ACTUALMENTE NO ES COMPATIBLE.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListMapConfigs anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListMapConfigs deben coincidir con la llamada que proporcionó el token de la página. ACTUALMENTE NO ES COMPATIBLE.

ListMapConfigsResponse

Es la respuesta a la solicitud de enumerar MapConfigs.

Campos
map_configs[]

MapConfig

Es la lista de MapConfigs.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes. ACTUALMENTE NO ES COMPATIBLE.

ListMapContextConfigsRequest

Solicitud para enumerar MapContextConfigs.

Campos
parent

string

Obligatorio. Es el MapConfig principal que posee los MapContextConfigs. Formato: projects/{project}/mapConfigs/{map_config}
page_size

int32

Opcional. Es la cantidad máxima de objetos MapContextConfigs que se pueden devolver. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50 MapContextConfigs. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000. ACTUALMENTE NO ES COMPATIBLE.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListMapContextConfigs anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListMapContextConfigs deben coincidir con la llamada que proporcionó el token de la página. ACTUALMENTE NO ES COMPATIBLE.

ListMapContextConfigsResponse

Es la respuesta para enumerar MapContextConfigs.

Campos
map_context_configs[]

MapContextConfig

Es la configuración de MapContext.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes. ACTUALMENTE NO ES COMPATIBLE.

ListStyleConfigsRequest

Solicitud para enumerar StyleConfigs.

Campos
parent

string

Obligatorio. Es el proyecto principal que posee los StyleConfigs. Formato: projects/{project}
page_size

int32

Opcional. Es la cantidad máxima de objetos StyleConfig que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50 objetos StyleConfig. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000. ACTUALMENTE NO ES COMPATIBLE.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListStyleConfigs anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListStyleConfigs deben coincidir con la llamada que proporcionó el token de la página. ACTUALMENTE NO ES COMPATIBLE.
filter

string

Opcional. Es la expresión de filtro para la llamada a ListStyleConfigs. Actualmente, solo se admite el filtrado por display_name. Por ejemplo, display_name="My StyleConfig" devolverá todos los StyleConfigs con el nombre visible "Mi StyleConfig".
view

StyleConfigView

Opcional. Es el subconjunto de StyleConfig que se devolverá. Si no se establece, el comportamiento predeterminado es devolver la vista FULL.

ListStyleConfigsResponse

Es la respuesta para enumerar StyleConfigs.

Campos
style_configs[]

StyleConfig

Es la configuración de estilo.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes. ACTUALMENTE NO ES COMPATIBLE.

MapConfig

Representa un solo mapa en una aplicación cliente de la API de Maps. MapConfig es el recurso principal de MapContextConfigs y permite aplicar un diseño personalizado en los SDKs (para dispositivos móviles y la Web). Un MapConfig puede tener varios MapContextConfigs, cada uno de los cuales aplica un diseño a variantes específicas del mapa. ID siguiente = 9;

Campos
name

string

Solo salida. Es el identificador. Es el nombre del recurso de este MapConfig. Por ejemplo: "projects/my-project-123/mapConfigs/234". Solo salida.
display_name

string

Opcional. Es el nombre visible de este MapConfig, según lo especifica el usuario.
description

string

Opcional. Es la descripción de este MapConfig, según lo especifica el usuario.
map_id

string

Solo salida. Es el ID de mapa de este MapConfig, que se usa para identificar el mapa en las aplicaciones cliente. Este campo de solo lectura se genera cuando se crea el objeto MapConfig. Solo salida.
map_features

MapFeatures

Opcional. Son las funciones del mapa que se aplican a esta configuración del mapa.
map_type

MapRenderingType

Opcional. Representa el tipo de mapa de MapConfig. Si no se establece, el comportamiento predeterminado es usar el tipo de mapa ráster.
create_time

Timestamp

Solo salida. Indica la fecha y hora de creación de la configuración del mapa. Solo salida.
update_time

Timestamp

Solo salida. Indica la última fecha y hora de actualización de la configuración del mapa. Solo salida.

MapContextConfig

Encapsula la configuración de diseño de un mapa. MapContextConfig asocia componentes de diseño, como StyleConfig y Datasets, con variantes de mapa específicas de un MapConfig. Cuando se carga MapConfig en un SDK, la información de diseño y del conjunto de datos de MapContextConfig se aplica a las variantes de mapa especificadas. ID siguiente = 10;

Campos
name

string

Solo salida. Es el identificador. Es el nombre del recurso de este MapContextConfig. Por ejemplo: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

Obligatorio. Es el nombre del recurso MapConfig con el que se asocia este MapContextConfig. Formato: projects/{project}/mapConfigs/{map_config}. Este campo es obligatorio y no se puede omitir.
style_config

string

Obligatorio. Es el nombre del recurso StyleConfig que aplica el diseño a este MapContextConfig. Este campo es obligatorio y no se puede omitir. Formato: projects/{project}/styleConfigs/{style_config}
dataset[]

string

Opcional. Es el nombre del recurso Dataset asociado a este MapContextConfig. Este campo es opcional y se puede omitir. Si se omite, no se asociará ningún conjunto de datos con MapContextConfig. Si se especifica un conjunto de datos, se aplicará a MapContextConfig. Formato: projects/{project}/datasets/{dataset}
alias

string

Opcional. Es el nombre legible definido por el usuario para este MapContextConfig.
map_variants[]

MapVariant

Obligatorio. Son las variantes del mapa a las que se puede aplicar este MapContextConfig. Si está vacío, el MapContextConfig se aplicará de forma predeterminada solo a la variante de mapa ROADMAP.
create_time

Timestamp

Solo salida. Indica la fecha y hora de creación del objeto MapContextConfig. Solo salida.
update_time

Timestamp

Solo salida. Indica la fecha y hora de la última actualización de MapContextConfig. Solo salida.

MapVariant

Son las posibles variantes del mapa a las que se puede aplicar MapContextConfig. Las variantes de mapa se agrupan en variantes claras y oscuras. Una variante Light no se puede vincular con una variante Dark para el mismo MapContextConfig. Las variantes ligeras son ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D y PHOTOREALISTIC3D. Las variantes oscuras son ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK y TRANSIT_DARK.

Por ejemplo, el siguiente es un par válido: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

El siguiente es un par no válido: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Enums
ROADMAP Es el tipo de mapa de ruta predeterminado.
ROADMAP_DARK Es una versión oscura del tipo de mapa de hoja de ruta.
SATELLITE imágenes satelitales.
TERRAIN Tipo de mapa de terreno.
TERRAIN_DARK Es una versión oscura del tipo de mapa de terreno.
NAVIGATION Tipo de mapa de navegación.
NAVIGATION_LOW_LIGHT Es una versión con poca luz del tipo de mapa de navegación.
TRANSIT Tipo de mapa de transporte público.
TRANSIT_DARK Es una versión oscura del tipo de mapa de transporte público.
ABSTRACT3D Es un tipo de mapa abstracto en 3D.
PHOTOREALISTIC3D Tipo de mapa fotorrealista en 3D.

MapFeatures

Representa una colección de componentes de mapa que se aplican a un MapConfig. Todas las MapContextConfigs secundarias heredan los parámetros establecidos en una MapConfig. ID siguiente = 3;

Campos
simple_features[]

SimpleFeature

Opcional. Es la función visual que se usará para este mapa.
poi_boost_level

int32

Opcional. Nivel de potenciación del PDI, en el que 0 indica que no hay potenciaciones y los valores negativos indican una reducción de la potenciación. Los POIs potenciados se muestran con un nivel de zoom más bajo que el predeterminado y viceversa para los POIs no potenciados. Actualmente, admite 2 niveles de amplificación, por lo que el nivel se limita a [-2, 2]. Si no se especifica, se usará la densidad de PDI definida en la hoja de estilo, si existe. De lo contrario, no se aplicará ninguna densidad de PDI.

SimpleFeature

Representa el conjunto de componentes del mapa que afectan su estructura intrínseca.

Enums
SIMPLE_FEATURE_UNSPECIFIED Es una característica visual no especificada.
FLATTEN_BUILDINGS Aplanar todos los edificios del mapa
ICONIC_ICONS Influye en la forma en que se renderizan los íconos.

MapRenderingType

Es el tipo de mapa que se renderizará. El comportamiento predeterminado es RASTER si no se especifica.

Enums
RASTER Mapa renderizado con la implementación basada en ráster.
VECTOR Un mapa renderizado con WebGL.

StyleConfig

Representa un solo diseño en una aplicación cliente de la API de Maps. El objeto StyleConfig contiene la hoja de diseño que define la apariencia visual del mapa. ID siguiente = 9;

Campos
name

string

Solo salida. Es el identificador. Es el nombre del recurso de este StyleConfig. Por ejemplo: "projects/my-project-123/styleConfigs/234".
display_name

string

Opcional. Es el nombre visible de este StyleConfig, según lo especifica el usuario.
description

string

Opcional. Es la descripción de este StyleConfig, según lo especifica el usuario.
style_id

string

Solo salida. Es el identificador único de este estilo. Este es un campo de solo lectura que se genera cuando se crea el objeto StyleConfig. Solo salida.
json_style_sheet

string

Opcional. Es la representación JSON de la hoja de diseño de este StyleConfig. Si no se especifica, se usará el estilo base del mapa de Google. Consulta https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference para obtener más detalles sobre el formato JSON aceptable.
create_time

Timestamp

Solo salida. Indica la fecha y hora de creación del objeto StyleConfig.
update_time

Timestamp

Solo salida. Indica la fecha y hora de la última actualización de StyleConfig.

StyleConfigView

Qué subconjunto de StyleConfig se devolverá.

Enums
STYLE_CONFIG_VIEW_UNSPECIFIED Vista sin especificar.
FULL Incluye el json_style_sheet en la respuesta.
METADATA_ONLY Excluye json_style_sheet de la respuesta.

UpdateMapConfigRequest

Es la solicitud para actualizar un objeto MapConfig.

Campos
map_config

MapConfig

Obligatorio. Es el MapConfig que se actualizará.

El campo name de MapConfig se usa para identificar el MapConfig que se actualizará. Formato: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

Opcional. Es el campo específico que se debe actualizar para MapConfig. Si no se especifica, se actualizará todo el MapConfig. Los campos válidos son los siguientes:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Es una solicitud para actualizar un MapContextConfig.

Campos
map_context_config

MapContextConfig

Obligatorio. Es el objeto MapContextConfig que se actualizará.

El campo name de MapContextConfig se usa para identificar el MapContextConfig que se actualizará. Formato: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

Opcional. La lista de campos que se deben actualizar. Si no se especifica, se actualizará todo el MapContextConfig. Los campos válidos son los siguientes:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Solicitud para actualizar un objeto StyleConfig.

Campos
style_config

StyleConfig

Obligatorio. Es el objeto StyleConfig que se actualizará.

El campo name de StyleConfig se usa para identificar el objeto StyleConfig que se actualizará. Formato: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

Opcional. La lista de campos que se deben actualizar. Si no se especifica, se actualizará todo el objeto StyleConfig. Los campos válidos son los siguientes:

  • display_name
  • description
  • json_style_sheet