Method: forecast.lookup

Trả về thông tin dự báo về chất lượng không khí cho một vị trí cụ thể trong một khoảng thời gian nhất định.

Yêu cầu HTTP

POST https://airquality.googleapis.com/v1/forecast:lookup

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Trường
location

object (LatLng)

Bắt buộc. Vĩ độ và kinh độ mà API tìm dữ liệu chất lượng không khí.
extraComputations[]

enum (ExtraComputation)

Không bắt buộc. Bạn có thể bật các tính năng bổ sung nếu muốn. Việc chỉ định các phép tính bổ sung sẽ dẫn đến việc trả về các phần tử và trường có liên quan trong phản hồi.
uaqiColorPalette

enum (ColorPalette)

Không bắt buộc. Xác định bảng màu dùng cho dữ liệu được cung cấp theo "Chỉ số chất lượng không khí toàn cầu" (UAQI). Bảng màu này chỉ liên quan đến UAQI, các chỉ số AQI khác có bảng màu định sẵn và không thể kiểm soát được.
customLocalAqis[]

object (CustomLocalAqi)

Không bắt buộc. Thể hiện "quốc gia/khu vực theo chỉ số AQI" mối quan hệ. Ghép nối một quốc gia/khu vực với một chỉ số AQI mong muốn để dữ liệu chất lượng không khí cần thiết cho quốc gia/khu vực đó sẽ hiển thị theo AQI đã chọn. Bạn có thể dùng tham số này để chỉ định một chỉ số AQI không mặc định cho một quốc gia cụ thể, chẳng hạn như để lấy chỉ số EPA của Hoa Kỳ cho Canada thay vì chỉ số mặc định cho Canada.
pageSize

integer

Không bắt buộc. Số lượng bản ghi thông tin hằng giờ tối đa được trả về trên mỗi trang (mặc định là 24).
pageToken

string

Không bắt buộc. Đã nhận được mã thông báo trang từ lệnh gọi dự báo trước đó. Hàm này được dùng để truy xuất trang tiếp theo.
dateTime

string (Timestamp format)

Dấu thời gian để trả về dữ liệu cho một thời điểm cụ thể. Dấu thời gian được làm tròn đến giờ chính xác trước đó.

Lựa chọn này sẽ chỉ trả về dữ liệu hằng giờ cho dấu thời gian được yêu cầu (tức là một phần tử thông tin hằng giờ duy nhất). Ví dụ: yêu cầu được gửi khi tham số dateTime được đặt thành 2023-01-03T11:05:49Z sẽ được làm tròn xuống 2023-01-03T11:00:00Z.

Lưu ý: Bạn có thể dùng dateTime hoặc startTime và endTime trong yêu cầu.
period

object (Interval)

Cho biết khoảng thời gian startTime và endTime sẽ nhận dữ liệu dự báo. endTime có tính toàn bộ. Dấu thời gian được làm tròn đến giờ chính xác trước đó.

Lưu ý: Bạn có thể dùng dateTime hoặc startTime và endTime trong yêu cầu.
universalAqi

boolean

Không bắt buộc. Nếu bạn đặt chính sách này thành true, thì chỉ số AQI chung sẽ được đưa vào các "chỉ số" trường phản hồi (mặc định = true).
languageCode

string

Không bắt buộc. Cho phép khách hàng chọn ngôn ngữ cho câu trả lời. Nếu không thể cung cấp dữ liệu cho ngôn ngữ đó, API sẽ sử dụng kết quả phù hợp nhất. Các giá trị được phép phụ thuộc vào tiêu chuẩn IETF (mặc định = "en").

Nội dung phản hồi

Đối tượng phản hồi của API dự báo chất lượng không khí.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Trường
hourlyForecasts[]

object (HourlyForecast)

Không bắt buộc. Chứa thông tin về chất lượng không khí cho từng giờ trong phạm vi yêu cầu. Ví dụ: nếu yêu cầu dự báo cho 48 giờ, thì sẽ có 48 phần tử của dự báo hằng giờ.
regionCode

string

Không bắt buộc. Mã ISO_3166-1 alpha-2 của quốc gia/khu vực tương ứng với vị trí được cung cấp trong yêu cầu. Trường này có thể bị bỏ qua trong phản hồi nếu vị trí được cung cấp trong yêu cầu nằm ở lãnh thổ tranh chấp.
nextPageToken

string

Không bắt buộc. Mã thông báo để truy xuất trang tiếp theo.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.

HourlyForecast

Chứa thông tin về chất lượng không khí cho từng giờ trong phạm vi yêu cầu. Ví dụ: nếu yêu cầu dự báo cho 48 giờ, thì sẽ có 48 phần tử của dự báo hằng giờ.

Biểu diễn dưới dạng JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Trường
dateTime

string (Timestamp format)

Dấu thời gian được làm tròn xuống cho biết thời gian (giờ) mà dữ liệu đề cập trong RFC3339 giờ UTC "Zulu" . Ví dụ: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

Dựa trên các thông số theo yêu cầu, danh sách này sẽ bao gồm (tối đa) 2 chỉ số chất lượng không khí:

  • Chỉ số AQI toàn cầu. Sẽ được trả về nếu boolean universalAqi được đặt thành true.
  • Chỉ số chất lượng không khí (AQI) tại địa phương. Sẽ được trả về nếu phép tính bổ sung LOCAL_AQI được chỉ định.
pollutants[]

object (Pollutant)

Danh sách các chất gây ô nhiễm ảnh hưởng đến vị trí được chỉ định trong yêu cầu.

Lưu ý: Trường này sẽ chỉ được trả về cho những yêu cầu đã chỉ định một hoặc nhiều phép tính bổ sung sau: NUMUTANT_ADDITIONAL_INFO, DOMINANT_VOTEUTANT_CONCENTRATION, PACKAGESUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

Thông tin tư vấn về sức khoẻ và hành động được đề xuất liên quan đến tình trạng chất lượng không khí được báo cáo. Các đề xuất được điều chỉnh theo cách khác nhau cho những nhóm dân số có nguy cơ cao, những nhóm nhạy cảm hơn với các chất gây ô nhiễm và dân số nói chung.