Un token de sesión es un dato (un UUID) que se usa en las llamadas 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.
Lo incluyes como el valor de un parámetro session
que se agrega a todas las URLs de solicitud.
En la API de Map Tiles, un token de sesión representa un conjunto definido de opciones de visualización. Esto 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.
Actualmente, un token de sesión es válido durante dos semanas a partir de su emisión, pero esto puede cambiar. Puedes verificar el tiempo de vencimiento de un
token de sesión en cualquier momento. Para ello, consulta 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
- Las tarjetas de mapa pintadas estándar de Google Maps.
satellite
- Imágenes satelitales.
terrain
- Imágenes del terreno. Cuando selecciones
terrain
como el tipo de mapa, también debes 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 de IETF que especifica el idioma que se usa para mostrar información en las tarjetas. Por ejemplo,
en-US
especifica el idioma inglés tal como se habla en Estados Unidos.region
Un identificador de región (dos letras mayúsculas) del Common Locale Data Repository 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 las tarjetas de superposición. Si no especificas unimageFormat
, se elegirá automáticamente el mejor formato para la tarjeta. scale
Amplía el tamaño de los elementos del mapa (como las etiquetas de ruta), a la vez que conserva el tamaño de la tarjeta y el área de cobertura de la tarjeta predeterminada. Aumentar 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 componentes menores.
En los siguientes ejemplos, se muestra el efecto de escalar los elementos del mapa.
Factor de escala 1x | Factor de escala 2x |
---|---|
highDpi
- Especifica si se deben mostrar mosaicos de alta resolución. Si se aumenta el factor de escala, se usa
highDpi
para aumentar el tamaño de la tarjeta. Por lo general, aumentar el factor de escala aumenta la tarjeta resultante en una imagen del mismo tamaño, lo que disminuye la calidad. ConhighDpi
, el tamaño resultante también aumenta, lo que preserva la calidad. DPI significa puntos por pulgada, y el 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 valores descale
de 2x o 4x. No tiene efecto en las tarjetas de escala 1x.
Factor de escala 1x | Factor de escala 2x de alta densidad de píxeles |
---|---|
layerTypes
Es un array de valores que especifica los tipos de capas que se agregaron al mapa. Los valores válidos son los siguientes:
layerRoadmap
- Obligatorio si especificas
terrain
como el tipo de mapa. También se puede superponer de manera opcional en el tipo de mapasatellite
. No tiene efecto en las tarjetas de la planificación. layerStreetview
- Muestra las calles y ubicaciones habilitadas para Street View con contornos azules en el mapa.
layerTraffic
- Muestra las condiciones de tráfico actuales.
styles
Es un array de objetos de estilo JSON que especifican la apariencia y el nivel de detalle de las características del mapa, como rutas, parques y áreas urbanizadas. 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 ver la sintaxis de estilo completa, consulta la Referencia de estilos.overlay
Es un valor booleano que especifica si
layerTypes
se debe renderizar como una superposición independiente o combinarse con las imágenes de base. Cuando estrue
, 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 overlay
establecido en false
genera mosaicos equivalentes al tipo de mapa hybrid
que se usa en la API de Maps JavaScript (imagen de la izquierda). Los mismos tipos de mapa y capa con overlay
establecido en true
generan una tarjeta transparente con una superposición de mapa, con el diseño adecuado para superponerse a imágenes satelitales (imagen de la 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 especifican opciones adicionales para aplicar.
Las opciones compatibles son las siguientes:
MCYJ5E517XR2JC
: Acepta el nuevo estilo de mapa. Durante el período de participación, tus solicitudes obtendrán el estilo 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
- Un valor de 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 desde la época) en la que vence el token. Un token de sesión es válido durante dos semanas a partir de su creación, pero esta política puede cambiar sin previo aviso.
tileWidth
- Es el ancho de las tarjetas medido en píxeles.
tileHeight
- Es la altura de las tarjetas medida en píxeles.
imageFormat
- El formato de imagen, que puede ser
png
ojpeg
.