Les services Web Google Maps Platform sont un ensemble d'interfaces HTTP vers les services Google qui fournissent des données géographiques à vos applications cartographiques.
Ce guide décrit certaines pratiques courantes utiles pour configurer vos requêtes de service Web et traiter les réponses du service. Consultez le guide du développeur pour obtenir une documentation complète sur l'API Geolocation.
Qu'est-ce qu'un service Web ?
Les services Web Google Maps Platform sont une interface qui vous permet de demander des données d'API Google Maps à des services externes et d'utiliser les données dans vos applications Maps. Ces services sont conçus pour être utilisés conjointement avec une carte, conformément aux restrictions liées aux licences indiquées dans les conditions d'utilisation de Google Maps Platform.
Les services Web des API Google Maps envoient des requêtes HTTP(S) à des URL spécifiques en transmettant des paramètres d'URL et/ou des données POST au format JSON en tant qu'arguments aux services. En règle générale, ces services renvoient des données dans le corps de la réponse au format JSON pour être analysées et/ou traitées par votre application.
Les requêtes de géolocalisation sont envoyées à l'aide de la méthode POST à l'URL suivante :
https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_API_KEY
Remarque: Toutes les applications de l'API Geolocation nécessitent une authentification. En savoir plus sur les identifiants d'authentification
Accès SSL/TLS
HTTPS est requis pour toutes les requêtes Google Maps Platform qui utilisent des clés API ou contiennent des données utilisateur. Les requêtes effectuées via HTTP contenant des données sensibles peuvent être rejetées.
Bon usage des Google API
Les clients API mal conçus peuvent placer plus de charge que nécessaire sur Internet et les serveurs de Google. Cette section contient les bonnes pratiques pour les clients de ces API. Le respect de ces bonnes pratiques peut vous aider à éviter que votre application soit bloquée pour une utilisation abusive accidentelle des API.
Retrait exponentiel
Dans de rares cas, le traitement de votre requête peut poser problème. Vous pouvez recevoir un code de réponse HTTP 4XX ou 5XX, ou la connexion TCP peut simplement échouer entre votre client et le serveur de Google. Il est souvent utile de relancer la requête, car la requête de suivi peut réussir alors que la requête d'origine a échoué. Cependant, il est important de ne pas se contenter d'envoyer des requêtes en boucle aux serveurs de Google de façon répétée. Ce comportement de boucle peut surcharger le réseau entre votre client et Google, ce qui peut causer des problèmes pour de nombreuses parties.
Il est préférable de réessayer en allongeant progressivement les délais entre deux tentatives. En général, le délai est augmenté d'un facteur multiplicateur à chaque tentative, une approche connue sous le nom d'intervalle exponentiel entre les tentatives.
Prenons l'exemple d'une application qui souhaite envoyer cette requête à l'API Time Zone:
https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510×tamp=1331161200&key=YOUR_API_KEY
L'exemple Python suivant illustre comment effectuer la requête avec le retrait exponentiel :
import json
import time
import urllib.error
import urllib.parse
import urllib.request
# The maps_key defined below isn't a valid Google Maps API key.
# You need to get your own API key.
# See https://developers.google.com/maps/documentation/timezone/get-api-key
API_KEY = "YOUR_KEY_HERE"
TIMEZONE_BASE_URL = "https://maps.googleapis.com/maps/api/timezone/json"
def timezone(lat, lng, timestamp):
# Join the parts of the URL together into one string.
params = urllib.parse.urlencode(
{"location": f"{lat},{lng}", "timestamp": timestamp, "key": API_KEY,}
)
url = f"{TIMEZONE_BASE_URL}?{params}"
current_delay = 0.1 # Set the initial retry delay to 100ms.
max_delay = 5 # Set the maximum retry delay to 5 seconds.
while True:
try:
# Get the API response.
response = urllib.request.urlopen(url)
except urllib.error.URLError:
pass # Fall through to the retry loop.
else:
# If we didn't get an IOError then parse the result.
result = json.load(response)
if result["status"] == "OK":
return result["timeZoneId"]
elif result["status"] != "UNKNOWN_ERROR":
# Many API errors cannot be fixed by a retry, e.g. INVALID_REQUEST or
# ZERO_RESULTS. There is no point retrying these requests.
raise Exception(result["error_message"])
if current_delay > max_delay:
raise Exception("Too many retry attempts.")
print("Waiting", current_delay, "seconds before retrying.")
time.sleep(current_delay)
current_delay *= 2 # Increase the delay each time we retry.
if __name__ == "__main__":
tz = timezone(39.6034810, -119.6822510, 1331161200)
print(f"Timezone: {tz}")
Vous devez également veiller à ce qu'aucun code de nouvelle tentative ne se trouve plus haut dans la chaîne d'appel de l'application, ce qui entraîne des requêtes répétées à succession rapide.
Requêtes synchronisées
Un grand nombre de requêtes synchronisées vers les API de Google peuvent ressembler à une attaque par déni de service distribué (DDoS) sur l'infrastructure de Google et être traitées en conséquence. Pour éviter cela, vous devez vous assurer que les requêtes API ne sont pas synchronisées entre les clients.
Prenons l'exemple d'une application qui affiche l'heure dans le fuseau horaire actuel. Cette application définira probablement une alarme dans le système d'exploitation client pour la réveiller au début de la minute afin que l'heure affichée puisse être mise à jour. L'application ne doit pas effectuer d'appels d'API dans le cadre du traitement associé à cette alarme.
Il est déconseillé d'effectuer des appels d'API en réponse à une alarme fixe, car les appels d'API sont synchronisés au début de la minute, même entre différents appareils, au lieu d'être répartis uniformément dans le temps. Une application mal conçue qui effectue cette opération produira un pic de trafic 60 fois supérieur à la normale au début de chaque minute.
Il est recommandé d'avoir une seconde alerte définie sur une heure choisie de manière aléatoire. Lorsque cette deuxième alarme se déclenche, l'application appelle les API dont elle a besoin et stocke les résultats. Lorsque l'application souhaite mettre à jour son affichage en début de minute, elle utilise les résultats stockés précédemment au lieu d'appeler à nouveau l'API. Avec cette approche, les appels d'API sont répartis uniformément dans le temps. De plus, les appels d'API ne retardent pas le rendu lors de la mise à jour de l'affichage.
Hormis le début de la minute, les heures de synchronisation courantes à ne pas cibler sont le début d'une heure et le début de chaque journée à minuit.
Traitement des réponses
Cette section explique comment extraire ces valeurs de manière dynamique à partir des réponses d'un service Web.
Les services Web Google Maps fournissent des réponses faciles à comprendre, mais pas vraiment conviviales. Lorsque vous exécutez une requête, plutôt que d'afficher un ensemble de données, vous souhaitez probablement extraire quelques valeurs spécifiques. En règle générale, vous souhaitez analyser les réponses du service Web et extraire uniquement les valeurs qui vous intéressent.
Le schéma d'analyse que vous utilisez varie selon que vous renvoyez ou non une sortie au format JSON. Les réponses JSON, déjà sous la forme d'objets JavaScript, peuvent être traitées dans JavaScript lui-même sur le client.