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

Yêu cầu về độ cao

Các yêu cầu API độ cao được tạo dưới dạng chuỗi URL. API trả về dữ liệu độ cao cho các vị trí trên trái đất. Bạn có thể chỉ định dữ liệu vị trí theo một trong hai cách:

  • Dưới dạng một hoặc nhiều locations.
  • Dưới dạng một chuỗi các điểm nối nhau dọc theo path.

Một trong hai phương pháp này sử dụng toạ độ vĩ độ/kinh độ để xác định vị trí hoặc đỉnh của đường dẫn. Tài liệu này mô tả định dạng bắt buộc của URL API Elevation 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 với độ chính xác cao nhất có thể. 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 nếu các vị trí trải rộng vì một số hoạt động làm mượt dữ liệu sẽ xảy ra.

Yêu cầu API Độ cao có dạng sau:

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

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

  • json (được đề xuất), cho biết đầu ra trong 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 ý: URL phải được mã hoá đúng cách hợp lệ và bị giới hạn trong 16384 ký tự cho tất cả các dịch vụ web. Hãy lưu ý giới hạn này khi tạo URL. Xin lưu ý rằng các trình duyệt, proxy và máy chủ khác nhau cũng có thể có giới hạn ký tự URL khác nhau.

Bạn phải sử dụng giao thức HTTPS cho các yêu cầu sử dụng khoá API.

Yêu cầu thông số

Các yêu cầu gửi đến Elevation API sử dụng các tham số khác nhau dựa trên việc yêu cầu là cho các vị trí riêng biệt hay cho một đường dẫn được sắp xếp. Đối với các vị trí riêng biệt, yêu cầu trả lại độ cao dữ liệu về các vị trí cụ thể được chuyển trong yêu cầu; cho đường dẫn, thay vào đó, các yêu cầu độ 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ả URL, các tham số được phân tách bằng ký tự và (&amp;). Danh sách các thông số và giá trị có thể có của các thông số đó được biểu thị dưới đây.

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 cho mục đích 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. Tham số này lấy một vị trí duy nhất dưới dạng một cặp {vĩ độ, kinh độ} đượ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ột mảng hoặc dưới dạng một đa giác được mã hoá. Giới hạn là 512 điểm cho thông 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 độ cao. Tham số này xác định một tập hợp gồm hai hoặc các cặp {latitude,longitude} có thứ tự hơn xác định một con đường dọc theo bề mặt trái đất. Bạn phải dùng thông số này cùng với samples được mô tả bên dưới. Có giới hạn 512 điểm cho tham số cụ thể này. Để biết thêm thông tin, xem phần Chỉ định đường dẫn ở bên dưới.
  • samples (bắt buộc) chỉ định số lượng điểm lấy 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ề vị trí được biểu thị thông qua việc sử dụng Tham số locations, cho biết các yêu cầu về độ cao cho các vị trí cụ thể được chuyển qua vĩ độ/kinh độ.

Tham số locations có thể lấy những giá trị sau đối số:

  • Một toạ độ duy nhất: locations=40.714728,-73.998672
  • Một mảng toạ độ được phân tách bằng dấu gạch đứng ("|") ký tự: 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 đường đa tuyến tính được mã hoá: locations=enc:gfo}EtohhU

Chuỗi toạ độ vĩ độ và kinh độ được xác định bằng cách sử dụng chữ số trong một chuỗi văn bản được phân tách bằng dấu phẩy. Ví dụ: "40.714728,-73.998672" là 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ể lấy bất kỳ giá trị nào trong khoảng -9090 trong khi các giá trị kinh độ có thể lấy bất kỳ giá trị nào từ -180 đến 180. Nếu bạn chỉ định giá trị vĩ độ hoặc kinh độ không hợp lệ, yêu cầu của bạn sẽ bị từ chối vì là 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 được mã hoá hình nhiều đường mà vẫn tạo được URL hợp lệ. Xin lưu ý rằng khi truyền nhiều toạ độ, độ chính xác của mọi dữ liệu được trả về có thể có độ phân giải 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 "vị trí" hoặc "path" tham số trả về một giá trị INVALID_REQUEST phản hồi.

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

Các yêu cầu về đường dẫn mẫu được biểu thị bằng cách sử dụng path và tham số samples, cho biết yêu cầu cung cấp dữ liệu độ cao dọc theo một đường dẫn tại các khoảng thời gian xác định. Giống như với yêu cầu vị trí, việc sử dụng Tham số locations, tham số path 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 sắp xếp. Thay vì chỉ trả về dữ liệu độ cao tại các đỉnh, các yêu cầu về đường dẫn được lấy mẫu dọc theo chiều dài của đường dẫn, dựa trên số lượng samples được chỉ định (bao gồm cả các điểm cuối).

Tham số path có thể lấy một trong hai giá trị sau đối số:

  • 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ự dấu gạch đứng ("|"): path=40.714728,-73.998672|-34.397,150.644
  • Toạ độ được mã hoá bằng cách sử dụng Đã mã hoá Thuật toán đa dòng: path=enc:gfo}EtohhUxD@bAxJmGF

Chuỗi toạ độ kinh độ và vĩ độ được xác định bằng các 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ệ. Các giá trị vĩ độ và kinh độ phải tương ứng với nhau tại vị trí hợp lệ trên bề mặt trái đất. Vĩ độ có thể nhận giá trị bất kỳ trong khoảng từ -90 đến 90, trong khi kinh độ có thể nhận giá trị bất kỳ trong khoảng từ -180 đến 180. Nếu bạn chỉ định kinh độ hoặc vĩ độ không hợp lệ, yêu cầu của bạn sẽ bị từ chối là một yêu cầu không hợp lệ.

Bạn có thể truyền tối đa 512 toạ độ trong một mảng hoặc đường đa giác được mã hoá, trong khi vẫn tạo một URL hợp lệ. Xin lưu ý rằng khi truyền nhiều toạ độ, độ chính xác của mọi dữ liệu được trả về có thể có độ phân giải 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 "vị trí" hoặc "path" tham số trả về phản hồi INVALID_REQUEST.

Phản hồi về độ cao

Đối với mỗi yêu cầu hợp lệ, dịch vụ Độ cao sẽ trả về Độ cao theo đị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ể có thêm một trường error_message trong đối tượng phản hồi Elevation. Trường này chứa thêm thông tin chi tiết về lý do dẫn đến mã trạng thái nhất định.

Phản hồi chứa một mảng results với 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 vị trí

Ví dụ sau đây yêu cầu độ cao của Denver, Colorado, "Thành phố cao một dặm" ở đị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 hiển thị nhiều câu trả lời (cho Denver, CO và Thung lũng Chết, tiểu bang California).

Yêu cầu này minh hoạ cách 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ạ cách sử dụng cờ XML output:

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>

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

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>