Конечная точка 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 выберите значок полноэкранного режима, чтобы развернуть окно обозревателя API.