Punkt końcowy history
udostępnia historyczne informacje o jakości powietrza w godzinnych odstępach w danej lokalizacji w danym przedziale czasowym (maksymalnie 30 dni). Możesz określić, które wskaźniki AQI i informacje są zwracane (np. poziom stężenia zanieczyszczeń i zalecenia zdrowotne).
Możesz poprosić o historię jakości powietrza w godzinnych odstępach, korzystając z punktu końcowego history
. Aby to zrobić, wyślij żądanie HTTP POST do adresu:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
Opcje żądania należy podać w treści żądania w formacie JSON. Treść żądania zawiera lokalizację i zakres czasowy, w którym chcesz uzyskać godzinową historię jakości powietrza. Może ona też zawierać różne opcje umożliwiające kontrolowanie informacji o jakości powietrza, które mają się znaleźć w odpowiedzi.
Narzędzie APIs Explorer umożliwia wysyłanie żądań na żywo, dzięki czemu możesz zapoznać się z interfejsem API i jego opcjami:
Przykład żądania obejmującego 1 godzinę
Treść żądania dotyczącego pojedynczej godziny
Poniższy kod pokazuje, jak utworzyć treść żądania dotyczącego historii za dany dzień za pomocą metody history
.
W tym przykładzie ustawiasz lokalizację i sygnaturę czasową z przeszłości.
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'
Odpowiedź w ciągu 1 godziny
Powyższe wywołanie generuje tę odpowiedź JSON. Więcej informacji o danych odpowiedzi znajdziesz w artykule Dane odpowiedzi.
{ "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" }
Przykład prośby o zakres czasowy
Prośba o zakres czasowy
Poniższy kod pokazuje, jak utworzyć treść żądania dla zapytania history
, które zwraca wiele rekordów historycznej jakości powietrza godzinowej.
Możesz poprosić o wiele rekordów, podając zakres czasowy, czyli sygnaturę czasową początku i końca, lub podając liczbę godzin wstecz od bieżącej godziny.
W przykładzie poniżej, ponieważ rozmiar strony został ustawiony na 2
, żądanie dotyczące 4 godzin historii jakości powietrza zwraca 2 strony, z których każda zawiera 2 godziny danych.
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'
Możesz przesłać podobne żądanie, podając sygnaturę czasową rozpoczęcia i zakończenia:
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'
Odpowiedź dotycząca zakresu czasowego
Powyższe wywołania generują odpowiedź w formacie JSON w postaci pokazanej poniżej. Więcej informacji o danych odpowiedzi znajdziesz w artykule Dane odpowiedzi.
Oba wywołania wymagają danych o jakości powietrza z 4 godzin. Ponieważ jednak w prośbie ustawiono wartość właściwości pageSize
na 2
, odpowiedź zawiera tylko wyniki z ostatnich 2 godzin.
{ "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" }
Zwróć uwagę, że odpowiedź zawiera też właściwość nextPageToken
. Użyj tej właściwości, aby uzyskać dostęp do następnej strony wyników, która zawiera dane z następnych 2 godzin.
Aby uzyskać dostęp do następnej strony wyników, prześlij drugie żądanie do punktu końcowego history
, ale tym razem ustaw właściwość pageToken
na wartość nextPageToken
z pierwszej odpowiedzi.
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'