Method: currentConditions.lookup

Конечная точка «Текущие условия» предоставляет ежечасную информацию о качестве воздуха в более чем 100 странах с разрешением до 500 x 500 метров. Включает более 70 местных индексов, а также глобальные индексы и категории качества воздуха.

HTTP-запрос

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

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

universalAqi

boolean

Необязательный. Если установлено значение true, универсальный AQI будет включен в поле «индексы» ответа. Значение по умолчанию — правда.

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

indexes[]

object ( AirQualityIndex )

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

  • Универсальный АКИ. Будет возвращено, если для логического значения UniversalAqi установлено значение true.
  • Местный AQI. Будет возвращено, если указано дополнительное вычисление 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 .