Method: forecast.lookup

Возвращает прогноз качества воздуха для определенного места за заданный диапазон времени.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования 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, отличного от значения по умолчанию, для данной страны, например, чтобы получить индекс Агентства по охране окружающей среды США для Канады, а не индекс по умолчанию для Канады.

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 альфа-2 страны/региона, соответствующий местоположению, указанному в запросе. Это поле может быть опущено в ответе, если местоположение, указанное в запросе, находится на спорной территории.

nextPageToken

string

Необязательный. Токен для получения следующей страницы.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Почасовой прогноз

Содержит информацию о качестве воздуха за каждый час в запрошенном диапазоне. Например, если запрос на прогноз на 48 часов, то будет 48 элементов почасовых прогнозов.

JSON-представление 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Поля
dateTime

string ( Timestamp format)

Округленная временная метка, указывающая время (час), к которому относятся данные, в формате RFC3339 UTC «Zulu». Например: «2014-10-02T15:00:00Z».

indexes[]

object ( AirQualityIndex )

В зависимости от параметров запроса в этот список будут включены (до) двух показателей качества воздуха:

  • Универсальный АКИ. Будет возвращено, если для логического значения universalAqi установлено значение true.
  • Местный AQI. Будет возвращено, если указано дополнительное вычисление LOCAL_AQI.
pollutants[]

object ( Pollutant )

Перечень загрязняющих веществ, влияющих на указанную в заявке локацию.

Примечание. Это поле будет возвращено только для запросов, в которых указано одно или несколько следующих дополнительных вычислений: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.

healthRecommendations

object ( HealthRecommendations )

Рекомендации по охране здоровья и рекомендуемые действия, связанные с сообщенным состоянием качества воздуха. Рекомендации по-разному адаптированы для групп населения, находящихся в группе риска, групп с большей чувствительностью к загрязнителям и населения в целом.