Requêtes et réponses concernant l'altitude

Requêtes d'altitude

Les requêtes de l'API Elevation sont construites sous forme de chaîne d'URL. L'API renvoie des données d'altitude pour des points géographiques sur Terre. Vous pouvez spécifier les données de localisation de deux manières :

• En tant qu'ensemble d'un ou plusieurs locations.
• Sous la forme d'une série de points connectés le long d'une path.

Ces deux approches utilisent les coordonnées de latitude/longitude pour identifier les lieux ou les sommets du chemin. Ce document décrit le format requis des URL de l'API Elevation et les paramètres disponibles.

L'API Elevation renvoie des données pour les requêtes à point unique avec la plus grande précision possible. Les requêtes par lot impliquant plusieurs lieux peuvent renvoyer des données moins précises, en particulier si les lieux sont éloignés les uns des autres, car certaines données sont lissées.

Une requête de l'API Elevation se présente sous la forme suivante :

https://maps.googleapis.com/maps/api/elevation/outputFormat?parameters

où outputFormat peut avoir l'une des valeurs suivantes :

• json (recommandé), indique la sortie au format JavaScript Object Notation (JSON) ; ou
• xml : indique la sortie au format XML, encapsulée dans un nœud <ElevationResponse>.

Remarque : Pour être valides, les URL doivent être correctement encodées et sont limitées à 16 384 caractères pour tous les services Web. Tenez compte de cette limite lorsque vous créez vos URL. Notez que différents navigateurs, proxys et serveurs peuvent également avoir des limites de caractères différentes pour les URL.

HTTPS est requis pour les requêtes qui utilisent une clé API.

Paramètres de requête

Les requêtes envoyées à l'API Elevation utilisent différents paramètres selon qu'elles concernent des lieux distincts ou un chemin ordonné. Pour les lieux discrets, les requêtes d'altitude renvoient des données sur les lieux spécifiques transmis dans la requête. Pour les chemins, les requêtes d'altitude sont plutôt échantillonnées le long du chemin donné.

Comme c'est la norme pour toutes les URL, les différents paramètres sont séparés par une esperluette (&). La liste des paramètres et de leurs valeurs possibles est indiquée ci-dessous.

Toutes les demandes

• key : (obligatoire) clé API de votre application. Cette clé identifie votre application à des fins de gestion des quotas. Découvrez comment obtenir une clé.

Requêtes positionnelles

• locations (obligatoire) définit le ou les lieux sur Terre pour lesquels les données d'altitude doivent être renvoyées. Ce paramètre accepte un seul emplacement sous la forme d'une paire {latitude,longitude} séparée par une virgule (par exemple, "40.714728,-73.998672") ou plusieurs paires latitude/longitude transmises sous forme de tableau ou de polyligne encodée. Ce paramètre spécifique est limité à 512 points. Pour en savoir plus, consultez la section Spécifier des zones ci-dessous.

Requêtes de tracé échantillonné

• path (obligatoire) définit un tracé sur la Terre pour lequel renvoyer des données d'altitude. Ce paramètre définit un ensemble d'au moins deux paires {latitude,longitude} ordonnées définissant un chemin le long de la surface de la Terre. Ce paramètre doit être utilisé conjointement avec le paramètre samples décrit ci-dessous. Ce paramètre spécifique est limité à 512 points. Pour en savoir plus, consultez la section Spécifier des chemins d'accès ci-dessous.
• samples (obligatoire) spécifie le nombre de points échantillonnés le long d'un chemin pour lesquels renvoyer des données d'altitude. Le paramètre samples divise le path donné en un ensemble ordonné de points équidistants le long du chemin.

Spécifier des emplacements

Les requêtes positionnelles sont indiquées par l'utilisation du paramètre locations, qui indique les requêtes d'altitude pour les emplacements spécifiques transmis sous forme de valeurs de latitude/longitude.

Le paramètre locations peut accepter les arguments suivants :

• Une seule coordonnée : locations=40.714728,-73.998672
• Tableau de coordonnées séparées par une barre verticale (|) : locations=40.714728,-73.998672|-34.397,150.644
• Ensemble de coordonnées encodées à l'aide de l'algorithme de polyligne encodée : locations=enc:gfo}EtohhU

Les chaînes de coordonnées de latitude et de longitude sont définies à l'aide de chiffres dans une chaîne de texte séparée par des virgules. Par exemple, "40.714728,-73.998672" est une valeur locations valide. Les valeurs de latitude et de longitude doivent correspondre à un lieu valide sur la surface de la Terre. Les latitudes peuvent prendre n'importe quelle valeur entre -90 et 90, tandis que les longitudes peuvent prendre n'importe quelle valeur entre -180 et 180. Si vous spécifiez une valeur de latitude ou de longitude non valide, votre requête sera rejetée, car elle sera considérée comme incorrecte.

