Package google.maps.airquality.v1

Индекс

Качество воздуха

Службы качества воздуха.

Поиск текущих условий

rpc LookupCurrentConditions( LookupCurrentConditionsRequest ) returns ( LookupCurrentConditionsResponse )

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

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

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

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

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

ПоискПрогноз

rpc LookupForecast( LookupForecastRequest ) returns ( LookupForecastResponse )

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

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

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

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

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

ПоискТеплокартаПлитка

rpc LookupHeatmapTile( LookupHeatmapTileRequest ) returns ( HttpBody )

Возвращает массив байтов, содержащий данные мозаичного изображения PNG.

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

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

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

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

История поиска

rpc LookupHistory( LookupHistoryRequest ) returns ( LookupHistoryResponse )

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

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

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

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

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

Индекс качества воздуха

Базовый объект для представления различных показателей качества воздуха. В совокупности эти показатели дают представление о текущем состоянии качества воздуха. В мире существует множество индексов, служащих различным целям и группам, заинтересованным в измерении различных аспектов качества воздуха.

Поля
code

string

Код индекса. Это поле представляет индекс для целей программирования, используя змеиный регистр вместо пробелов. Примеры: «uaqi», «fra_atmo».

display_name

string

Удобочитаемое представление имени индекса. Пример: «АКИ (США)».

aqi_display

string

Текстовое представление числового балла индекса, которое может включать символы префикса или суффикса, что обычно представляет собой худший балл индекса. Пример: >100 или 10+.

Примечание. Это поле следует использовать, если вы хотите отобразить индексный балл. Для нечисловых индексов это поле пусто.

color

Color

Цвет, используемый для представления числового показателя AQI.

category

string

Текстовая классификация интерпретации числовых показателей индекса. Например: «Отличное качество воздуха».

dominant_pollutant

string

Химический символ доминирующего загрязнителя. Например: «КО».

aqi

int32

Числовой балл индекса. Примеры: 10, 100.

Значение не нормализовано и должно интерпретироваться только в контексте соответствующего индекса качества воздуха. Для нечисловых индексов это поле не будет возвращено.

Примечание. Это поле следует использовать для расчетов, отображения графиков и т. д. Для отображения оценки индекса следует использовать поле отображения AQI.

Цветовая палитра

Определяет цветовую палитру, используемую для данных, предоставляемых «Универсальным индексом качества воздуха» (UAQI). Эта цветовая палитра актуальна только для UAQI, другие AQI имеют заранее заданную цветовую палитру, которой невозможно управлять.

Перечисления
COLOR_PALETTE_UNSPECIFIED Значение по умолчанию. Игнорируется, если передается как параметр.
RED_GREEN Определяет, использовать ли красную/зеленую палитру.
INDIGO_PERSIAN_DARK Определяет, использовать ли палитру индиго/персидского цвета (темная тема).
INDIGO_PERSIAN_LIGHT Определяет, использовать ли палитру индиго/персидского цвета (светлая тема).

CustomLocalAqi

Выражает отношение «страна/регион к AQI». Сопоставляет страну/регион с желаемым показателем качества воздуха, чтобы данные о качестве воздуха, необходимые для этой страны/региона, отображались в соответствии с выбранным показателем качества воздуха.

Поля
region_code

string

Страна/регион, требующий специального AQI. Значение должно быть указано с использованием кода ISO 3166-1 альфа-2 .

aqi

string

AQI, с которым нужно связать страну/регион. Значение должно быть допустимым индексным кодом.

Дополнительные вычисления

Дополнительные функции, которые можно включить по желанию. Указание дополнительных вычислений приведет к тому, что в ответе будут возвращены соответствующие элементы и поля.

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Значение по умолчанию. Сервер игнорирует его, если он передается в качестве параметра.
LOCAL_AQI

Определяет, включать ли в ответ местный (национальный) AQI запрошенного местоположения (страны).

Если указано, ответ будет содержать структуру данных air_quality_index со всеми соответствующими данными о локальном AQI местоположения.

HEALTH_RECOMMENDATIONS

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

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

Если указано, поле health_recommendations будет заполнено в ответе, когда будут доступны соответствующие данные.

POLLUTANT_ADDITIONAL_INFO

Определяет, включать ли в ответ дополнительную информацию о каждом загрязнителе.

Если указано, каждый объект индекса качества воздуха, содержащийся в ответе поля indexes, будет включать поле additional_info , когда данные будут доступны.

