Yêu cầu và phản hồi về độ cao

Yêu cầu độ cao

Yêu cầu API độ cao được tạo dưới dạng chuỗi URL. API này trả về dữ liệu về độ cao cho các vị trí trên trái đất. Bạn chỉ định dữ liệu vị trí bằng một trong 2 cách sau:

  • Tập hợp gồm một hoặc nhiều locations.
  • Dưới dạng một chuỗi các điểm được kết nối dọc theo path.

Một trong hai cách tiếp cận này sử dụng toạ độ vĩ độ/kinh độ để xác định các vị trí hoặc đỉnh đường dẫn. Tài liệu này mô tả định dạng bắt buộc của URL API độ cao và các tham số có sẵn.

API độ cao trả về dữ liệu cho các truy vấn một điểm có độ chính xác cao nhất có thể. Các truy vấn theo lô liên quan đến nhiều vị trí có thể trả về dữ liệu với độ chính xác thấp hơn, đặc biệt là khi các vị trí bị tách biệt, vì quá trình làm mượt dữ liệu sẽ diễn ra.

Yêu cầu API độ cao có dạng sau đây:

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

trong đó outputFormat có thể là một trong các giá trị sau:

  • json (nên dùng), cho biết đầu ra ở dạng Ký hiệu đối tượng JavaScript (JSON); hoặc
  • xml, cho biết đầu ra ở định dạng XML, được gói trong một nút <ElevationResponse>.

Lưu ý: Các URL phải được mã hoá đúng thì mới hợp lệ và chỉ được có tối đa 16384 ký tự cho mọi dịch vụ web. Hãy lưu ý đến giới hạn này khi tạo URL của bạn. Xin lưu ý rằng các trình duyệt, proxy và máy chủ khác nhau cũng có thể có các giới hạn ký tự URL khác nhau.

Bạn cần sử dụng HTTPS cho các yêu cầu sử dụng khoá API.

Thông số yêu cầu

Các yêu cầu đến API độ cao sử dụng các tham số khác nhau dựa trên việc yêu cầu dành cho các vị trí riêng biệt hay đường dẫn được sắp xếp theo thứ tự. Đối với các vị trí riêng biệt, yêu cầu về độ cao trả về dữ liệu tại những vị trí cụ thể được truyền trong yêu cầu; đối với đường dẫn, yêu cầu về độ cao sẽ được lấy mẫu dọc theo một đường dẫn nhất định.

Theo tiêu chuẩn trong tất cả các URL, các tham số được phân tách bằng ký tự ký hiệu và (&amp;). Danh sách các tham số và giá trị có thể có được biểu thị bên dưới.

Tất cả yêu cầu

  • key – (bắt buộc) Khoá API của ứng dụng. Khoá này xác định ứng dụng của bạn để quản lý hạn mức. Tìm hiểu cách lấy khoá.

Yêu cầu vị trí

  • locations (bắt buộc) xác định(các) vị trí trên trái đất để trả về dữ liệu độ cao từ đó. Thông số này lấy một vị trí dưới dạng một cặp {latitude,longitude} được phân tách bằng dấu phẩy (ví dụ: "40.714728,-73.998672") hoặc nhiều cặp vĩ độ/kinh độ được truyền dưới dạng mảng hoặc hình nhiều đường được mã hoá. Có giới hạn là 512 điểm cho tham số cụ thể này. Để biết thêm thông tin, hãy xem phần Chỉ định vị trí ở bên dưới.

Yêu cầu đường dẫn được lấy mẫu

  • path (bắt buộc) xác định một đường dẫn trên trái đất để trả về dữ liệu về độ cao. Tham số này xác định một tập hợp gồm hai hoặc nhiều cặp {latitude,longitude} xác định một đường đi dọc theo bề mặt trái đất. Tham số này phải được dùng cùng với tham số samples được mô tả dưới đây. Thông số cụ thể này có giới hạn là 512 điểm. Để biết thêm thông tin, hãy xem phần Chỉ định đường dẫn ở bên dưới.
  • samples (bắt buộc) chỉ định số điểm mẫu dọc theo một đường dẫn để trả về dữ liệu độ cao. Tham số samples chia path đã cho thành một tập hợp các điểm cách đều nhau theo thứ tự dọc theo đường dẫn.

Chỉ định vị trí

Yêu cầu vị trí được biểu thị thông qua việc sử dụng tham số locations, cho biết yêu cầu về độ cao cho những vị trí cụ thể được chuyển dưới dạng giá trị vĩ độ/kinh độ.

Tham số locations có thể nhận các đối số sau:

  • Một toạ độ duy nhất: locations=40.714728,-73.998672
  • Một mảng toạ độ được phân tách bằng ký tự gạch đứng ("|"): locations=40.714728,-73.998672|-34.397,150.644
  • Một tập hợp các toạ độ được mã hoá bằng Thuật toán nhiều đường được mã hoá: locations=enc:gfo}EtohhU

Chuỗi toạ độ kinh độ và vĩ độ được xác định bằng chữ số trong chuỗi văn bản được phân tách bằng dấu phẩy. Ví dụ: "40.714728,-73.998672" là một giá trị locations hợp lệ. Giá trị vĩ độ và kinh độ phải tương ứng với một vị trí hợp lệ trên bề mặt trái đất. Vĩ độ có thể nhận giá trị bất kỳ từ -90 đến 90, còn giá trị kinh độ có thể nhận bất kỳ giá trị nào từ -180 đến 180. Nếu bạn chỉ định một giá trị vĩ độ hoặc kinh độ không hợp lệ, thì yêu cầu của bạn sẽ bị từ chối vì là một yêu cầu không hợp lệ.