Vous pouvez insérer jusqu'à 512 coordonnées dans un tableau ou une polyligne encodée, tout en construisant une URL valide. Notez toutefois qu'en transmettant plusieurs coordonnées à la fois, l'exactitude des données renvoyées peut être moindre que lorsque votre requête ne porte que sur une seule coordonnée. Si vous dépassez 512 points ou coordonnées dans les paramètres "locations" ou "path", une réponse INVALID_REQUEST est renvoyée.

Spécifier des chemins d'accès

Les requêtes de tracé échantillonné sont indiquées par l'utilisation des paramètres path et samples, qui indiquent une demande de données d'altitude le long d'un tracé à des intervalles spécifiés. Comme pour les requêtes de position utilisant le paramètre locations, le paramètre path spécifie un ensemble de valeurs de latitude et de longitude. Toutefois, contrairement à une requête de position, path spécifie un ensemble ordonné de sommets. Plutôt que de renvoyer des données d'altitude uniquement aux sommets, les requêtes de tracé sont échantillonnées le long du trajet, en fonction du nombre de samples spécifié (y compris les extrémités).

Le paramètre path peut accepter l'un des arguments suivants :

• Tableau de deux chaînes de texte de coordonnées ou plus, séparées par une virgule et par une barre verticale (|) : path=40.714728,-73.998672|-34.397,150.644
• Coordonnées encodées à l'aide de l'algorithme de polyligne encodée : path=enc:gfo}EtohhUxD@bAxJmGF

Les chaînes de coordonnées de latitude et de longitude sont définies à l'aide de chiffres dans une chaîne de texte séparée par des virgules. Par exemple, "40.714728,-73.998672|-34.397, 150.644" est une valeur path valide. Les valeurs de latitude et de longitude doivent correspondre à un lieu valide sur la surface de la Terre. Les latitudes peuvent prendre n'importe quelle valeur entre -90 et 90, tandis que les longitudes peuvent prendre n'importe quelle valeur entre -180 et 180. Si vous spécifiez une valeur de latitude ou de longitude non valide, votre requête sera rejetée, car elle sera considérée comme incorrecte.

Vous pouvez insérer jusqu'à 512 coordonnées dans un tableau ou une polyligne encodée, tout en construisant une URL valide. Notez toutefois qu'en transmettant plusieurs coordonnées à la fois, l'exactitude des données renvoyées peut être moindre que lorsque votre requête ne porte que sur une seule coordonnée. Si vous dépassez 512 points ou coordonnées dans les paramètres "locations" ou "path", une réponse INVALID_REQUEST est renvoyée.

Réponses d'altitude

• Tableau de deux chaînes de texte de coordonnées ou plus, séparées par une virgule et par une barre verticale (|) : path=40.714728,-73.998672|-34.397,150.644
• Coordonnées encodées à l'aide de l'algorithme de polyligne encodée : path=enc:gfo}EtohhUxD@bAxJmGF

Les chaînes de coordonnées de latitude et de longitude sont définies à l'aide de chiffres dans une chaîne de texte séparée par des virgules. Par exemple, "40.714728,-73.998672|-34.397, 150.644" est une valeur path valide. Les valeurs de latitude et de longitude doivent correspondre à un lieu valide sur la surface de la Terre. Les latitudes peuvent prendre n'importe quelle valeur entre -90 et 90, tandis que les longitudes peuvent prendre n'importe quelle valeur entre -180 et -180. Si vous spécifiez une valeur de latitude ou de longitude non valide, votre requête sera rejetée, car elle sera considérée comme incorrecte.

Vous pouvez insérer jusqu'à 512 coordonnées dans un tableau ou une polyligne encodée, tout en construisant une URL valide. Notez toutefois qu'en transmettant plusieurs coordonnées à la fois, l'exactitude des données renvoyées peut être moindre que lorsque votre requête ne porte que sur une seule coordonnée. Si vous dépassez 512 points ou coordonnées dans les paramètres "locations" ou "path", une réponse INVALID_REQUEST est renvoyée.

Réponses d'altitude

Pour chaque requête valide, le service Elevation renvoie une réponse Elevation au format indiqué dans l'URL de la requête.

ElevationResponse

ElevationStatus

Codes d'état renvoyés par le service.

• OK, qui indique que la requête API a abouti.
• DATA_NOT_AVAILABLE indiquant qu'aucune donnée n'est disponible pour les emplacements d'entrée.
• INVALID_REQUEST, qui indique que la requête API n'a pas été rédigée correctement.
• OVER_DAILY_LIMIT indiquant l'un des éléments suivants :
  • La clé API est manquante ou non valide.
  • La facturation n'a pas été activée sur votre compte.
  • La limite d'utilisation que vous avez définie vous-même a été dépassée.
  • Le mode de facturation fourni n'est plus valide (une carte de crédit est arrivée à expiration, par exemple).
• OVER_QUERY_LIMIT, qui indique que le demandeur a dépassé le quota.
• REQUEST_DENIED, qui indique que l'API n'a pas terminé la requête.
• UNKNOWN_ERROR, qui indique une erreur inconnue.

