История

Конечная точка history предоставляет почасовые данные о качестве воздуха в определенном месте за указанный диапазон дат (не более 30 дней). Вы можете управлять тем, какие ИКВ и сопутствующая информация (например, уровень концентрации загрязняющих веществ и рекомендации по охране здоровья) возвращаются.

Вы можете запросить историю почасового качества воздуха, используя конечную точку 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 и его возможностями.

  1. Нажмите на значок API api в правой части страницы.

  2. При необходимости измените параметры запроса.

  3. Нажмите кнопку Execute (Выполнить). В диалоговом окне выберите аккаунт, который хотите использовать для отправки запроса.

  4. На панели API Explorer нажмите на значок полноэкранного режима fullscreen, чтобы развернуть окно API Explorer.