Utiliser des jetons de session avec l'API Map Tiles

Développeurs de l'Espace économique européen (EEE)

Un jeton de session est un élément de données (un UUID) utilisé dans les appels REST pour identifier une session, c'est-à-dire une série d'échanges de messages associés. Vous devez inclure un jeton de session dans toutes les requêtes d'images 2D et Street View. Vous l'incluez en tant que valeur d'un paramètre session ajouté à toutes les URL de requête.

Dans l'API Map Tiles, un jeton de session représente un ensemble défini d'options d'affichage. Cela signifie que vous n'avez pas besoin de transmettre un ensemble d'options d'affichage avec chaque requête de tuile. Vous pouvez utiliser le même jeton de session sur plusieurs clients. Un jeton de session est actuellement valide pendant deux semaines à compter de sa date d'émission, mais cela peut changer. Vous pouvez toujours vérifier la date d'expiration d'un jeton de session en examinant le champ expiry dans le message de réponse.

Requête de jeton de session

Pour demander un jeton de session, envoyez une requête HTTPS POST au point de terminaison createSession, comme illustré dans l'exemple suivant. Vous devez envoyer la requête avec un en-tête 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"

Champs obligatoires

mapType

Type de la carte de base. Cette valeur peut être l'une des suivantes :

roadmap: Tuiles de carte peintes Google Maps standards.
satellite: Imagerie satellite.
terrain: Imagerie du terrain. Lorsque vous sélectionnez terrain comme type de carte, vous devez également inclure le type de couche layerRoadmap (décrit dans la section Champs facultatifs ).
streetview: Panoramas Street View. Pour en savoir plus, consultez Tuiles Street View.

language

Balise de langue IETF qui spécifie la langue utilisée pour afficher les informations sur les tuiles. Par exemple, en-US spécifie la langue anglaise telle qu'elle est parlée aux États-Unis.

region

Un identifiant de région du Common Locale Data Repository (deux lettres majuscules) qui représente l'emplacement physique de l'utilisateur. Par exemple, US.

Champs facultatifs

imageFormat

Spécifie le format de fichier à renvoyer. Les valeurs valides sont jpeg ou png. Les fichiers JPEG ne sont pas compatibles avec la transparence. Ils ne sont donc pas recommandés pour les tuiles de superposition. Si vous ne spécifiez pas de imageFormat, le meilleur format pour la tuile est choisi automatiquement.

scale

Agrandit la taille des éléments de la carte (tels que les libellés de route), tout en conservant la taille de la tuile et la zone de couverture de la tuile par défaut. L'augmentation de l'échelle réduit également le nombre de libellés sur la carte, ce qui réduit l'encombrement. Les valeurs scale valides sont les suivantes :

scaleFactor1x : valeur par défaut.
scaleFactor2x : double la taille des libellés et supprime les libellés de fonctionnalités mineures.
scaleFactor4x : quadruple la taille des libellés et supprime les libellés de fonctionnalités mineures.

Les exemples suivants illustrent l'effet de la mise à l'échelle des éléments de la carte.

Facteur d'échelle 1x	Facteur d'échelle 2x

highDpi: Indique s'il faut renvoyer des tuiles haute résolution. Si le facteur d'échelle est augmenté, highDpi est utilisé pour augmenter la taille de la tuile. Normalement, l'augmentation du facteur d'échelle agrandit la tuile résultante en une image de même taille, ce qui réduit la qualité. Avec highDpi, la taille résultante est également augmentée, ce qui préserve la qualité. Le DPI (Dots per Inch) correspond au nombre de points par pouce. Un DPI élevé signifie que la tuile est rendue avec plus de points par pouce que la normale. Si la valeur est true, le nombre de pixels dans chacune des dimensions x et y est multiplié par le facteur d'échelle (c'est-à-dire 2x ou 4x). La zone de couverture de la tuile reste inchangée. Ce paramètre ne fonctionne qu'avec des valeurs scale de 2x ou 4x. Il n'a aucun effet sur les tuiles à l'échelle 1x.

Facteur d'échelle 1x	Facteur d'échelle 2x DPI élevé

layerTypes

Tableau de valeurs qui spécifie les types de calques ajoutés à la carte. Les valeurs valides sont les suivantes :

layerRoadmap: Obligatoire si vous spécifiez terrain comme type de carte. Peut également être superposé au type de carte satellite. N'a aucun effet sur les tuiles de carte routière.
layerStreetview: Affiche les rues et les lieux compatibles avec Street View à l'aide de contours bleus sur la carte.
layerTraffic: Affiche les conditions de circulation actuelles.

styles

Tableau d'objets de style JSON qui spécifie l'apparence et le niveau de détail des éléments de la carte, tels que les routes, les parcs et les zones bâties. Le style permet de personnaliser la carte de base Google standard. Le paramètre styles n'est valide que si le type de carte est roadmap. Pour obtenir la syntaxe complète du style, consultez la documentation de référence sur le style.

overlay

Valeur booléenne qui indique si layerTypes doit être rendu en tant que superposition distincte ou combiné à l'imagerie de base. Lorsque la valeur est true, la carte de base n'est pas affichée. Si vous n'avez défini aucun layerTypes, cette valeur est ignorée.

Par exemple, si vous demandez un type de carte satellite avec une couche layerRoadmap et que overlay est défini sur false, vous obtenez des tuiles équivalentes au type de carte hybrid utilisé dans l'API Maps JavaScript (image de gauche). Les mêmes types de carte et de couche avec overlay défini sur true génèrent une tuile transparente avec une superposition de carte, stylisée de manière appropriée pour être superposée à une imagerie satellite (image de droite).

`overlay`: false	`overlay`: true

Le JSON suivant est un exemple de corps de requête typique contenant des champs obligatoires et facultatifs.

{
  "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" }
      ]
    }
  ]
}

Cet exemple fournit une superposition adaptée à la combinaison avec une imagerie satellite. L'exemple contient à la fois une carte routière et une superposition Street View. La carte résultante est rendue avec des noms et des données en anglais, tels qu'ils sont parlés aux États-Unis.

Réponse de jeton de session

Le JSON suivant est un exemple de corps de réponse.

{
  "session": "IgAAAHGU9jnAU4KOAfwY3Bcd6eH_WxQsyocSBAdUnAr9pnvTTNXtF9c_27RBo94ytEXTDg",
  "expiry": "1361828036",
  "tileWidth": 256,
  "tileHeight": 256,
  "imageFormat": "png"
}

La liste suivante contient les définitions des champs du corps de la réponse.

session: Valeur de jeton de session que vous devez inclure dans toutes vos requêtes d'API Map Tiles.
expiry: Chaîne contenant l'heure (en secondes depuis l'epoch) à laquelle le jeton expire. Un jeton de session est valide pendant deux semaines à compter de sa date de création, mais cette règle peut changer sans préavis.
tileWidth: Largeur des tuiles mesurée en pixels.
tileHeight: Hauteur des tuiles mesurée en pixels.
imageFormat: Format de l'image, qui peut être png ou jpeg.