Сервис history предоставляет почасовые данные о качестве воздуха для конкретного местоположения за заданный период времени, максимум за 30 дней. Вы можете управлять тем, какие индексы качества воздуха (AQI) и соответствующая информация будут возвращаться (например, уровень концентрации загрязняющих веществ и рекомендации по охране здоровья).
Вы можете запросить историю почасовых данных о качестве воздуха, используя конечную точку history , отправив HTTP POST-запрос по адресу:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
Включите параметры запроса в тело JSON-запроса . Тело запроса содержит местоположение и временной диапазон, за который вы хотите получить почасовые данные о качестве воздуха. Оно также может включать различные параметры для управления тем, какая информация о качестве воздуха будет включена в ответ.
Инструмент API Explorer позволяет отправлять запросы в режиме реального времени, чтобы вы могли ознакомиться с API и его параметрами:
Пример запроса на один час.
Текст запроса на один час
Приведённый ниже код показывает, как сформировать тело запроса для запроса истории за один час с использованием метода history . В этом примере вы задаёте местоположение и метку времени за предыдущий период.
curl -X POST -d '{
"dateTime": "2023-06-26T15:01:23Z",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Ответ в течение одного часа
Приведенный выше вызов генерирует следующий JSON-ответ . Более подробную информацию о данных ответа см. в разделе «Данные ответа» .
{ "hoursInfo": [ { "dateTime": "2023-06-26T15:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 73, "aqiDisplay": "73", "color": { "red": 118, "green": 202, "blue": 51, "alpha": 255 }, "category": "Good air quality", "dominantPollutant": "pm10" } ] } ], "regionCode": "us" }
Пример запроса временного диапазона
Запрос временного диапазона
Приведенный ниже код показывает, как сформировать тело запроса для history , которая возвращает несколько записей о почасовых показателях качества воздуха за прошедший период.
Вы можете запросить несколько записей, указав временной диапазон, то есть начальную и конечную метки времени, или указав количество часов, отстоящих от текущего времени.
В приведенном ниже примере, поскольку вы установили размер страницы равным 2 , ваш запрос на получение данных о качестве воздуха за четыре часа будет возвращен на двух страницах, причем каждая страница содержит данные за два часа.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Аналогичный запрос можно отправить, указав временные метки начала и окончания:
curl -X POST -d '{
"period": {
"startTime":"2023-06-15T08:00:00Z",
"endTime":"2023-06-15T12:00:00Z"
},
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Временной диапазон отклика
Приведенные выше вызовы генерируют JSON-ответ в приведенном ниже формате. Для получения более подробной информации о данных ответа см. раздел «Данные ответа» .
Оба запроса выше запрашивают данные о качестве воздуха за четыре часа. Однако, поскольку в запросе свойство pageSize установлено на 2 , ответ содержит результаты только за последние два часа.
{ "hoursInfo": [ { "dateTime": "2023-06-15T11:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 83, "aqiDisplay": "83", "color": { "red": 74, "green": 185, "blue": 54, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] }, { "dateTime": "2023-06-15T10:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 89, "aqiDisplay": "89", "color": { "red": 48, "green": 175, "blue": 55, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] } ], "regionCode": "us", "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA" }
Обратите внимание, что ответ также содержит свойство nextPageToken . Используйте это свойство для доступа к следующей странице результатов, которая содержит данные за следующие два часа.
Чтобы получить доступ к следующей странице результатов, отправьте второй запрос к конечной точке history , но на этот раз установите свойство pageToken равным значению nextPageToken из первого ответа.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Попробуйте!
Инструмент API Explorer позволяет создавать примеры запросов, чтобы вы могли ознакомиться с API и его параметрами.
Выберите значок API в правой части страницы.
При желании можно отредактировать параметры запроса.
Нажмите кнопку «Выполнить» . В диалоговом окне выберите учетную запись, которую вы хотите использовать для выполнения запроса.
На панели «Обозреватель API» выберите значок полноэкранного режима, чтобы развернуть окно «Обозреватель API».