Возвращает историю качества воздуха для определенного места за заданный диапазон времени.
HTTP-запрос
POST https://airquality.googleapis.com/v1/history:lookup
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "pageSize": integer, "pageToken": string, "location": { object ( |
Поля | |
---|---|
pageSize | Необязательный. Максимальное количество почасовых информационных записей, возвращаемых на страницу. Значение по умолчанию — 72, максимальное значение — 168 (данные за 7 дней). |
pageToken | Необязательный. Токен страницы, полученный в результате предыдущего вызова истории. Он используется для получения следующей страницы. Обратите внимание, что при указании значения для этого параметра все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы (предыдущий вызов). |
location | Необходимый. Широта и долгота, для которых API ищет данные истории качества воздуха. |
extraComputations[] | Необязательный. Дополнительные функции, которые можно включить по желанию. Указание дополнительных вычислений приведет к тому, что в ответе будут возвращены соответствующие элементы и поля. |
uaqiColorPalette | Необязательный. Определяет цветовую палитру, используемую для данных, предоставляемых «Универсальным индексом качества воздуха» (UAQI). Эта цветовая палитра актуальна только для UAQI, другие AQI имеют заранее заданную цветовую палитру, которой невозможно управлять. |
customLocalAqis[] | Необязательный. Выражает отношение «страна/регион к AQI». Сопоставляет страну/регион с желаемым показателем качества воздуха, чтобы данные о качестве воздуха, необходимые для этой страны/региона, отображались в соответствии с выбранным показателем качества воздуха. Этот параметр можно использовать для указания AQI, отличного от значения по умолчанию, для данной страны, например, чтобы получить индекс Агентства по охране окружающей среды США для Канады, а не индекс по умолчанию для Канады. |
dateTime | Временная метка, для которой возвращаются исторические данные. Временная метка округляется до предыдущего точного часа. Примечание. При этом будут возвращены почасовые данные только для запрошенной временной метки (т. е. один почасовой информационный элемент). Например, отправленный запрос, в котором для параметра 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 | Число от 1 до 720, обозначающее диапазон часов для запроса. Например: значение 48 даст данные за последние 48 часов. |
period | Указывает период Примечание. В запросе можно использовать либо |
universalAqi | Необязательный. Если установлено значение true, универсальный AQI будет включен в поле «индексы» ответа. Значение по умолчанию — правда. |
languageCode | Необязательный. Позволяет клиенту выбрать язык ответа. Если данные для этого языка предоставить невозможно, API использует наиболее близкое совпадение. Допустимые значения соответствуют стандарту IETF. Значение по умолчанию — en. |
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"hoursInfo": [
{
object ( |
Поля | |
---|---|
hoursInfo[] | Необязательный. Содержит информацию о качестве воздуха за каждый час в запрошенном диапазоне. Например, если запрос касается истории за 48 часов, будет 48 элементов почасовой информации. |
regionCode | Необязательный. Код ISO_3166-1 альфа-2 страны/региона, соответствующий местоположению, указанному в запросе. Это поле может быть опущено в ответе, если местоположение, указанное в запросе, находится на спорной территории. |
nextPageToken | Необязательный. Токен для получения следующей страницы. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Дополнительную информацию см. в обзоре OAuth 2.0 .
ЧасИнформация
Содержит информацию о качестве воздуха за каждый час в запрошенном диапазоне. Например, если запрос касается истории за 48 часов, будет 48 элементов почасовой информации.
JSON-представление |
---|
{ "dateTime": string, "indexes": [ { object ( |
Поля | |
---|---|
dateTime | Округленная временная метка, указывающая время, к которому относятся данные, в формате RFC3339 UTC «Zulu», с наносекундным разрешением и до девяти дробных цифр. Например: «2014-10-02T15:00:00Z». |
indexes[] | В зависимости от параметров запроса в этот список будут включены (до) двух показателей качества воздуха:
|
pollutants[] | Перечень загрязняющих веществ, влияющих на указанную в заявке локацию. Примечание. Это поле будет возвращено только для запросов, в которых указано одно или несколько следующих дополнительных вычислений: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
healthRecommendations | Рекомендации по охране здоровья и рекомендуемые действия, связанные с сообщенным состоянием качества воздуха. Рекомендации по-разному адаптированы для групп населения, находящихся в группе риска, групп с большей чувствительностью к загрязнителям и населения в целом. |