Package google.maps.mapmanagement.v2alpha

Índice

MapManagement

A API Map Management oferece suporte a operações CRUD em recursos de Estilização de mapas baseada na nuvem: MapConfigs, StyleConfigs e MapContextConfigs. Com essa API, os desenvolvedores podem gerenciar a aparência dos mapas e estilizar de acordo com as especificações.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

Cria um MapConfig em um projeto.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

Cria um MapContextConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

Cria um StyleConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

Exclui um MapConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

Exclui um MapContextConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

Exclui um StyleConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

Recebe um MapConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

Recebe um MapContextConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

Recebe um StyleConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

Lista MapConfigs para um projeto.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

Lista MapContextConfigs.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

Lista StyleConfigs.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

Atualiza um MapConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

Atualiza um MapContextConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

Atualiza um StyleConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

CreateMapConfigRequest

Solicitação para criar um MapConfig.

Campos
parent

string

Obrigatório. Projeto pai que será proprietário do MapConfig. Formato: projects/{$my-project-id}
map_config

MapConfig

Obrigatório. O MapConfig a ser criado.

CreateMapContextConfigRequest

Solicitação para criar um MapContextConfig.

Campos
parent

string

Obrigatório. MapConfig principal que vai possuir o MapContextConfig. Formato: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

Obrigatório. O MapContextConfig a ser criado.

CreateStyleConfigRequest

Solicitação para criar um StyleConfig.

Campos
parent

string

Obrigatório. Projeto pai que será proprietário do StyleConfig. Formato: projects/{project}
style_config

StyleConfig

Obrigatório. O StyleConfig a ser criado.

DeleteMapConfigRequest

Solicitação para excluir um MapConfig. Se o MapConfig tiver MapContextConfigs filhos, eles também serão excluídos.

Campos
name

string

Obrigatório. Nome do recurso do MapConfig a ser excluído. Formato: projects/{project}/mapConfigs/{map_config}
force

bool

Opcional. Se definido como verdadeiro, todos os MapContextConfigs desse MapConfig também serão excluídos. Caso contrário, a solicitação só vai funcionar se o MapConfig não tiver MapContextConfigs.

DeleteMapContextConfigRequest

Solicitação para excluir um MapContextConfig.

Campos
name

string

Obrigatório. Nome do recurso do MapContextConfig a ser excluído. Formato: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Solicitação para excluir um StyleConfig.

Campos
name

string

Obrigatório. Nome do recurso do StyleConfig a ser excluído. Formato: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Solicitação para receber um MapConfig.

Campos
name

string

Obrigatório. Nome do recurso do MapConfig. Formato: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Solicitação para receber um MapContextConfig.

Campos
name

string

Obrigatório. Nome do recurso do MapContextConfig. Formato: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Solicitação para receber um StyleConfig.

Campos
name

string

Obrigatório. Nome do recurso StyleConfig. Formato: projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Solicitação para listar MapConfigs.

Campos
parent

string

Obrigatório. Projeto pai que é proprietário dos MapConfigs. Formato: projects/{project}
page_size

int32

Opcional. O número máximo de MapConfigs a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 MapConfigs serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. NO MOMENTO, NÃO É COMPATÍVEL.
page_token

string

Opcional. Um token de página recebido de uma chamada ListMapConfigs anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListMapConfigs precisam corresponder à chamada que forneceu o token da página. NO MOMENTO, NÃO É COMPATÍVEL.

ListMapConfigsResponse

Resposta para listar MapConfigs.

Campos
map_configs[]

MapConfig

A lista de MapConfigs.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes. NO MOMENTO, NÃO É COMPATÍVEL.

ListMapContextConfigsRequest

Solicitação para listar MapContextConfigs.

Campos
parent

string

Obrigatório. MapConfig principal que possui os MapContextConfigs. Formato: projects/{project}/mapConfigs/{map_config}
page_size

int32

Opcional. O número máximo de MapContextConfigs a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 MapContextConfigs serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. NO MOMENTO, NÃO É COMPATÍVEL.
page_token

string

Opcional. Um token de página recebido de uma chamada ListMapContextConfigs anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListMapContextConfigs precisam corresponder à chamada que forneceu o token da página. NO MOMENTO, NÃO É COMPATÍVEL.

ListMapContextConfigsResponse

Resposta para listar MapContextConfigs.

Campos
map_context_configs[]

MapContextConfig

Os MapContextConfigs.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes. NO MOMENTO, NÃO É COMPATÍVEL.

ListStyleConfigsRequest

Solicitação para listar StyleConfigs.

Campos
parent

string

Obrigatório. Projeto pai que é proprietário das StyleConfigs. Formato: projects/{project}
page_size

