Method: history.lookup

Zwraca historię jakości powietrza dla określonej lokalizacji w wybranym przedziale czasu.

Żą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 (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "dateTime": string,
  "hours": integer,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Pola
pageSize

integer

Opcjonalnie: Maksymalna liczba rekordów informacyjnych zwracanych co godzinę na stronę. Wartość domyślna to 72, a wartość maksymalna to 168 (dane z 7 dni).
pageToken

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania historii. Służy do pobierania następnej strony.

Pamiętaj, że gdy podajesz wartość tego parametru, wszystkie pozostałe parametry muszą być zgodne z wywołaniem, które dostarczyło token strony (poprzednie wywołanie).
location

object (LatLng)

Wymagane. Długość i szerokość geograficzna, na podstawie których interfejs API szuka historycznych danych o jakości powietrza.
extraComputations[]

enum (ExtraComputation)

Opcjonalnie: Dodatkowe funkcje, które można opcjonalnie włączyć. Jeśli określisz dodatkowe obliczenia, w odpowiedzi zostaną zwrócone odpowiednie elementy i pola.
uaqiColorPalette

enum (ColorPalette)

Opcjonalnie: Określa paletę kolorów używaną dla danych dostarczanych przez „Uniwersalny indeks jakości powietrza” (UAQI). Ta paleta kolorów dotyczy tylko UAQI. Inne wskaźniki AQI mają wstępnie określoną paletę kolorów, której nie można kontrolować.
customLocalAqis[]

object (CustomLocalAqi)

Opcjonalnie: Wyraża „kraj/region do AQI” relacji. Wiąże kraj/region z odpowiednim wskaźnikiem AQI, tak aby dane o jakości powietrza wymagane w przypadku tego kraju/regionu były wyświetlane zgodnie z wybranym wskaźnikiem AQI. Tego parametru można użyć do określenia niedomyślnego indeksu AQI dla danego kraju, np. w celu uzyskania amerykańskiego indeksu EPA dla Kanady, a nie domyślnego indeksu dla Kanady.
dateTime

string (Timestamp format)

Sygnatura czasowa, dla której mają być zwracane dane historyczne. Sygnatura czasowa jest zaokrąglana do poprzedniej dokładnej godziny.

Uwaga: spowoduje to zwrócenie 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 RFC3339 UTC „Zulu” 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ć zarówno dateTime, jak i startTime oraz endTime.
hours

integer

Liczba od 1 do 720, która wskazuje zakres godzin, których dotyczy żądanie. Na przykład wartość 48 oznacza dane z ostatnich 48 godzin.
period

object (Interval)

Wskazuje okres startTime i endTime, z którego mają zostać pobrane dane historyczne. Sygnatura czasowa jest zaokrąglana do poprzedniej dokładnej godziny.

Uwaga: w żądaniu można użyć zarówno dateTime, jak i startTime oraz endTime.
universalAqi

boolean

Opcjonalnie: Jeśli ma wartość Prawda, uniwersalny AQI jest uwzględniany w „indeksach”. odpowiedzi. Wartość domyślna to true (prawda).
languageCode

string

Opcjonalnie: Umożliwia klientowi wybór języka odpowiedzi. Jeśli nie można dostarczyć 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 (HourInfo)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Pola
hoursInfo[]

object (HourInfo)

Opcjonalnie: Zawiera informacje o jakości powietrza dla każdej godziny w wybranym zakresie. Jeśli na przykład żądanie dotyczy historii z 48 godzin, informacje godzinowe będą obejmować 48 elementów.
regionCode

string

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, którego dotyczy spór.
nextPageToken

string

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 artykule Omówienie protokołu OAuth 2.0.

HourInfo

Zawiera informacje o jakości powietrza dla każdej godziny w wybranym zakresie. Jeśli na przykład żądanie dotyczy historii z 48 godzin, informacje godzinowe będą obejmować 48 elementów.

Zapis JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Pola
dateTime

string (Timestamp format)

Sygnatura czasowa zaokrąglona w dół wskazująca czas, do którego odnoszą się dane, podany w polu RFC 3339 w strefie czasowej UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Na przykład: „2014-10-02T15:00:00Z”.
indexes[]

object (AirQualityIndex)

W zależności od parametrów żądania lista będzie zawierać maksymalnie 2 indeksy jakości powietrza:

  • Universal AQI. Wartość ta zostanie zwrócona, jeśli wartość logiczna UniversalAqi ma wartość true (prawda).
  • Lokalny AQI. Ta wartość zostanie zwrócona, jeśli zostanie określone dodatkowe obliczenia LOCAL_AQI.
pollutants[]

object (Pollutant)

Lista zanieczyszczeń wpływających na lokalizację podaną w prośbie. Uwaga: to pole będzie zwracane tylko w przypadku żądań, w których określono co najmniej jedno z tych dodatkowych obliczeń: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

Porady zdrowotne i zalecane działania w związku z zgłoszonymi warunkami jakości powietrza. Rekomendacje są dostosowywane w różny sposób do populacji narażonych na ataki, grupy bardziej wrażliwej na zanieczyszczenia oraz ogólnej populacji.