Điểm cuối history cung cấp thông tin về chất lượng không khí theo giờ trong quá khứ cho một vị trí cụ thể, trong một phạm vi thời gian nhất định, tối đa là 30 ngày. Bạn có thể kiểm soát những chỉ số AQI và thông tin liên quan được trả về (chẳng hạn như nồng độ chất gây ô nhiễm và khuyến nghị về sức khoẻ).
Bạn có thể yêu cầu nhật ký chất lượng không khí theo giờ bằng cách sử dụng điểm cuối history bằng cách gửi yêu cầu HTTP POST đến:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
Thêm các lựa chọn yêu cầu vào nội dung yêu cầu JSON. Phần nội dung yêu cầu chứa vị trí và khoảng thời gian mà bạn muốn nhận nhật ký chất lượng không khí theo giờ. Bạn cũng có thể chọn nhiều cách để kiểm soát thông tin về chất lượng không khí cần đưa vào câu trả lời.
API Explorer cho phép bạn đưa ra các yêu cầu trực tiếp để có thể làm quen với API và các lựa chọn API:
Ví dụ về yêu cầu trong một giờ
Nội dung yêu cầu một giờ
Đoạn mã sau đây cho biết cách tạo một nội dung yêu cầu cho yêu cầu về nhật ký trong một giờ bằng phương thức history.
Trong ví dụ này, bạn đặt vị trí và dấu thời gian trong quá khứ.
curl -X POST -d '{
"dateTime": "2023-06-26T15:01:23Z",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Phản hồi trong vòng một giờ
Lệnh gọi ở trên sẽ tạo ra phản hồi JSON sau đây. Để biết thêm thông tin về dữ liệu phản hồi, hãy xem phần Dữ liệu phản hồi.
{ "hoursInfo": [ { "dateTime": "2023-06-26T15:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 73, "aqiDisplay": "73", "color": { "red": 118, "green": 202, "blue": 51, "alpha": 255 }, "category": "Good air quality", "dominantPollutant": "pm10" } ] } ], "regionCode": "us" }
Ví dụ về yêu cầu phạm vi thời gian
Yêu cầu về phạm vi thời gian
Đoạn mã sau đây cho biết cách tạo một phần nội dung yêu cầu cho history. Phần nội dung này trả về nhiều bản ghi về chất lượng không khí theo giờ trong quá khứ.
Bạn có thể yêu cầu nhiều bản ghi bằng cách chỉ định một phạm vi thời gian (tức là dấu thời gian bắt đầu và kết thúc) hoặc bằng cách chỉ định số giờ trước thời gian hiện tại.
Trong ví dụ bên dưới, vì bạn đặt kích thước trang thành 2, nên yêu cầu của bạn về 4 giờ dữ liệu lịch sử chất lượng không khí sẽ được trả về trong 2 trang, trong đó mỗi trang chứa 2 giờ dữ liệu.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Bạn có thể đưa ra yêu cầu tương tự bằng cách truyền dấu thời gian bắt đầu và kết thúc:
curl -X POST -d '{
"period": {
"startTime":"2023-06-15T08:00:00Z",
"endTime":"2023-06-15T12:00:00Z"
},
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Phản hồi về phạm vi thời gian
Các lệnh gọi ở trên sẽ tạo ra một phản hồi JSON ở dạng dưới đây. Để biết thêm thông tin về dữ liệu phản hồi, hãy xem phần Dữ liệu phản hồi.
Cả hai lệnh gọi trên đều yêu cầu dữ liệu về chất lượng không khí trong 4 giờ. Tuy nhiên, vì bạn đặt thuộc tính pageSize thành 2 trong yêu cầu, nên phản hồi chỉ bao gồm kết quả trong 2 giờ gần đây nhất.
{ "hoursInfo": [ { "dateTime": "2023-06-15T11:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 83, "aqiDisplay": "83", "color": { "red": 74, "green": 185, "blue": 54, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] }, { "dateTime": "2023-06-15T10:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 89, "aqiDisplay": "89", "color": { "red": 48, "green": 175, "blue": 55, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] } ], "regionCode": "us", "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA" }
Xin lưu ý rằng phản hồi cũng bao gồm thuộc tính nextPageToken. Sử dụng thuộc tính này để truy cập vào trang kết quả tiếp theo, chứa dữ liệu của 2 giờ tiếp theo.
Để truy cập vào trang kết quả tiếp theo, hãy đưa ra yêu cầu thứ hai đến điểm cuối history, nhưng lần này hãy đặt thuộc tính pageToken thành giá trị của nextPageToken trong phản hồi đầu tiên.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Hãy dùng thử!
Trình khám phá API cho phép bạn đưa ra các yêu cầu mẫu để có thể làm quen với API và các lựa chọn API.
Chọn biểu tượng API api ở bên phải trang.
Bạn có thể chỉnh sửa các tham số yêu cầu (không bắt buộc).
Chọn nút Thực thi. Trong hộp thoại, hãy chọn tài khoản mà bạn muốn dùng để đưa ra yêu cầu.
Trong bảng điều khiển APIs Explorer, hãy chọn biểu tượng toàn màn hình fullscreen để mở rộng cửa sổ APIs Explorer.