Lorsque le code d'état est différent de OK, un champ error_message supplémentaire peut figurer dans l'objet de réponse "Elevation". Ce champ contient des informations plus détaillées sur les raisons du code d'état donné.

La réponse contient un tableau results avec les éléments suivants :

ElevationResult

LatLngLiteral

Objet décrivant un lieu spécifique avec une latitude et une longitude en degrés décimaux.

Exemples d'élévation positionnelle

L'exemple suivant demande l'altitude de Denver, dans le Colorado, surnommée la "Mile High City" :

https://maps.googleapis.com/maps/api/elevation/json
    ?locations=39.7391536%2C-104.9847034
    &key=YOUR_API_KEY
      

curl -L -X GET 'https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536%2C-104.9847034&key=YOUR_API_KEY'
      

        
{
  "results":
    [
      {
        "elevation": 1608.637939453125,
        "location": { "lat": 39.7391536, "lng": -104.9847034 },
        "resolution": 4.771975994110107,
      },
    ],
  "status": "OK",
}
        
        

        
<ElevationResponse>
 <status>OK</status>
 <result>
  <location>
   <lat>39.7391536</lat>
   <lng>-104.9847034</lng>
  </location>
  <elevation>1608.6379395</elevation>
  <resolution>4.7719760</resolution>
 </result>
</ElevationResponse>
        
        

L'exemple suivant montre plusieurs réponses (pour Denver, Colorado et pour la Vallée de la Mort, Californie).

Cette requête montre comment utiliser l'indicateur JSON output :

https://maps.googleapis.com/maps/api/elevation/json
    ?locations=39.7391536%2C-104.9847034%7C36.455556%2C-116.866667
    &key=YOUR_API_KEY
      

curl -L -X GET 'https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536%2C-104.9847034%7C36.455556%2C-116.866667&key=YOUR_API_KEY'
      

Cette requête montre comment utiliser l'option XML output :

https://maps.googleapis.com/maps/api/elevation/xml?locations=39.7391536,-104.9847034|36.455556,-116.866667&key=YOUR_API_KEY

Sélectionnez les onglets ci-dessous pour afficher des exemples de réponses JSON et XML.

      
{
  "results":
    [
      {
        "elevation": 1608.637939453125,
        "location": { "lat": 39.7391536, "lng": -104.9847034 },
        "resolution": 4.771975994110107,
      },
      {
        "elevation": -52.79492568969727,
        "location": { "lat": 36.455556, "lng": -116.866667 },
        "resolution": 19.08790397644043,
      },
    ],
  "status": "OK",
}
      
      

      
<ElevationResponse>
 <status>OK</status>
 <result>
  <location>
   <lat>39.7391536</lat>
   <lng>-104.9847034</lng>
  </location>
  <elevation>1608.6379395</elevation>
  <resolution>4.7719760</resolution>
 </result>
 <result>
  <location>
   <lat>36.4555560</lat>
   <lng>-116.8666670</lng>
  </location>
  <elevation>-52.7949257</elevation>
  <resolution>19.0879040</resolution>
 </result>
</ElevationResponse>
      
      

Les exemples suivants demandent des données d'altitude le long d'une ligne droite path allant du mont Whitney, en Californie, à Badwater, en Californie, qui sont les points les plus haut et les plus bas des États-Unis continentaux. Nous demandons trois samples, qui incluent les deux points de terminaison et le point à mi-chemin.

https://maps.googleapis.com/maps/api/elevation/json
  ?path=36.578581%2C-118.291994%7C36.23998%2C-116.83171
  &samples=3
  &key=YOUR_API_KEY
    

curl -L -X GET 'https://maps.googleapis.com/maps/api/elevation/json?path=36.578581%2C-118.291994%7C36.23998%2C-116.83171&samples=3&key=YOUR_API_KEY'
    

      
{
  "results":
    [
      {
        "elevation": 4411.94189453125,
        "location": { "lat": 36.578581, "lng": -118.291994 },
        "resolution": 19.08790397644043,
      },
      {
        "elevation": 1372.8359375,
        "location": { "lat": 36.41150289067028, "lng": -117.5602607523847 },
        "resolution": 9.543951988220215,
      },
      {
        "elevation": -84.51690673828125,
        "location": { "lat": 36.23998, "lng": -116.83171 },
        "resolution": 9.543951988220215,
      },
    ],
  "status": "OK",
}
      
      

      
<ElevationResponse>
 <status>OK</status>
 <result>
  <location>
   <lat>36.5785810</lat>
   <lng>-118.2919940</lng>
  </location>
  <elevation>4411.9418945</elevation>
  <resolution>19.0879040</resolution>
 </result>
 <result>
  <location>
   <lat>36.4115029</lat>
   <lng>-117.5602608</lng>
  </location>
  <elevation>1372.8359375</elevation>
  <resolution>9.5439520</resolution>
 </result>
 <result>
  <location>
   <lat>36.2399800</lat>
   <lng>-116.8317100</lng>
  </location>
  <elevation>-84.5169067</elevation>
  <resolution>9.5439520</resolution>
 </result>
</ElevationResponse>