int32

Opcional. O número máximo de StyleConfigs a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 StyleConfigs serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. NO MOMENTO, NÃO É COMPATÍVEL.
page_token

string

Opcional. Um token de página recebido de uma chamada ListStyleConfigs anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListStyleConfigs precisam corresponder à chamada que forneceu o token da página. NO MOMENTO, NÃO É COMPATÍVEL.
filter

string

Opcional. Expressão de filtro para a chamada "ListStyleConfigs". No momento, só é possível filtrar por display_name. Por exemplo, display_name="My StyleConfig" vai retornar todas as StyleConfigs com o nome de exibição "My StyleConfig".
view

StyleConfigView

Opcional. O subconjunto de StyleConfig a ser retornado. Se não for definido, o comportamento padrão será retornar a visualização COMPLETA.

ListStyleConfigsResponse

Resposta para listar StyleConfigs.

Campos
style_configs[]

StyleConfig

Os StyleConfigs.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes. NO MOMENTO, NÃO É COMPATÍVEL.

MapConfig

Representa um único mapa em um aplicativo cliente da API Maps. O MapConfig é o recurso pai dos MapContextConfigs e permite a estilização personalizada em SDKs (mobile/Web). Um MapConfig pode ter vários MapContextConfigs, cada um aplicando estilos a variantes específicas do mapa. Próximo ID = 9;

Campos
name

string

Apenas saída. Identificador. Nome do recurso deste MapConfig. Por exemplo: "projects/my-project-123/mapConfigs/234". Apenas saída.
display_name

string

Opcional. O nome de exibição deste MapConfig, conforme especificado pelo usuário.
description

string

Opcional. A descrição deste MapConfig, conforme especificado pelo usuário.
map_id

string

Apenas saída. O ID do mapa deste MapConfig, usado para identificar o mapa em aplicativos clientes. Esse campo somente leitura é gerado quando o MapConfig é criado. Apenas saída.
map_features

MapFeatures

Opcional. Os recursos do mapa que se aplicam a essa configuração.
map_type

MapRenderingType

Opcional. Representa o tipo de mapa do MapConfig. Se não for definido, o comportamento padrão será usar o tipo de mapa rasterizado.
create_time

Timestamp

Apenas saída. Indica a hora de criação da configuração do mapa. Apenas saída.
update_time

Timestamp

Apenas saída. Indica a última atualização da configuração do mapa. Apenas saída.

MapContextConfig

Encapsula a configuração de estilo de um mapa. O MapContextConfig associa componentes de estilização, como um StyleConfig e conjuntos de dados, a variantes de mapa específicas de um MapConfig. Quando o MapConfig é carregado em um SDK, as informações de estilo e conjunto de dados do MapContextConfig são aplicadas às variantes de mapa especificadas. Próximo ID = 10;

Campos
name

string

Apenas saída. Identificador. Nome do recurso deste MapContextConfig. Por exemplo: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

Obrigatório. O nome do recurso MapConfig a que este MapContextConfig está associado. Formato: projects/{project}/mapConfigs/{map_config}. Esse campo é obrigatório e não pode ser omitido.
style_config

string

Obrigatório. O nome do recurso StyleConfig que está estilizando este MapContextConfig. Esse campo é obrigatório e não pode ser omitido. Formato: projects/{project}/styleConfigs/{style_config}
dataset[]

string

Opcional. O nome do recurso do conjunto de dados associado a este MapContextConfig. Esse campo é opcional e pode ser omitido. Se omitido, nenhum conjunto de dados será associado ao MapContextConfig. Se um conjunto de dados for especificado, ele será aplicado ao MapContextConfig. Formato: projects/{project}/datasets/{dataset}
alias

string

Opcional. O nome legível para humanos definido pelo usuário para este MapContextConfig.
map_variants[]

MapVariant

Obrigatório. As variantes de mapa a que esse MapContextConfig pode ser aplicado. Se estiver vazio, o MapContextConfig será aplicado por padrão apenas à variante de mapa ROADMAP.
create_time

Timestamp

Apenas saída. Indica o horário de criação do MapContextConfig. Apenas saída.
update_time

Timestamp

Apenas saída. Indica a última hora de atualização do MapContextConfig. Apenas saída.

MapVariant

Possíveis variantes de mapa a que o MapContextConfig pode ser aplicado. As variantes de mapa são agrupadas em variantes claras e escuras. Uma variante clara não pode ser pareada com uma variante escura para a mesma MapContextConfig. As variantes leves são: ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D, PHOTOREALISTIC3D. As variantes escuras são: ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK, TRANSIT_DARK.

Por exemplo, o seguinte é um pareamento válido: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

