Un token de sesión es un dato (un UUID) que se usa en llamadas de REST para identificar una sesión, una serie de intercambios de mensajes relacionados. Debes incluir un token de sesión en todas las solicitudes de mosaicos 2D y de imágenes de Street View.
Se incluye como el valor de un parámetro session
anexado a todas las URL de solicitud.
En la API de Map Tiles API, un token de sesión representa un conjunto definido de opciones de visualización. Significa que no tienes que pasar un conjunto de opciones de visualización con cada solicitud de tarjeta. Puedes usar el mismo token de sesión en varios clientes.
Un token de sesión es válido por dos semanas a partir del momento de su emisión, pero esto puede cambiar. Siempre puedes verificar el tiempo de vencimiento de un token de sesión si observas el campo expiry
en el mensaje de respuesta.
Solicitud de token de sesión
Para solicitar un token de sesión, envía una solicitud HTTPS POST al extremo createSession
, como se muestra en el siguiente ejemplo. Debes enviar la solicitud con un encabezado Content-Type: application/json
.
curl -X POST -d '{ "mapType": "streetview", "language": "en-US", "region": "US" }' \ -H 'Content-Type: application/json' \ "https://tile.googleapis.com/v1/createSession?key=YOUR_API_KEY"
Campos obligatorios
mapType
tipo de mapa básico. Este valor puede ser uno de los siguientes:
roadmap
- Los mosaicos de mapas estándares pintados de Google Maps.
satellite
- Imágenes satelitales
terrain
- Imágenes del terreno Cuando selecciones
terrain
como el tipo de mapa, también deberás incluir el tipo de capalayerRoadmap
(que se describe en la sección Campos opcionales). streetview
- Panorámicas de Street View. Para obtener más información, consulta Tarjetas de Street View.
language
Una etiqueta de idioma IETF que especifica el idioma que se usa para mostrar la información en las tarjetas. Por ejemplo,
en-US
especifica el idioma inglés como se habla en Estados Unidos.region
Un identificador de región del repositorio de datos de configuración regional común (dos letras mayúsculas) que representa la ubicación física del usuario. Por ejemplo,
US
Campos opcionales
imageFormat
- Especifica el formato de archivo que se mostrará. Los valores válidos son
jpeg
opng
. Los archivos JPEG no admiten transparencia, por lo que no se recomiendan para mosaicos superpuestos. Si no especificas unimageFormat
, se elegirá automáticamente el mejor formato para la tarjeta. scale
Aumenta la escala de los elementos del mapa (como las etiquetas de rutas), pero conserva el tamaño de los mosaicos y el área de cobertura del mosaico predeterminado. El aumento de la escala también reduce la cantidad de etiquetas en el mapa, lo que reduce el desorden. Los siguientes valores son valores
scale
válidos:scaleFactor1x
: Es el valor predeterminado.scaleFactor2x
: Duplica el tamaño de la etiqueta y quita las etiquetas de componentes menores.scaleFactor4x
: cuadruplica el tamaño de la etiqueta y quita las etiquetas de atributos menores.
En los siguientes ejemplos, se demuestra el efecto de escalar los elementos del mapa.
Factor de escala 1x | Factor de escala 2x |
---|---|
highDpi
- Especifica si se deben devolver mosaicos de alta resolución. Si aumenta el factor de escala, se usa
highDpi
para aumentar el tamaño de la tarjeta. Por lo general, cuando se aumenta el factor de escala, se amplía el mosaico resultante a una imagen del mismo tamaño, lo que disminuye la calidad. ConhighDpi
, también aumenta el tamaño resultante, lo que mantiene la calidad. "DPI" significa puntos por pulgada, y "DPI alto" significa que la tarjeta se renderiza con más puntos por pulgada de lo normal. Si estrue
, la cantidad de píxeles en cada una de las dimensiones "x" e "y" se multiplica por el factor de escala (es decir , 2x o 4x). El área de cobertura de la tarjeta no se modifica. Este parámetro solo funciona con valoresscale
de 2x o 4x. No tiene ningún efecto en mosaicos con una escala de 1x.
Factor de escala 1x | Factor de escala 2x alto DPI |
---|---|
layerTypes
Es un array de valores que especifica los tipos de capas agregados al mapa. Los valores válidos son los siguientes:
layerRoadmap
- Es obligatorio si especificas
terrain
como el tipo de mapa. De manera opcional, también se puede superponer en el tipo de mapasatellite
. No tiene efecto en los mosaicos de hojas de ruta. layerStreetview
- Muestra calles y ubicaciones habilitadas para Street View con contornos azules en el mapa.
layerTraffic
- Muestra las condiciones actuales del tráfico.
styles
Es un array de objetos de diseño JSON que especifican el aspecto y el nivel de detalle de los componentes del mapa, como rutas, parques y áreas con edificaciones. El diseño se usa para personalizar el mapa base estándar de Google. El parámetro
styles
solo es válido si el tipo de mapa esroadmap
. Para conocer la sintaxis de diseño completa, consulta la Referencia de diseño.overlay
Es un valor booleano que especifica si
layerTypes
debe renderizarse como una superposición independiente o combinarse con las imágenes base. Cuando se establece entrue
, no se muestra el mapa base. Si no definiste ningúnlayerTypes
, se ignora este valor.
Por ejemplo, solicitar un tipo de mapa satellite
con una capa layerRoadmap
y establecer overlay
en false
genera mosaicos equivalentes al tipo de mapa hybrid
que se usa en la API de Maps JavaScript (imagen izquierda). Los mismos tipos de mapas y capas con overlay
establecido en true
generan un mosaico transparente con una superposición de mapa y un diseño adecuado para superponerse sobre imágenes satelitales (imagen derecha).
overlay : falso |
overlay : verdadero |
---|---|
El siguiente JSON es un ejemplo de un cuerpo de solicitud típico que contiene campos obligatorios y opcionales.
{
"mapType": "satellite",
"language": "en-US",
"region": "us",
"layerTypes": [ "layerRoadmap", "layerStreetview" ],
"overlay": true,
"scale": "scaleFactor1x",
"styles": [
{
"stylers": [
{ "hue": "#00ffe6" },
{ "saturation": -20 }
]
},{
"featureType": "road",
"elementType": "geometry",
"stylers": [
{ "lightness": 100 },
{ "visibility": "simplified" }
]
}
]
}
En este ejemplo, se proporciona una superposición adecuada para combinar con imágenes satelitales. El ejemplo contiene una hoja de ruta y una superposición de Street View. El mapa resultante se renderiza con nombres y datos en inglés, como se habla en Estados Unidos.
apiOptions
: Es un array de valores que especifica las opciones adicionales que se aplicarán.
Las opciones compatibles son las siguientes:
MCYJ5E517XR2JC
: Habilita el nuevo diseño de mapa. Durante el período de habilitación, tus solicitudes obtendrán el diseño existente, a menos que se especifique este valor.
Respuesta del token de sesión
El siguiente JSON es un ejemplo de cuerpo de respuesta.
{
"session": "IgAAAHGU9jnAU4KOAfwY3Bcd6eH_WxQsyocSBAdUnAr9pnvTTNXtF9c_27RBo94ytEXTDg",
"expiry": "1361828036",
"tileWidth": 256,
"tileHeight": 256,
"imageFormat": "png"
}
La siguiente lista contiene definiciones de los campos del cuerpo de la respuesta.
session
- Es un valor del token de sesión que debes incluir en todas tus solicitudes a la API de Map Tiles.
expiry
- Es una cadena que contiene la hora (en segundos a partir del ciclo de entrenamiento) en la que vence el token. Un token de sesión es válido durante dos semanas a partir del momento de su creación, pero esta política puede cambiar sin previo aviso.
tileWidth
- El ancho de los mosaicos medido en píxeles.
tileHeight
- Es la altura de los mosaicos medida en píxeles.
imageFormat
- Es el formato de imagen, que puede ser
png
ojpeg
.