Method: forecast.lookup

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

Żądanie HTTP

POST https://airquality.googleapis.com/v1/forecast:lookup

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Pola
location

object (LatLng)

Wymagane. Długość i szerokość geograficzna, na podstawie których interfejs API szuka 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.
pageSize

integer

Opcjonalnie: Maksymalna liczba rekordów informacyjnych godzinowych do zwrócenia na stronę (domyślnie = 24).
pageToken

string

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

string (Timestamp format)

Sygnatura czasowa, dla której mają być zwracane dane w określonym momencie. Sygnatura czasowa jest zaokrąglana do poprzedniej dokładnej godziny.

Spowoduje to zwrócenie tylko danych godzinowych 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.

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

object (Interval)

Wskazuje okresy startTime i endTime, dla których chcesz uzyskać dane prognostyczne. endTime promuje integrację społeczną. 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 (domyślnie = true).
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 (domyślnie = „en”).

Treść odpowiedzi

Obiekt odpowiedzi interfejsu API prognozy jakości powietrza.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Pola
hourlyForecasts[]

object (HourlyForecast)

Opcjonalnie: Zawiera informacje o jakości powietrza dla każdej godziny w wybranym zakresie. Jeśli na przykład żądanie dotyczy prognozy 48-godzinnej, będzie zawierać 48 elementów prognoz godzinowych.
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.

HourlyForecast

Zawiera informacje o jakości powietrza dla każdej godziny w wybranym zakresie. Jeśli na przykład żądanie dotyczy prognozy 48-godzinnej, będzie zawierać 48 elementów prognoz godzinowych.

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 godzinę, do której odnosi się dane w RFC 3339 czasu UTC „Zulu”. . 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 jest zwracana, jeśli wartość logiczna universalAqi ma wartość 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.