Zwraca historię jakości powietrza w określonej lokalizacji w wybranym okresie.
Żądanie HTTP
POST https://airquality.googleapis.com/v1/history:lookup
Adres URL używa składni transkodowania gRPC.
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "pageSize": integer, "pageToken": string, "location": { object ( |
Pola | |
---|---|
pageSize |
Opcjonalnie. Maksymalna liczba rekordów z informacjami godzinowymi do zwrócenia na stronę. Wartość domyślna to 72, a maksymalna to 168 (7 dni danych). |
pageToken |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania historii. Służy on do pobrania kolejnej strony. Podając wartość tego parametru, wszystkie pozostałe parametry muszą odpowiadać wywołaniu, które dostarczyło token strony (poprzednie wywołanie). |
location |
Wymagane. Długość i szerokość geograficzna, dla których interfejs API szuka danych historycznych dotyczących jakości powietrza. |
extraComputations[] |
Opcjonalnie. Dodatkowe funkcje, które można włączyć opcjonalnie. Jeśli określisz dodatkowe obliczenia, w odpowiedzi zostaną zwrócone odpowiednie elementy i pola. |
uaqiColorPalette |
Opcjonalnie. Określa paletę kolorów używaną w przypadku danych dostarczanych przez „Universal Air Quality Index” (UAQI). Ta paleta kolorów dotyczy tylko UAQI, inne AQI mają z góry określoną paletę kolorów, których nie można kontrolować. |
customLocalAqis[] |
Opcjonalnie. Wyraża relację „kraj/region wg AQI”. Pozwala połączyć kraj/region z odpowiednim wskaźnikiem AQI, tak aby dane dotyczące jakości powietrza wymagane dla tego kraju/regionu były wyświetlane zgodnie z wybranym AQI. Ten parametr umożliwia określenie wartości AQI innej niż domyślna dla danego kraju, np. w celu uzyskania indeksu EPA dla Kanady zamiast domyślnego indeksu dla Kanady. |
dateTime |
Sygnatura czasowa, dla której mają zostać zwrócone dane historyczne. Sygnatura czasowa jest zaokrąglana do poprzedniej dokładnej godziny. Uwaga: spowoduje to wyświetlenie danych godzinowych tylko dla żądanej sygnatury czasowej (tj. pojedynczego elementu informacji godzinowych). Na przykład żądanie wysłane, w którym parametr dateTime jest ustawiony na 2023-01-03T11:05:49Z, zostanie zaokrąglone w dół do 2023-01-03T11:00:00Z. Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: „2014-10-02T15:01:23Z” i „2014-10-02T15:01:23.045123456Z”. Uwaga: w żądaniu można użyć |
hours |
Liczba od 1 do 720, która wskazuje zakres godzin, w których przypadku zostało zrealizowane żądanie. Na przykład wartość równa 48 spowoduje wyświetlenie danych z ostatnich 48 godzin. |
period |
Wskazuje okres Uwaga: w żądaniu można użyć |
universalAqi |
Opcjonalnie. Jeśli zasada ma wartość Prawda, uniwersalny AQI jest uwzględniany w polu „indeksy” odpowiedzi. Wartość domyślna to true (prawda). |
languageCode |
Opcjonalnie. Pozwala klientowi wybrać język odpowiedzi. Jeśli nie można podać danych dla tego języka, interfejs API używa najbliższego dopasowania. Dozwolone wartości zależą od standardu IETF. Wartość domyślna to en. |
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"hoursInfo": [
{
object ( |
Pola | |
---|---|
hoursInfo[] |
Opcjonalnie. Zawiera informacje o jakości powietrza z każdej godziny w żądanym zakresie. Jeśli na przykład żądanie dotyczy historii z 48 godzin, będzie zawierać 48 elementów informacji godzinowych. |
regionCode |
Opcjonalnie. Kod ISO_3166-1 alfa-2 kraju lub regionu odpowiadający lokalizacji podanej w żądaniu. To pole może zostać pominięte w odpowiedzi, jeśli lokalizacja podana w prośbie znajduje się na terytorium spornym. |
nextPageToken |
Opcjonalnie. Token pobierania następnej strony. |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/cloud-platform
Więcej informacji znajdziesz w omówieniu protokołu OAuth 2.0.
HourInfo
Zawiera informacje o jakości powietrza z każdej godziny w żądanym zakresie. Jeśli na przykład żądanie dotyczy historii z 48 godzin, będzie zawierać 48 elementów informacji godzinowych.
Zapis JSON |
---|
{ "dateTime": string, "indexes": [ { object ( |
Pola | |
---|---|
dateTime |
Zaokrąglona sygnatura czasowa wskazująca czas, do którego odnoszą się dane, zapisana w formacie UTC „Zulu” w formacie RFC3339, z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Na przykład: „2014-10-02T15:00:00Z”. |
indexes[] |
Na podstawie parametrów żądania lista zawiera maksymalnie 2 indeksy jakości powietrza:
|
pollutants[] |
Lista zanieczyszczeń mających wpływ na lokalizację podaną w prośbie. Uwaga: to pole będzie zwracane tylko w przypadku żądań, w których określono co najmniej jedną z tych dodatkowych obliczeń: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
healthRecommendations |
Porady zdrowotne i zalecane działania związane z zgłoszonymi warunkami dotyczącymi jakości powietrza. Rekomendacje są dostosowywane w różny sposób do grup zagrożonych, grup o większej wrażliwości na zanieczyszczenia oraz ogólnej populacji. |