DOMINANT_POLLUTANT_CONCENTRATION

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

Если в запросе указаны как глобальный, так и локальный AQI, может быть возвращено до двух кодов загрязнителей.

Если указано, доминирующий объект-загрязнитель, содержащийся в списке «загрязнителей», будет включать поле concentration , когда данные будут доступны.

POLLUTANT_CONCENTRATION

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

Если указано, каждый объект-загрязнитель, содержащийся в поле «Загрязнители» в ответе, будет включать поле concentration , когда данные будут доступны.

ЗдоровьеРекомендации

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

Поля
general_population

string

Никакой специфической чувствительности.

elderly

string

Пенсионеры и люди старше основного населения.

lung_disease_population

string

Страдает респираторными проблемами и астмой.

heart_disease_population

string

Заболевания сердца и системы кровообращения.

athletes

string

Спорт и другие интенсивные занятия на свежем воздухе.

pregnant_women

string

Женщины на всех сроках беременности.

children

string

Младшие группы населения, включая детей, малышей и младенцев.

LookupCurrentConditionsRequest

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

Поля
location

LatLng

Необходимый. Долгота и широта, на которых API ищет данные о текущих условиях качества воздуха.

extra_computations[]

ExtraComputation

Необязательный. Дополнительные функции, которые можно включить по желанию. Указание дополнительных вычислений приведет к тому, что в ответе будут возвращены соответствующие элементы и поля.

uaqi_color_palette

ColorPalette

Необязательный. Определяет цветовую палитру, используемую для данных, предоставляемых «Универсальным индексом качества воздуха» (UAQI). Эта цветовая палитра актуальна только для UAQI, другие AQI имеют заранее заданную цветовую палитру, которой невозможно управлять.

custom_local_aqis[]

CustomLocalAqi

Необязательный. Выражает отношение «страна/регион к AQI». Сопоставляет страну/регион с желаемым показателем качества воздуха, чтобы данные о качестве воздуха, необходимые для этой страны/региона, отображались в соответствии с выбранным показателем качества воздуха. Этот параметр можно использовать для указания AQI, отличного от значения по умолчанию, для данной страны, например, чтобы получить индекс Агентства по охране окружающей среды США для Канады, а не индекс по умолчанию для Канады.

universal_aqi

bool

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

language_code

string

Необязательный. Позволяет клиенту выбрать язык ответа. Если данные для этого языка предоставить невозможно, API использует наиболее близкое совпадение. Допустимые значения основаны на стандарте IETF. Значение по умолчанию — en.

LookupCurrentConditionsResponse

Поля
date_time

Timestamp

Округленная в меньшую сторону временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Например: «2014-10-02T15:00:00Z».

region_code

string

Код ISO_3166-1 альфа-2 страны/региона, соответствующий местоположению, указанному в запросе. Это поле может быть опущено в ответе, если местоположение, указанное в запросе, находится на спорной территории.

indexes[]

AirQualityIndex

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

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

Pollutant

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

health_recommendations

HealthRecommendations

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

ПоискПрогнозЗапрос

Объект запроса API прогноза качества воздуха.

Поля
location

LatLng

Необходимый. Широта и долгота, для которых API ищет данные о качестве воздуха.

extra_computations[]

ExtraComputation

Необязательный. Дополнительные функции, которые можно включить по желанию. Указание дополнительных вычислений приведет к тому, что в ответе будут возвращены соответствующие элементы и поля.

uaqi_color_palette

ColorPalette

Необязательный. Определяет цветовую палитру, используемую для данных, предоставляемых «Универсальным индексом качества воздуха» (UAQI). Эта цветовая палитра актуальна только для UAQI, другие AQI имеют заранее заданную цветовую палитру, которой невозможно управлять.

custom_local_aqis[]

CustomLocalAqi

Необязательный. Выражает отношение «страна/регион к AQI». Сопоставляет страну/регион с желаемым показателем качества воздуха, чтобы данные о качестве воздуха, необходимые для этой страны/региона, отображались в соответствии с выбранным показателем качества воздуха. Этот параметр можно использовать для указания AQI, отличного от значения по умолчанию, для данной страны, например, чтобы получить индекс Агентства по охране окружающей среды США для Канады, а не индекс по умолчанию для Канады.

page_size

int32

Необязательный. Максимальное количество почасовых информационных записей, возвращаемых на страницу (по умолчанию = 24).

