返回指定时间范围内特定位置的空气质量预报。
HTTP 请求
POST https://airquality.googleapis.com/v1/forecast:lookup
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "location": { object ( |
字段 | |
---|---|
location |
必需。API 用于查找空气质量数据的纬度和经度。 |
extraComputations[] |
可选。可以选择启用的其他功能。指定额外的计算值会导致响应中返回相关元素和字段。 |
uaqiColorPalette |
可选。确定用于“通用空气质量指数”(UAQI) 所提供数据的调色板。此调色板只与 UAQI 相关,其他 AQI 有无法控制的预设调色板。 |
customLocalAqis[] |
可选。表示“国家/地区与 AQI”的关系。将某个国家/地区与所需的 AQI 配对,以便根据所选的 AQI 显示该国家/地区所需的空气质量数据。此参数可用于指定指定国家/地区的非默认 AQI,例如,获取加拿大的美国 EPA 指数,而不是加拿大的默认指数。 |
pageSize |
可选。每页返回的每小时信息记录数量上限(默认值 = 24)。 |
pageToken |
可选。从上一次预测调用收到的页面令牌。它用于检索后续页面。 |
dateTime |
要返回特定时间点的数据的时间戳。时间戳会四舍五入到上一个精确小时。 这将仅返回所请求时间戳的每小时数据(即单个每小时信息元素)。例如,对于已发送的 dateTime 参数设置为 2023-01-03T11:05:49Z 的请求,系统会将其向下舍入为 2023-01-03T11:00:00Z。 注意:可以在请求中使用 |
period |
表示要获取其预测数据的 注意:可以在请求中使用 |
universalAqi |
可选。如果设置为 true,则 Universal AQI 将包含在响应的“indexes”字段中(默认值为 true)。 |
languageCode |
可选。允许客户端选择响应的语言。如果无法提供该语言的数据,API 会使用最接近的匹配项。允许的值取决于 IETF 标准(默认值为“en”)。 |
响应正文
空气质量预报 API 的响应对象。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"hourlyForecasts": [
{
object ( |
字段 | |
---|---|
hourlyForecasts[] |
可选。包含所请求范围内每小时的空气质量信息。例如,如果请求的是 48 小时的预测,则将有 48 个每小时预测元素。 |
regionCode |
可选。与请求中提供的位置对应的国家/地区的 ISO_3166-1 alpha-2 代码。如果请求中提供的位置位于有争议的地区,响应中可能会省略此字段。 |
nextPageToken |
可选。要检索下一页的令牌。 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/cloud-platform
有关详情,请参阅 OAuth 2.0 概览。
HourlyForecast
包含所请求范围内每小时的空气质量信息。例如,如果请求的是 48 小时的预测,则将有 48 个每小时预测元素。
JSON 表示法 |
---|
{ "dateTime": string, "indexes": [ { object ( |
字段 | |
---|---|
dateTime |
这是一个向下舍入的时间戳,表示数据对应的时间(小时),采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式。例如:“2014-10-02T15:00:00Z”。 |
indexes[] |
根据请求参数,此列表将最多包含两个空气质量指数:
|
pollutants[] |
影响请求中指定位置的污染物列表。 注意:只有指定了以下一个或多个额外计算的请求才会返回此字段:POLLUTANT_ADDITIONAL_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。 |
healthRecommendations |
与所报告的空气质量状况相关的健康建议和建议措施。针对风险人群、对污染物敏感人群以及一般人群提供的建议有所不同。 |