Method: forecast.lookup

Zwraca prognozę jakości powietrza w danej lokalizacji w wybranym okresie.

Żą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. Szerokość i długość geograficzna, dla których interfejs API szuka danych o jakości powietrza.
extraComputations[]

enum (ExtraComputation)

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

enum (ColorPalette)

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[]

object (CustomLocalAqi)

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.
pageSize

integer

Opcjonalnie. Maksymalna liczba rekordów z informacjami godzinowymi do zwrócenia na stronę (domyślnie = 24).
pageToken

string

Opcjonalnie. Token strony odebrany z poprzedniego wywołania prognozy. Służy on do pobrania kolejnej strony.
dateTime

string (Timestamp format)

Sygnatura czasowa, dla której mają zostać zwrócone dane dotyczące określonego momentu. Sygnatura czasowa jest zaokrąglana do poprzedniej dokładnej godziny.

Zwróci ono dane godzinowe 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.

Uwaga: w żądaniu można użyć dateTime lub startTime i endTime.
period

object (Interval)

Wskazuje okres startTime i endTime, dla którego mają zostać uzyskane dane prognozy. Cena endTime uwzględnia. Sygnatura czasowa jest zaokrąglana do poprzedniej dokładnej godziny.

Uwaga: w żądaniu można użyć dateTime lub startTime i endTime.
universalAqi

boolean

Opcjonalnie. Jeśli zasada ma wartość Prawda, uniwersalny AQI jest uwzględniany w polu „indexes” odpowiedzi (domyślnie = prawda).
languageCode

string

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 (domyślnie = „en”).

Treść odpowiedzi

Obiekt odpowiedzi interfejsu API prognozowania 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 z każdej godziny w żądanym 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 spornym.
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 omówieniu protokołu OAuth 2.0.

HourlyForecast

Zawiera informacje o jakości powietrza z każdej godziny w żądanym 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)

Zaokrąglona sygnatura czasowa wskazująca godzinę (godzinę), do której odnoszą się dane, zapisana w formacie „zulu” (RFC 3339 UTC). Na przykład: „2014-10-02T15:00:00Z”.
indexes[]

object (AirQualityIndex)

Na podstawie parametrów żądania lista zawiera maksymalnie 2 indeksy jakości powietrza:

  • Uniwersalny AQI. Zwracana, jeśli wartość logiczna universalAqi ma wartość true.
  • Lokalny wskaźnik AQI Zwracana, jeśli określono dodatkowe obliczenia LOCAL_AQI.
pollutants[]

object (Pollutant)

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

object (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.