page_token

string

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

Поле объединения time_range . Временной диапазон необходимых данных прогноза качества воздуха. Диапазон должен быть как минимум на один округленный час вперед. Если не указать это поле, возникнет ошибка INVALID_ARGUMENT. time_range может быть только одним из следующих:
date_time

Timestamp

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

Примечание. При этом будут возвращены почасовые данные только для запрошенной метки времени (т. е. один почасовой информационный элемент). Например, отправленный запрос, в котором для параметра date_time установлено значение 2023-01-03T11:05:49Z, будет округлен до 2023-01-03T11:00:00Z.

period

Interval

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

universal_aqi

bool

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

language_code

string

Необязательный. Позволяет клиенту выбрать язык ответа. Если данные для этого языка предоставить невозможно, API использует наиболее близкое совпадение. Разрешенные значения соответствуют стандарту IETF (по умолчанию = «en»).

LookupForecastResponse

Объект ответа API прогноза качества воздуха.

Поля
hourly_forecasts[]

HourlyForecast

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

region_code

string

Необязательный. Код ISO_3166-1 альфа-2 страны/региона, соответствующий местоположению, указанному в запросе. Это поле может быть опущено в ответе, если местоположение, указанное в запросе, находится на спорной территории.

next_page_token

string

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

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

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

Поля
date_time

Timestamp

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

indexes[]

AirQualityIndex

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

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

Pollutant

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

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

health_recommendations

HealthRecommendations

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

ПоискТеплокартаТилеЗапрос

Запрос плитки тепловой карты.

Структура соответствует стандартному вызову GET сервера тайлов, например https://airquality.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}.

Пример: https://airquality.googleapis.com/v1/mapTypes/BAQI_INDIGO_PERSIAN/heatmapTiles/1/1/1

Поля
map_type

MapType

Необходимый. Тип тепловой карты качества воздуха. Определяет загрязнитель, графически представленный на карте.

Allowed values:
- UAQI_RED_GREEN (UAQI, red-green palette)
- UAQI_INDIGO_PERSIAN (UAQI, indigo-persian palette)
- PM25_INDIGO_PERSIAN
- GBR_DEFRA
- DEU_UBA
- CAN_EC
- FRA_ATMO
- US_AQI
zoom

int32

Необходимый. Уровень масштабирования карты. Определяет, насколько большим или маленьким будет содержимое карты в представлении карты.

Уровень масштабирования 0 — это весь мир на одной плитке. Уровень масштабирования 1 — это весь мир, состоящий из 4 плиток. Уровень масштабирования 2 — это весь мир, состоящий из 16 плиток. Уровень масштабирования 16 — это весь мир, состоящий из 65 536 плиток.

Допустимые значения: 0–16.

x

int32

Необходимый. Определяет точку восток-запад в запрошенном фрагменте.

y

int32

Необходимый. Определяет точку север-юг в запрошенном фрагменте.

Поиск историиЗапрос

Объект запроса API истории качества воздуха.

Поля
page_size

int32

Необязательный. Максимальное количество почасовых информационных записей, возвращаемых на страницу. Значение по умолчанию — 72, максимальное значение — 168 (данные за 7 дней).

page_token

string

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

Обратите внимание, что при указании значения для этого параметра все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы (предыдущий вызов).

location

LatLng

Необходимый. Широта и долгота, для которых API ищет данные истории качества воздуха.

extra_computations[]

ExtraComputation

Необязательный. Дополнительные функции, которые можно включить по желанию. Указание дополнительных вычислений приведет к тому, что в ответе будут возвращены соответствующие элементы и поля.

uaqi_color_palette

ColorPalette

Необязательный. Определяет цветовую палитру, используемую для данных, предоставляемых «Универсальным индексом качества воздуха» (UAQI). Эта цветовая палитра актуальна только для UAQI, другие AQI имеют заранее заданную цветовую палитру, которой невозможно управлять.

custom_local_aqis[]

CustomLocalAqi

Необязательный. Выражает отношение «страна/регион к AQI». Сопоставляет страну/регион с желаемым показателем качества воздуха, чтобы данные о качестве воздуха, необходимые для этой страны/региона, отображались в соответствии с выбранным показателем качества воздуха. Этот параметр можно использовать для указания AQI, отличного от значения по умолчанию, для данной страны, например, чтобы получить индекс Агентства по охране окружающей среды США для Канады, а не индекс по умолчанию для Канады.