Este é um pareamento inválido: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Tipos enumerados
ROADMAP O tipo de mapa de vias padrão.
ROADMAP_DARK Uma versão escura do tipo de mapa de roteiro.
SATELLITE imagens de satélite.
TERRAIN Mapa de terreno.
TERRAIN_DARK Uma versão escura do mapa de terreno.
NAVIGATION Tipo de mapa de navegação.
NAVIGATION_LOW_LIGHT Uma versão com pouca luz do tipo de mapa de navegação.
TRANSIT Tipo de mapa de transporte público.
TRANSIT_DARK Uma versão escura do tipo de mapa de transporte público.
ABSTRACT3D Tipo de mapa 3D abstrato.
PHOTOREALISTIC3D Tipo de mapa 3D fotorrealista.

MapFeatures

Representa uma coleção de recursos de mapa que se aplicam a um MapConfig. Os recursos definidos em um MapConfig são herdados por todos os MapContextConfigs filhos. Próximo ID = 3;

Campos
simple_features[]

SimpleFeature

Opcional. O recurso visual a ser usado para este mapa.
poi_boost_level

int32

Opcional. Nível de aumento de POI, em que 0 indica que não há aumentos e valores negativos indicam redução. Os PDIs promovidos são mostrados com um zoom menor do que o padrão e vice-versa. No momento, há suporte para dois níveis de reforço, então o nível é fixado em [-2, 2]. Se não for especificada, a densidade de PDI definida na folha de estilo será usada, se existir. Caso contrário, nenhuma densidade de PDI será aplicada.

SimpleFeature

Representa o conjunto de recursos do mapa que afetam a estrutura intrínseca dele.

Tipos enumerados
SIMPLE_FEATURE_UNSPECIFIED Recurso visual não especificado.
FLATTEN_BUILDINGS Achata todos os edifícios no mapa.
ICONIC_ICONS Influencia a forma como os ícones são renderizados.

MapRenderingType

O tipo de mapa a ser renderizado. O comportamento padrão é RASTER se não for especificado.

Tipos enumerados
RASTER Um mapa renderizado usando a implementação baseada em raster.
VECTOR Um mapa renderizado usando WebGL.

StyleConfig

Representa um único estilo em um aplicativo cliente da API Maps. O StyleConfig contém a folha de estilo que define a aparência visual do mapa. Próximo ID = 9;

Campos
name

string

Apenas saída. Identificador. Nome do recurso deste StyleConfig. Por exemplo: "projects/my-project-123/styleConfigs/234".
display_name

string

Opcional. O nome de exibição deste StyleConfig, conforme especificado pelo usuário.
description

string

Opcional. A descrição deste StyleConfig, conforme especificado pelo usuário.
style_id

string

Apenas saída. O identificador exclusivo deste estilo. Este é um campo somente leitura gerado quando o StyleConfig é criado. Apenas saída.
json_style_sheet

string

Opcional. Representação JSON da folha de estilo para este StyleConfig. Se não for especificado, o estilo de mapa base do Google será usado. Consulte https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference para mais detalhes sobre o formato JSON aceito.
create_time

Timestamp

Apenas saída. Indica a hora de criação do StyleConfig.
update_time

Timestamp

Apenas saída. Indica o horário da última atualização do StyleConfig.

StyleConfigView

Qual subconjunto de StyleConfig será retornado.

Tipos enumerados
STYLE_CONFIG_VIEW_UNSPECIFIED Visualização não especificada.
FULL Inclua o json_style_sheet na resposta.
METADATA_ONLY Exclua o json_style_sheet da resposta.

UpdateMapConfigRequest

Solicitação para atualizar um MapConfig.

Campos
map_config

MapConfig

Obrigatório. O MapConfig a ser atualizado.

O campo name do MapConfig é usado para identificar o MapConfig a ser atualizado. Formato: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

Opcional. O campo específico a ser atualizado para o MapConfig. Se não for especificado, o MapConfig será atualizado por completo. Os campos válidos são:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Solicitação para atualizar um MapContextConfig.

Campos
map_context_config

MapContextConfig

Obrigatório. O MapContextConfig a ser atualizado.

O campo name do MapContextConfig é usado para identificar o MapContextConfig a ser atualizado. Formato: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

Opcional. Lista de campos a serem atualizados. Se não for especificado, o MapContextConfig será atualizado por completo. Os campos válidos são:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Solicitação para atualizar um StyleConfig.

Campos
style_config

StyleConfig

Obrigatório. O StyleConfig a ser atualizado.

O campo name do StyleConfig é usado para identificar o StyleConfig a ser atualizado. Formato: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

Opcional. Lista de campos a serem atualizados. Se não for especificado, o StyleConfig será atualizado por completo. Os campos válidos são:

  • display_name
  • description
  • json_style_sheet