此页面由 Cloud Translation API 翻译。

海拔请求和响应

海拔请求

Elevation API 请求以网址字符串形式构建。API 用于返回地球上各位置的海拔数据。您可以通过以下两种方式之一指定位置数据：

包含一个或多个 locations 的集合。
path 沿途的一系列相连的点。

这两种方法都使用纬度/经度坐标来识别位置或路径顶点。本文档介绍了 Elevation API 网址所需的格式及可用参数。

Elevation API 会返回单点查询的数据尽可能高的准确率。涉及多个位置的批量查询返回的数据准确性可能较低，尤其是在位置分布分散时因为系统会对数据进行一些平滑处理。

Elevation API 请求采用以下格式：

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

其中，outputFormat 可以是以下值之一：

json（推荐），表示以 JavaScript 对象标记 (JSON) 格式输出；或
xml，指示以 XML 格式输出，结果包装在 <ElevationResponse> 节点内。

注意：网址必须编码正确才有效，且对于所有网络服务，均不得超过 16384 个字符。请在构建网址时注意这一限制。请注意，不同的浏览器代理和服务器也可能有不同的网址字符数限制。

对于使用 API 密钥的请求，必须采用 HTTPS 协议。

请求参数

向 Elevation API 发出的请求根据请求的目标是分散位置还是有序路径来利用不同的参数。对于分散的地点，海拔请求会返回请求中传递的具体营业地点的相关数据；表示路径，海拔请求则改为沿指定路径进行抽样。

根据所有网址的标准，参数之间相互分隔使用和号 (&) 字符。参数列表及其可能的值如下所示。

所有请求

key —（必需）您的应用的 API 密钥。此密钥用于标识您的应用，以便进行配额管理。了解如何获取密钥。

位置请求

locations（必需）定义用于返回海拔数据的地球。此参数采用以英文逗号分隔的 {latitude,longitude} 对表示单个营业地点（例如“40.714728,-73.998672”）或多个纬度/经度对以数组或编码多段线的形式传递。积分上限为 512 点。如需更多信息请参阅下面的指定位置。

采样路径请求

path（必填）用于定义地球上用于返回海拔数据。此参数定义一组两个或两个更多有序的 {纬度,经度} 对，定义沿表面的路径此参数必须与 samples 结合使用参数。此特定参数的点数上限为 512 点。如需了解详情，请参阅下文的指定路径。
samples（必需）指定样本数量沿其返回海拔数据的路径上的点。samples 参数可将给定的 path 划分成该路径沿线的一组有序的等距点。

指定位置

通过利用 locations 参数来指定位置请求，该参数表示请求的目的是获得以纬度/经度值形式传递的具体位置的海拔。

locations 参数可能采用以下形式参数：

单个坐标：locations=40.714728,-73.998672
使用竖线（“|”）分隔的坐标数组字符：locations=40.714728,-73.998672|-34.397,150.644
使用已编码 Polyline Algorithm：locations=enc:gfo}EtohhU

纬度和经度坐标字符串使用逗号分隔文本字符串内的数字定义。例如，“40.714728,-73.998672”是有效的 locations 值。纬度和经度值必须对应于有效的位置在地球表面。纬度可以采用介于 -90 和 90，而经度值可以为介于 -180 和 180 之间的任何值。如果您指定纬度或经度值无效，您的请求将被拒绝错误请求。

您最多可在一个数组中传递最多 512 个坐标，同时仍然构造有效网址。请注意，传递多个坐标时与请求单个坐标的数据时相比，所返回的任何数据的分辨率精确度可能不如后者。如果“locations”或“path”参数中的点或坐标超过 512 个，系统会返回 INVALID_REQUEST 响应。

指定路径

通过使用 path 和 samples 参数来指示抽样路径请求，这些参数表示请求的目的是获得路径沿线指定间隔处的海拔数据。与使用 locations 形参，path 形参会指定一组纬度和经度值。不过，与位置请求不同的是 path 指定一组有序顶点。路径请求并不是仅返回顶点的海拔数据，而是根据指定的 samples 数量（包括端点）在路径沿线抽样。

path 参数可采用下列任一方法参数：