Поле объединения time_range . Временной диапазон необходимых данных о качестве воздуха. Если не указать какое-либо поле, связанное с диапазоном времени, это приведет к ошибке INVALID_ARGUMENT. time_range может быть только одним из следующих: time_range может быть только одним из следующих:
date_time

Timestamp

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

Примечание. При этом будут возвращены почасовые данные только для запрошенной временной метки (т. е. один почасовой информационный элемент). Например, отправленный запрос, в котором для параметра dateTime установлено значение 2023-01-03T11:05:49Z, будет округлен до 2023-01-03T11:00:00Z.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: «2014-10-02T15:01:23Z» и «2014-10-02T15:01:23.045123456Z».

hours

int32

Число от 1 до 720, обозначающее диапазон часов для запроса. Например: значение 48 даст данные за последние 48 часов.

period

Interval

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

universal_aqi

bool

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

language_code

string

Необязательный. Позволяет клиенту выбрать язык ответа. Если данные для этого языка предоставить невозможно, API использует наиболее близкое совпадение. Допустимые значения основаны на стандарте IETF. Значение по умолчанию — en.

ПоискИсторииОтвета

Поля
hours_info[]

HourInfo

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

region_code

string

Необязательный. Код ISO_3166-1 альфа-2 страны/региона, соответствующий местоположению, указанному в запросе. Это поле может быть опущено в ответе, если местоположение, указанное в запросе, находится на спорной территории.

next_page_token

string

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

ЧасИнформация

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

Поля
date_time

Timestamp

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

indexes[]

AirQualityIndex

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

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

Pollutant

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

health_recommendations

HealthRecommendations

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

Тип карты

Тип тепловой карты качества воздуха. Определяет загрязнитель, графически представленный на карте.

Перечисления
MAP_TYPE_UNSPECIFIED Значение по умолчанию. Сервер игнорирует его, если он передается в качестве параметра.
UAQI_RED_GREEN Красно-зеленая палитра универсального индекса качества воздуха.
UAQI_INDIGO_PERSIAN Индиго-персидская палитра универсального индекса качества воздуха.
PM25_INDIGO_PERSIAN Индекс PM2.5 индиго-персидская палитра.
GBR_DEFRA Цветовая палитра ежедневного индекса качества воздуха (Великобритания).
DEU_UBA Цветовая палитра немецкого местного индекса качества воздуха.
CAN_EC Цветовая палитра канадского индекса качества воздуха и здоровья.
FRA_ATMO Цветовая палитра индекса качества воздуха во Франции.
US_AQI Цветовая палитра Индекса качества воздуха США.

Загрязнитель

Данные о загрязнителе качества воздуха.

Поля
code

string

Кодовое название загрязнителя (например, «so2»). Список поддерживаемых кодов загрязнителей см. в разделе Сообщенные загрязнители .

display_name

string

Отображаемое название загрязнителя. Например: «НОкс».

full_name

string

Полное название загрязнителя. Для химических соединений это название IUPAC. Пример: «Диоксид серы».

Дополнительную информацию о таблице имен IUPAC см. на странице https://iupac.org/what-we-do/ periodic-table-of-elements/.

concentration

Concentration

Уровень концентрации загрязняющего вещества, измеренный одной из стандартных единиц измерения загрязнения воздуха.

additional_info

AdditionalInfo

Дополнительная информация о загрязнителе.

Дополнительная информация

Источники выбросов и воздействие на здоровье конкретного загрязнителя.

Поля
sources

string

Текст, представляющий основные источники выбросов загрязняющих веществ.

effects

string

Текст, представляющий основные последствия загрязнения для здоровья.

Концентрация

Концентрация данного загрязнителя в воздухе.

Поля
units

Unit

Единицы измерения концентрации этого загрязняющего вещества.

value

float

Значение концентрации загрязняющих веществ.

Единица

Определяет единицу измерения концентрации загрязняющего вещества. Чтобы определить единицу концентрации по умолчанию для данного загрязняющего вещества, обратитесь к таблице в разделе «Сообщенные загрязнители» .

Перечисления
UNIT_UNSPECIFIED Неуказанная единица концентрации.
PARTS_PER_BILLION Единица концентрации ppb (частей на миллиард).
MICROGRAMS_PER_CUBIC_METER Единица концентрации «мкг/м^3» (микрограммы на кубический метр).