Punkt końcowy forecast udostępnia prognozy jakości powietrza w danej lokalizacji w ciągu 96 godzin (4 dni) w godzinowych odstępach. Każda prognoza zawiera indeksy jakości powietrza na godzinę oraz dodatkowe informacje:
- Konkretna godzina i data lub przedział czasu dla prognozy
- Kod języka dla tłumaczonych pól
- lokalny lub niestandardowy indeks jakości powietrza (AQI),
- Rekomendacje dotyczące zdrowia
- Główne zanieczyszczenia
- stężenie zanieczyszczenia,
- Dodatkowe informacje o zanieczyszczeniach
- Rozmiar strony odpowiedzi
- Paleta kolorów
Narzędzie APIs Explorer umożliwia wysyłanie żądań na żywo, dzięki czemu możesz zapoznać się z interfejsem API i jego opcjami:
Informacje o żądaniach prognozy
Możesz poprosić o godzinne prognozy jakości powietrza, korzystając z punktu końcowego prognozy, wysyłając żądanie HTTP POST na adres:
https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY
W treści żądania podaj parametry. Treść żądania zawiera lokalizację, dla której chcesz uzyskać godzinne prognozy jakości powietrza, oraz różne opcje umożliwiające kontrolowanie, jakie dodatkowe informacje mają być uwzględnione w odpowiedzi.
Odpowiedzi na prognozy
Treść odpowiedzi zawiera datę i godzinę w czasie UTC, w których mają być wyświetlane informacje o prognozie jakości powietrza, indeksy jakości powietrza oraz dodatkowe informacje dostosowane do potrzeb użytkownika. Treść odpowiedzi zawiera też token do pobrania następnej strony, jeśli informacje nie mieszczą się w żądanym rozmiarze strony.
Przykład podstawowego żądania
Poniższy kod pokazuje, jak utworzyć żądanie prognozy. W tym przykładzie określasz lokalizację, datę i godzinę (od następnej godziny do 96 godzin), dla których chcesz wyświetlać godzinne prognozy jakości powietrza.
curl -X POST -d '{
"location": {
"latitude": 37.4125333,
"longitude": -122.0840937
},
"dateTime": "2024-02-09T08:00:00Z"
}' \
-H "Content-Type: application/json" \
-H "Accept-Language: *" \
"https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY"
Wywołanie generuje następującą odpowiedź JSON.
{ "hourlyForecasts": [ { "dateTime": "2024-02-09T08:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 80, "aqiDisplay": "80", "color": { "red": 0.34509805, "green": 0.74509805, "blue": 0.20784314 }, "category": "Excellent air quality", "dominantPollutant": "pm25" } ] } ], "regionCode": "us" }
Przykład żądania z kilkoma parametrami
Poniższy kod pokazuje, jak utworzyć treść żądania z wieloma parametrami. W tym przykładzie podajesz te informacje:
- Lokalizacja
- Przedział czasu, w którym mają być wyświetlane informacje o prognozie jakości powietrza
- Kod języka
- dodatkowe obliczenia (np. zalecenia dotyczące zdrowia, stężenie dominującego zanieczyszczenia i dodatkowe informacje o zanieczyszczeniach);
- Paleta kolorów
curl -X POST -d '{
"pageSize": "10",
"universalAqi": "true",
"location": {
"latitude": "40.741895",
"longitude": "-73.989308"
},
"period": {
"startTime": "2024-02-27T13:58:14+02:00",
"endTime": "2024-02-28T16:58:14+02:00"
},
"languageCode": "en",
"extraComputations": [
"HEALTH_RECOMMENDATIONS",
"DOMINANT_POLLUTANT_CONCENTRATION",
"POLLUTANT_ADDITIONAL_INFO"
],
"uaqiColorPalette": "RED_GREEN"
}' \
-H "Content-Type: application/json" \
-H "Accept-Language: *" \
"https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY"
Wywołanie generuje następującą odpowiedź JSON.
{ { "hourlyForecasts": [ { "dateTime": "2024-02-27T11:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 75, "aqiDisplay": "75", "color": { "red": 0.43137255, "green": 0.7764706, "blue": 0.20392157 }, "category": "Good air quality", "dominantPollutant": "pm25" } ], "pollutants": [ { "code": "pm25", "displayName": "PM2.5", "fullName": "Fine particulate matter (\u003c2.5µm)", "concentration": { "value": 15.1, "units": "MICROGRAMS_PER_CUBIC_METER" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "..." } }, { "dateTime": "2024-02-27T12:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 67, "aqiDisplay": "67", "color": { "red": 0.5882353, "green": 0.8392157, "blue": 0.16862746 }, "category": "Good air quality", "dominantPollutant": "pm25" } ], "pollutants": [ { "code": "pm25", "displayName": "PM2.5", "fullName": "Fine particulate matter (\u003c2.5µm)", "concentration": { "value": 19.96, "units": "MICROGRAMS_PER_CUBIC_METER" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "...", "children": "..." } }, /.../ ] } "regionCode": "us", "nextPageToken": "CjMKEglwCFVq9l5EQBH0aoDSUH9SwBoQCgYI1pDirgYSBgiGiOiuBiABKgMCBAMyAmVuOAEQGA==" }
Aby wyświetlić kolejną stronę informacji o prognozie, prześlij parametr nextPageTokenzwrócony na końcu treści odpowiedzi:
curl -X POST -d '{
"universalAqi": "true",
"location": {
"latitude": "40.741895",
"longitude": "-73.989308"
},
"period": {
"startTime": "2024-02-27T13:58:14+02:00",
"endTime": "2024-02-28T16:58:14+02:00"
},
"languageCode": "en",
"extraComputations": [
"HEALTH_RECOMMENDATIONS",
"DOMINANT_POLLUTANT_CONCENTRATION",
"POLLUTANT_ADDITIONAL_INFO"
],
"uaqiColorPalette": "RED_GREEN",
"pageToken": "CjMKEglwCFVq9l5EQBH0aoDSUH9SwBoQCgYI1pDirgYSBgiGiOiuBiABKgMCBAMyAmVuOAEQGA=="
}' \
-H "Content-Type: application/json" \
-H "Accept-Language: *" \
"https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY"
Zwraca ona kolejną stronę informacji o prognozie:
{ "hourlyForecasts": [ { "dateTime": "2024-02-27T21:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 74, "aqiDisplay": "74", "color": { "red": 0.44705883, "green": 0.78431374, "blue": 0.2 }, "category": "Good air quality", "dominantPollutant": "o3" } ], "pollutants": [ { "code": "o3", "displayName": "O3", "fullName": "Ozone", "concentration": { "value": 32.07, "units": "PARTS_PER_BILLION" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "elderly": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "...", "children": "..." } }, { "dateTime": "2024-02-27T22:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 75, "aqiDisplay": "75", "color": { "red": 0.43137255, "green": 0.7764706, "blue": 0.20392157 }, "category": "Good air quality", "dominantPollutant": "o3" } ], "pollutants": [ { "code": "o3", "displayName": "O3", "fullName": "Ozone", "concentration": { "value": 30.94, "units": "PARTS_PER_BILLION" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "...", "children": "..." } }, /.../ ] "regionCode": "us" }