Method: forecast.lookup

Trả về thông tin dự báo chất lượng không khí ở 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. Các tính năng bổ sung có thể bật 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 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 do "Chỉ số chất lượng không khí toàn cầu" (UAQI) cung cấp. Bảng màu này chỉ phù hợp với UAQI, các chỉ số chất lượng không khí (AQI) khác có bảng màu định sẵn không thể kiểm soát.
customLocalAqis[]

object (CustomLocalAqi)

Không bắt buộc. Thể hiện mối quan hệ "quốc gia/khu vực với AQI". Ghép nối một quốc gia/khu vực có chỉ số chất lượng không khí (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 chỉ số chất lượng không khí (AQI) đã chọn. Bạn có thể sử dụng tham số này để chỉ định AQI không mặc định cho một quốc gia nhất định, ví dụ: để 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ần trả lại trên mỗi trang (mặc định là 24).
pageToken

string

Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi dự đoán trước đó. URL 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 thành giờ chính xác trước đó.

Thao tác 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 thành phần thông tin hằng giờ). Ví dụ: Một 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ể sử dụng dateTime hoặc startTime và endTime trong một 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 diện. Dấu thời gian được làm tròn thành giờ chính xác trước đó.

Lưu ý: Bạn có thể sử dụng dateTime hoặc startTime và endTime trong một 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ì Universal AQI sẽ được đưa vào trường "chỉ mục" của 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 phản hồi. Nếu không thể cung cấp dữ liệu cho ngôn ngữ đó, API sẽ sử dụng kết quả khớp nhất. Các giá trị được phép phụ thuộc vào tiêu chuẩn IETF (mặc định là "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í từng giờ trong phạm vi yêu cầu. Ví dụ: nếu yêu cầu là dành cho dự báo trong 48 giờ, thì sẽ có 48 phần tử là thông tin 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í nêu 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 trong lãnh thổ bị 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 Tổng quan về OAuth 2.0.

HourlyForecast

Chứa thông tin về chất lượng không khí từng giờ trong phạm vi yêu cầu. Ví dụ: nếu yêu cầu là dành cho dự báo trong 48 giờ, thì sẽ có 48 phần tử là thông tin 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 làm tròn xuống cho biết thời gian (giờ) mà dữ liệu đề cập ở định dạng "Zulu" theo chuẩn RFC3339 UTC. Ví dụ: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

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

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

object (Pollutant)

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

Lưu ý: Trường này sẽ chỉ được trả về cho các yêu cầu đã chỉ định một hoặc nhiều phép tính bổ sung sau đây: ): vừa
healthRecommendations

object (HealthRecommendations)

Nội dung tư vấn về sức khoẻ và các 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. Nội dung đề xuất được điều chỉnh theo những cách khác nhau cho những nhóm dân số có nguy cơ, những nhóm nhạy cảm hơn với các chất gây ô nhiễm, và nhóm dân số chung.