Method: currentConditions.lookup

Current Conditions 端点提供 100 多个国家/地区的每小时空气质量信息,分辨率最高可达 500 x 500 米。包括 70 多个当地指数和全球空气质量指数和类别。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "universalAqi": boolean,
  "languageCode": string
}
字段
location

object (LatLng)

必需。API 用来查找当前空气质量数据的经度和纬度。

extraComputations[]

enum (ExtraComputation)

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

uaqiColorPalette

enum (ColorPalette)

可选。确定“通用空气质量指数”(UAQI) 所提供数据所使用的调色板。此调色板只与 UAQI 相关,其他 AQI 有无法控制的预设调色板。

customLocalAqis[]

object (CustomLocalAqi)

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

universalAqi

boolean

可选。如果设置为 true,Universal AQI 将包含在响应的“indexes”字段中。默认值为 true。

languageCode

string

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

响应正文

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

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

string (Timestamp format)

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的下舍入时间戳,分辨率为纳秒,最多包含九个小数位。例如:“2014-10-02T15:00:00Z”。

regionCode

string

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

indexes[]

object (AirQualityIndex)

根据请求参数,此列表将包括(最多)两个空气质量指数:

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

object (Pollutant)

影响请求中指定位置的污染物列表。注意:只有指定了以下一项或多项额外计算的请求才会返回此字段:POLLUTANT_ADDITIONAL_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。

healthRecommendations

object (HealthRecommendations)

与报告的空气质量状况相关的健康建议和推荐措施。针对风险人群、对污染物更敏感的群体以及总体人群量身定制的建议有所不同。

授权范围

需要以下 OAuth 作用域:

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

有关详情,请参阅 OAuth 2.0 概览