由两个或多个以英文逗号分隔的坐标文本字符串组成的数组使用竖线（“|”）分隔字符：path=40.714728,-73.998672|-34.397,150.644
使用编码多段线算法的编码坐标：path=enc:gfo}EtohhUxD@bAxJmGF

纬度和经度坐标字符串使用数字定义。例如： “40.714728,-73.998672|-34.397, 150.644”是有效的 path 值。纬度和经度值必须对应于地球表面上的有效位置。纬度可以采用介于 -90 和 90，而经度值可以为介于 -180 和 180 之间的任何值。如果您指定的纬度值或经度值无效，您的请求将作为无效请求而遭到拒绝。

您最多可在一个数组中传递最多 512 个坐标，同时仍然构造有效网址。请注意，将多个坐标时，任何返回数据的精确度可能会低于。超过 512 个点或坐标在“locations”中或“path”参数会返回 INVALID_REQUEST 响应。

海拔响应

对于每个有效请求，海拔服务都将返回海拔请求响应。

ElevationResponse

Field	Required	Type	Description
`results`	required	Array<ElevationResult>	See ElevationResult for more information.
`status`	required	ElevationStatus	See ElevationStatus for more information.
`error_message`	optional	string	When the service returns a status code other than `OK`, there may be an additional `error_message` field within the response object. This field contains more detailed information about thereasons behind the given status code. This field is not always returned, and its content is subject to change.

ElevationStatus

Status codes returned by service.

OK indicating the API request was successful.
DATA_NOT_AVAILABLE indicating that there's no available data for the input locations.
INVALID_REQUEST indicating the API request was malformed.
OVER_DAILY_LIMIT indicating any of the following:
- The API key is missing or invalid.
- Billing has not been enabled on your account.
- A self-imposed usage cap has been exceeded.
- The provided method of payment is no longer valid (for example, a credit card has expired).
OVER_QUERY_LIMIT indicating the requestor has exceeded quota.
REQUEST_DENIED indicating the API did not complete the request.
UNKNOWN_ERROR indicating an unknown error.

如果状态代码不是 OK，海拔响应对象中可能会包含附加的 error_message 字段。此字段更详细地说明了给定状态代码背后的原因。

响应包含一个具有以下元素的 results 数组：

ElevationResult

Field	Required	Type	Description
`elevation`	required	number	The elevation of the location in meters.
`location`	required	LatLngLiteral	A location element of the position for which elevation data is being computed. Note that for path requests, the set of location elements will contain the sampled points along the path. See LatLngLiteral for more information.
`resolution`	optional	number	The value indicating the maximum distance between data points from which the elevation was interpolated, in meters. This property will be missing if the resolution is not known. Note that elevation data becomes more coarse (larger resolution values) when multiple points are passed. To obtain the most accurate elevation value for a point, it should be queried independently.

location 对象包含以下元素：

LatLngLiteral

An object describing a specific location with Latitude and Longitude in decimal degrees.

Field	Required	Type	Description
`lat`	required	number	Latitude in decimal degrees
`lng`	required	number	Longitude in decimal degrees

位置海拔示例

以下示例请求的是丹佛的海拔，科罗拉多州的“里高城”（JSON 格式）：

网址

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

cURL

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

JSON

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

XML

<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>

以下示例显示多个响应（对科罗拉多州丹佛的响应和对加利福尼亚州死亡谷的响应）。

此请求演示了如何使用 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

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'

此请求演示了如何使用 XML output 标志：

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

选择下面的标签页，查看 JSON 和 XML 响应示例。

JSON

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

XML

<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>

以下示例请求获得从加利福尼亚州惠特尼峰至加利福尼亚州恶水滩（分别是美国大陆上的最高点和最低点）这条直线 path 上的海拔数据。我们请求获得三个 samples，以便将两个端点和中途点包括在内。

网址

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

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'

JSON

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

XML

<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>

海拔请求和响应

海拔请求

请求参数

所有请求

位置请求

采样路径请求

指定位置

指定路径

海拔响应

ElevationResponse

`results`

`status`

`error_message`

ElevationStatus

ElevationResult

`elevation`

`location`

`resolution`

LatLngLiteral

`lat`

`lng`

位置海拔示例

网址

cURL

JSON

XML

网址

cURL

JSON

XML

网址

cURL

JSON

XML