Method: forecast.lookup

返回指定时间范围内特定位置的空气质量预报。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

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
}
字段
location

object (LatLng)

必需。API 为之查找空气质量数据的纬度和经度。
extraComputations[]

enum (ExtraComputation)

可选。可选择启用的其他功能。指定额外的计算会在响应中返回相关元素和字段。
uaqiColorPalette

enum (ColorPalette)

可选。确定用于“通用空气质量指数”提供的数据的调色板(UAQI)。此调色板仅适用于 UAQI，其他 AQI 具有无法控制的预设调色板。
customLocalAqis[]

object (CustomLocalAqi)

可选。表示“与 AQI 相关的国家/地区”关系。将某个国家/地区与所需的 AQI 配对，以便系统根据所选的 AQI 显示该国家/地区所需的空气质量数据。此参数可用于指定给定国家/地区的非默认 AQI，例如，用于获取加拿大的美国 EPA 指数，而不是加拿大的默认指数。
pageSize

integer

可选。每页每小时返回的最大信息记录数（默认值为 24）。
pageToken

string

可选。从上一次预测调用收到的页面令牌。它用于检索后续页面。
dateTime

string (Timestamp format)

要返回特定时间点的数据的时间戳。时间戳会四舍五入到上一个精确的小时。

这将仅返回所请求时间戳的每小时数据（即单个每小时信息元素）。例如，如果发送的 dateTime 参数设置为 2023-01-03T11:05:49Z，则发送的请求将向下舍入为 2023-01-03T11:00:00Z。

注意：请求中可以使用 dateTime 或 startTime 和 endTime。
period

object (Interval)

指明要获取预测数据的 startTime 和 endTime 时间段。endTime 包括在内。时间戳会四舍五入到上一个精确的小时。

注意：请求中可以使用 dateTime 或 startTime 和 endTime。
universalAqi

boolean

可选。如果设置为 true，则通用 AQI 将包含在“指数”中字段（默认值为 true）。
languageCode

string

可选。允许客户端选择响应的语言。如果无法为该语言提供数据，API 会使用最接近的匹配项。允许的值取决于 IETF 标准（默认值为“en”）。

响应正文

空气质量预报 API 的响应对象。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
字段
hourlyForecasts[]

object (HourlyForecast)

可选。包含所请求范围内每小时的空气质量信息。例如，如果请求针对 48 小时的预测，则每小时预测将有 48 个元素。
regionCode

string

可选。与请求中提供的位置相对应的国家/地区的 ISO_3166-1 alpha-2 代码。如果要求中提供的地点位于有争议的地区，响应中可能会省略此字段。
nextPageToken

string

可选。用于检索下一页的令牌。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 OAuth 2.0 概览。

HourlyForecast

包含所请求范围内每小时的空气质量信息。例如，如果请求针对 48 小时的预测，则每小时预测将有 48 个元素。

JSON 表示法 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
字段
dateTime

string (Timestamp format)

向下舍入的时间戳，表示数据对应的时间（小时），采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式。例如：“2014-10-02T15:00:00Z”。
indexes[]

object (AirQualityIndex)

根据请求参数，此列表将包含（最多）两个空气质量指数：

  • 通用空气质量指数。如果 universalAqi 布尔值设置为 true，则返回此值。
  • 本地空气质量指数。如果指定了 LOCAL_AQI 额外计算，将返回。
pollutants[]

object (Pollutant)

影响请求中所指定位置的污染物列表。

注意：只有指定了以下一项或多项额外计算的请求才会返回此字段：POLLUTANT_ADDITIONAL_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。
healthRecommendations

object (HealthRecommendations)

与所报告的空气质量状况有关的健康建议和建议措施。建议是针对风险人群、对污染物敏感度较高的群体以及一般人群量身提供的。