Bạn có thể chuyển tối đa 512 toạ độ trong một mảng hoặc nhiều đường được mã hoá, trong khi vẫn tạo URL hợp lệ. Lưu ý rằng khi chuyển nhiều toạ độ, độ chính xác của dữ liệu được trả về có thể thấp hơn so với khi yêu cầu dữ liệu cho một toạ độ. Vượt quá 512 điểm hoặc toạ độ trong các thông số "vị trí" hoặc "đường dẫn" sẽ trả về phản hồi INVALID_REQUEST.

Chỉ định đường dẫn

Các yêu cầu về đường dẫn được lấy mẫu được biểu thị bằng việc sử dụng các tham số pathsamples, cho biết có một yêu cầu về dữ liệu độ cao theo một đường dẫn tại những khoảng thời gian cụ thể. Giống như các yêu cầu về vị trí sử dụng tham số locations, tham số path sẽ chỉ định một tập hợp các giá trị vĩ độ và kinh độ. Tuy nhiên, không giống như yêu cầu vị trí, path chỉ định một tập hợp các đỉnh có thứ tự. Thay vì chỉ trả về dữ liệu độ nâng ở các đỉnh, các yêu cầu đường dẫn được lấy mẫu theo độ dài của đường dẫn, dựa trên số lượng samples được chỉ định (bao gồm các điểm cuối).

Tham số path có thể nhận một trong các đối số sau:

  • Một mảng gồm hai hoặc nhiều chuỗi văn bản toạ độ được phân tách bằng dấu phẩy được phân tách bằng ký tự gạch đứng ("|"): path=40.714728,-73.998672|-34.397,150.644
  • Toạ độ được mã hoá bằng Thuật toán nhiều đường được mã hoá: path=enc:gfo}EtohhUxD@bAxJmGF

Chuỗi toạ độ kinh độ và vĩ độ được xác định bằng chữ số trong chuỗi văn bản được phân tách bằng dấu phẩy. Ví dụ: "40.714728,-73.998672|-34.397, 150.644" là một giá trị path hợp lệ. Giá trị vĩ độ và kinh độ phải tương ứng với một vị trí hợp lệ trên mặt trái đất. Vĩ độ có thể nhận giá trị bất kỳ từ -90 đến 90, còn giá trị kinh độ có thể nhận bất kỳ giá trị nào từ -180 đến 180. Nếu bạn chỉ định một giá trị vĩ độ hoặc kinh độ không hợp lệ, thì yêu cầu của bạn sẽ bị từ chối vì là một yêu cầu không hợp lệ.

Bạn có thể chuyển tối đa 512 toạ độ trong một mảng hoặc nhiều đường được mã hoá, trong khi vẫn tạo URL hợp lệ. Lưu ý rằng khi truyền nhiều toạ độ, độ chính xác của dữ liệu được trả về có thể thấp hơn so với khi yêu cầu dữ liệu cho một toạ độ. Vượt quá 512 điểm hoặc toạ độ trong thông số "vị trí" hoặc "đường dẫn" sẽ trả về phản hồi INVALID_REQUEST.

Phản hồi độ cao

Đối với mỗi yêu cầu hợp lệ, dịch vụ Độ cao sẽ trả về phản hồi Độ cao ở định dạng được chỉ định trong URL yêu cầu.

ElevationResponse

FieldRequiredTypeDescription
required Array<ElevationResult> See ElevationResult for more information.
requiredElevationStatus See ElevationStatus for more information.
optionalstring

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.

Khi mã trạng thái không phải là OK, có thể sẽ có thêm trường error_message trong đối tượng phản hồi Độ cao. Trường này chứa thông tin chi tiết hơn về lý do dẫn đến mã trạng thái đã cho.

Phản hồi chứa một mảng results có các phần tử sau:

ElevationResult

FieldRequiredTypeDescription
requirednumber

The elevation of the location in meters.

requiredLatLngLiteral

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.

optionalnumber

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.

Đối tượng location có các phần tử sau:

LatLngLiteral

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

FieldRequiredTypeDescription
requirednumber

Latitude in decimal degrees

requirednumber

Longitude in decimal degrees

Ví dụ về độ cao theo vị trí

Ví dụ sau đây yêu cầu độ cao cho Denver, Colorado, "Thành phố Mile High" ở định dạng JSON:

URL

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>

Ví dụ sau đây cho thấy nhiều câu trả lời (cho Denver, CO và Death Valley, CA).

Yêu cầu này minh hoạ việc sử dụng cờ JSON output:

URL

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'

Yêu cầu này minh hoạ việc sử dụng cờ output XML:

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

Chọn các thẻ bên dưới để xem phản hồi JSON và XML mẫu.

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>

Những ví dụ sau đây yêu cầu dữ liệu độ cao dọc theo một đường thẳng path từ Núi Whitney, California đến Badwater, CA, điểm cao nhất và thấp nhất trong lục địa Hoa Kỳ. Chúng tôi yêu cầu ba samples, để bao gồm hai điểm cuối và một điểm giữa.

URL

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>