Method: currentConditions.lookup

Punkt końcowy „Aktualne warunki” dostarcza godzinowych informacji o jakości powietrza w ponad 100 krajach o rozdzielczości do 500 x 500 metrów. Obejmuje ponad 70 indeksów lokalnych oraz globalny indeks jakości powietrza i kategorie.

Żądanie HTTP

POST https://airquality.googleapis.com/v1/currentConditions: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)
    }
  ],
  "universalAqi": boolean,
  "languageCode": string
}
Pola
location

object (LatLng)

To pole jest wymagane. Długość i szerokość geograficzna, z których interfejs API szuka danych o bieżących warunkach dotyczących jakości powietrza.
extraComputations[]

enum (ExtraComputation)

Opcjonalnie. Dodatkowe funkcje, które możesz 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 „uniwersalny indeks jakości powietrza” (UAQI). Ta paleta kolorów dotyczy tylko UAQI, inne AQI mają z góry określoną paletę kolorów, której nie można kontrolować.
customLocalAqis[]

object (CustomLocalAqi)

Opcjonalnie. Wyraża relację „kraj/region” z AQI. Paruje kraj/region z wymaganym AQI, tak by dane dotyczące jakości powietrza wymagane w danym kraju/regionie były wyświetlane zgodnie z wybranym współczynnikiem. Ten parametr może służyć do określania niestandardowego indeksu AQI dla danego kraju, np. w celu uzyskania indeksu EPA dla Kanady zamiast domyślnego indeksu dla Kanady.
universalAqi

boolean

Opcjonalnie. Jeśli zasada ma wartość Prawda, uniwersalny AQI będzie uwzględniany w polu „indeksy” odpowiedzi. Wartość domyślna to true (prawda).
languageCode

string

Opcjonalnie. Pozwala klientowi wybrać język odpowiedzi. Jeśli nie można podać danych dla danego 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 
{
  "dateTime": string,
  "regionCode": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Pola
dateTime

string (Timestamp format)

Zaokrąglona sygnatura czasowa w formacie „zulu” w formacie RFC3339 UTC z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Na przykład: „2014-10-02T15:00:00Z”.
regionCode

string

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 żądaniu znajduje się na terytorium spornym.
indexes[]

object (AirQualityIndex)

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

  • Uniwersalny AQI. Zwracany, jeśli wartość logiczna UniversalAqi ma wartość true (prawda).
  • Lokalny AQI Zwracana, jeśli określono 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 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. Zalecenia są dostosowywane w różny sposób do populacji zagrożonych, grup o większej wrażliwości na zanieczyszczenia oraz ogólnej populacji.

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.