Class Maps

Maps

Permite encontrar direções, fazer geocodificação, amostragem de elevação e criar imagens estáticas de mapas.

Propriedades

Propriedade	Tipo	Descrição
DirectionFinder	DirectionFinderEnums
StaticMap	StaticMapEnums

Métodos

Método	Tipo de retorno	Breve descrição
decodePolyline(polyline)	Number[]	Decodifica uma string de polilinha codificada de volta em uma matriz de pontos.
encodePolyline(points)	String	Codifica uma matriz de pontos em uma string.
newDirectionFinder()	DirectionFinder	Cria um novo objeto DirectionFinder.
newElevationSampler()	ElevationSampler	Cria um objeto ElevationSampler.
newGeocoder()	Geocoder	Cria um novo objeto Geocoder.
newStaticMap()	StaticMap	Cria um objeto StaticMap.
resetAuthenticationApiKey()	void	Redefine as credenciais de autenticação para usar as cotas padrão.
setAuthenticationByApiKey(apiKey)	void	Permite o uso de uma chave de API para autenticar solicitações e aproveitar cotas adicionais.
setAuthenticationByApiKey(apiKey, signingKey)	void	Permite o uso de uma chave de API e uma chave de assinatura para autenticar solicitações e aproveitar cotas adicionais no StaticMap.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
setAuthentication(clientId, signingKey)	void	Permite o uso de uma conta do plano Premium das APIs Google Maps estabelecida externamente para aproveitar cotas adicionais.

Documentação detalhada

decodePolyline(polyline)

Decodifica uma string de polilinha codificada de volta em uma matriz de pontos.

// Decodes a string representation of the latitudes and longitudes of
// Minneapolis and Milwaukee respectively.
const polyline = 'qvkpG`qhxPbgyI_zq_@';
const points = Maps.decodePolyline(polyline);
for (let i = 0; i < points.length; i += 2) {
  Logger.log('%s, %s', points[i], points[i + 1]);
}

Parâmetros

Nome	Tipo	Descrição
polyline	String	Uma polilinha codificada para decodificar.

Retornar

Number[]: uma matriz de pares de latitude e longitude (lat0, long0, lat1, long1, ...).

Consulte também

• Formato de polilinha codificada

---

encodePolyline(points)

Codifica uma matriz de pontos em uma string.

// The latitudes and longitudes of New York and Boston respectively.
const points = [40.77, -73.97, 42.34, -71.04];
const polyline = Maps.encodePolyline(points);

Parâmetros

Nome	Tipo	Descrição
points	Number[]	Uma matriz de pares de latitude/longitude a serem codificados.

Retornar

String: uma string codificada que representa esses pontos.

Consulte também

• Formato de polilinha codificada

---

newDirectionFinder()

Cria um novo objeto DirectionFinder.

Retornar

DirectionFinder: um novo objeto de localizador de direção.

---

newElevationSampler()

Cria um objeto ElevationSampler.

Retornar

ElevationSampler: um novo objeto de amostragem de elevação.

---

newGeocoder()

Cria um novo objeto Geocoder.

Retornar

Geocoder: um novo objeto de geocodificador.

---

newStaticMap()

Cria um objeto StaticMap.

Retornar

StaticMap: um novo objeto de mapa estático.

---

resetAuthenticationApiKey()

Redefine as credenciais de autenticação para usar as cotas padrão. Esse método funciona quando você usa uma chave de API para autenticar solicitações. Esse método pode ser usado para reverter para as cotas padrão se você quiser usar os métodos Maps sem fornecer credenciais de autenticação.

Maps.resetAuthenticationApiKey();

Gera

Error: se setAuthentication(clientId, signingKey) estiver sendo usado para autenticação.

---

setAuthenticationByApiKey(apiKey)

Permite o uso de uma chave de API para autenticar solicitações e aproveitar cotas adicionais.

Esse método é usado para definir uma chave de API que é usada para autenticar solicitações. Quando esse método é chamado, o consumo de cota e o faturamento são cobrados do projeto na nuvem do Google Cloud associado à chave de API fornecida, de acordo com a tabela de preços. Você pode usar os métodos Maps com as cotas padrão sem fornecer credenciais de autenticação. Se você estiver usando o StaticMap, use o método setAuthenticationByApiKey(apiKey, signingKey).

Observação: se você estiver usando o ID do cliente para autenticar solicitações, saiba que ele foi descontinuado em 26 de maio de 2025 e não poderá mais ser usado após 31 de maio de 2026. Em vez de usar um ID do cliente, use credenciais de chave de API para autenticar o tráfego de serviço da API Google Maps. Para mais detalhes, consulte o guia.

Maps.setAuthenticationByApiKey('BBdgJpSbLtAtmkBFjgLt310qT6iekggfDdVqLC0');

Parâmetros

Nome	Tipo	Descrição
apiKey	String	Uma chave de API que pode ser obtida no console do Google Cloud seguindo as etapas mencionadas no guia de início rápido.

Gera

Error: se o apiKey for null ou se o setAuthentication(clientId, signingKey) já estiver sendo usado para autenticação.

---

setAuthenticationByApiKey(apiKey, signingKey)

Permite o uso de uma chave de API e uma chave de assinatura para autenticar solicitações e aproveitar cotas adicionais no StaticMap. Embora o signingKey seja necessário para solicitações à API Static Map, esse método também pode ser usado para autenticar outros serviços do Maps. Nesses casos, o parâmetro signingKey é ignorado.

Esse método é usado para definir uma chave de API e uma chave de assinatura, que são usadas para autenticar solicitações. A chave de assinatura é necessária para o StaticMap. Ela aceita um pequeno número de solicitações sem assinatura para fins de teste, mas começa a falhar quando atinge o limite na produção. Veja mais detalhes aqui.

Maps.setAuthenticationByApiKey('BBdgJpSbLtAtmkBFjgLt310qT6iekggfDdVqLC0',
'7_pry-Skg0PKxds-7nvdl91mB5=');

Parâmetros

Nome	Tipo	Descrição
apiKey	String	Uma chave de API que pode ser obtida no console do Google Cloud seguindo as etapas mencionadas no guia de início rápido.
signingKey	String	Uma chave de assinatura que pode ser obtida no console do Google Cloud seguindo as etapas mencionadas no guia de assinatura digital. Isso é necessário para o StaticMap e ignorado para outros serviços do Maps.

Gera

Error: se o apiKey for null ou se o setAuthentication(clientId, signingKey) já estiver sendo usado para autenticação.

Consulte também

• setAuthenticationByApiKey(apiKey)

Métodos obsoletos

setAuthentication(clientId, signingKey)

Obsoleto. Em vez disso, use setAuthenticationByApiKey(apiKey), que usa a chave de API para autenticação.

Permite o uso de uma conta do plano Premium das APIs Google Maps estabelecida externamente para aproveitar cotas adicionais. É possível encontrar o ID do cliente e a chave de assinatura na seção "Maps" do console do Google Cloud. Defina esses valores como null para voltar a usar as cotas padrão.

Observação: esse método não funciona com chaves de API. Além disso, o plano Premium não está mais disponível para novos clientes. Se você ainda não tiver uma licença do plano Premium, não chame setAuthentication(clientId, signingKey). É possível usar os métodos Maps com as cotas padrão.

Maps.setAuthentication('gme-123456789', 'VhSEZvOXVSdnlxTnpJcUE');

Parâmetros

Nome	Tipo	Descrição
clientId	String	Um identificador de cliente.
signingKey	String	Uma chave de assinatura privada.

Gera

Error: se setAuthenticationByApiKey(apiKey) já estiver sendo usado para a autenticação