AirQualityResultData

Air quality payload for the requested location.

JSON representation
{
  "hourlyResults": [
    {
      object (AirQualityHourlyResult)
    }
  ],
  "attribution": {
    object (Attribution)
  }
}
Fields
hourlyResults[]

object (AirQualityHourlyResult)

Hourly air quality data for the requested time (contains 1 entry for Current Conditions or single-hour queries, up to 24 entries for a past or future date-only query, or current + remaining hours when date is today).

attribution

object (Attribution)

Required attribution to show with the air quality data.

AirQualityHourlyResult

Hourly air quality information.

JSON representation
{
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  },
  "dateTime": {
    object (DateTime)
  }
}
Fields
indexes[]

object (AirQualityIndex)

Air quality indexes (e.g. Universal AQI and local AQI).

pollutants[]

object (Pollutant)

Detailed pollutant information, populated when airQualityOptions.include_pollutant_concentration is true.

healthRecommendations

object (HealthRecommendations)

Health recommendations for different population groups.

dateTime

object (DateTime)

The local date and time in the location's timezone for this hourly air quality entry (consists of year, month, day, hours, minutes, seconds, and utcOffset).

AirQualityIndex

Represents an Air Quality Index (AQI) measurement.

JSON representation
{
  "displayName": string,
  "valueDisplay": string,
  "category": string,
  "dominantPollutant": string,
  "value": integer
}
Fields
displayName

string

The index's display name (e.g. "Universal AQI", "US EPA AQI").

valueDisplay

string

Formatted string representation of the AQI value.

category

string

Textual air quality category (e.g. "Good air quality", "Moderate air quality").

dominantPollutant

string

The code of the dominant pollutant (e.g. "pm25", "o3").

value

integer

Numeric AQI value.

Pollutant

Represents a specific air pollutant and its concentration.

JSON representation
{
  "displayName": string,
  "fullName": string,
  "concentration": {
    object (Concentration)
  },
  "additionalInfo": {
    object (AdditionalInfo)
  }
}
Fields
displayName

string

Short display name of the pollutant (e.g. "PM2.5", "O3").

fullName

string

Full chemical or common name of the pollutant (e.g. "Fine particulate matter (<2.5µm)", "Ozone").

concentration

object (Concentration)

Measured concentration of the pollutant.

additionalInfo

object (AdditionalInfo)

Additional information about the pollutant's sources and health effects.

Concentration

Concentration measurement of a pollutant.

JSON representation
{
  "unit": enum (Unit),
  "value": number
}
Fields
unit

enum (Unit)

Measurement unit of the concentration.

value

number

Numeric concentration value.

AdditionalInfo

Sources and health effects of a pollutant.

JSON representation
{
  "sources": string,
  "effects": string
}
Fields
sources

string

Main emission sources of the pollutant.

effects

string

Potential health effects of exposure to the pollutant.

HealthRecommendations

Health recommendations tailored to specific population groups.

JSON representation
{
  "generalPopulation": string,
  "elderly": string,
  "lungDiseasePopulation": string,
  "heartDiseasePopulation": string,
  "athletes": string,
  "pregnantWomen": string,
  "children": string
}
Fields
generalPopulation

string

Guidance for the general population.

elderly

string

Guidance for the elderly population.

lungDiseasePopulation

string

Guidance for individuals with lung disease or respiratory conditions.

heartDiseasePopulation

string

Guidance for individuals with cardiovascular or heart disease.

athletes

string

Guidance for athletes and active outdoor individuals.

pregnantWomen

string

Guidance for pregnant women.

children

string

Guidance for children.

DateTime

Represents civil time (or occasionally physical time).

This type can represent a civil time in one of a few possible ways:

  • When utcOffset is set and timeZone is unset: a civil time on a calendar day with a particular offset from UTC.
  • When timeZone is set and utcOffset is unset: a civil time on a calendar day in a particular time zone.
  • When neither timeZone nor utcOffset is set: a civil time on a calendar day in local time.

The date is relative to the Proleptic Gregorian Calendar.

If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively.

This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field.

This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

JSON representation
{
  "year": integer,
  "month": integer,
  "day": integer,
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "utcOffset": string,
  "timeZone": {
    object (TimeZone)
  }
  // End of mutually exclusive fields.
}
Fields
year

integer

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

month

integer

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

day

integer

Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.

hours

integer

Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

seconds

integer

Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.

nanos

integer

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

Optional. Specifies either the UTC offset or the time zone of the DateTime. Choose carefully between them, considering that time zone data may change in the future (for example, a country modifies their DST start/end dates, and future DateTimes in the affected range had already been stored). If omitted, the DateTime is considered to be in local time. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
utcOffset

string (Duration format)

UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

timeZone

object (TimeZone)

Time zone.

End of mutually exclusive fields.

TimeZone

Represents a time zone from the IANA Time Zone Database.

JSON representation
{
  "id": string,
  "version": string
}
Fields
id

string

IANA Time Zone Database time zone. For example "America/New_York".

version

string

Optional. IANA Time Zone Database version number. For example "2019a".