Method: currentConditions.lookup

Punkt końcowy Aktualne warunki zawiera godzinowe informacje o jakości powietrza w ponad 100 krajach, z dokładnością do 500 x 500 metrów. Zawiera ponad 70 indeksów lokalnych oraz globalnego indeksu i kategorii jakości powietrza.

Żą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)

Wymagane. Długość i szerokość geograficzna, z których interfejs API szuka danych o bieżących warunkach 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.
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 
{
  "dateTime": string,
  "regionCode": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Pola
dateTime

string (Timestamp format)

Sygnatura czasowa zaokrąglona w dół w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 prośbie znajduje się na terytorium, którego dotyczy spór.
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.

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.