Diese Seite wurde von der Cloud Translation API übersetzt.

Method: forecast.lookup

HTTP-Anfrage
Anfragetext
- JSON-Darstellung
Antworttext
- JSON-Darstellung
Autorisierungsbereiche
HourlyForecast
- JSON-Darstellung

Gibt die Luftqualitätsprognose für einen bestimmten Ort für einen bestimmten Zeitraum zurück.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung

JSON-Darstellung
{ "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 }

{
  "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
}

Felder
`location`	`object (LatLng)` Erforderlich. Breiten- und Längengrad, für den die API nach Luftqualitätsdaten sucht.
`extraComputations[]`	`enum (ExtraComputation)` Optional. Zusätzliche Funktionen, die optional aktiviert werden können. Wenn Sie zusätzliche Berechnungen angeben, werden die relevanten Elemente und Felder in der Antwort zurückgegeben.
`uaqiColorPalette`	`enum (ColorPalette)` Optional. Legt die Farbpalette für die vom Universal Air Quality Index (UAQI) bereitgestellten Daten fest. Diese Farbvorlage ist nur für UQI relevant. Andere AQIs haben eine vordefinierte Farbpalette, die nicht gesteuert werden kann.
`customLocalAqis[]`	`object (CustomLocalAqi)` Optional. Drückt eine Beziehung zwischen Land/Region und AQI aus. Koppelt ein Land/eine Region mit einem gewünschten Luftqualitätsindex, sodass für dieses Land/diese Region erforderliche Luftqualitätsdaten gemäß dem ausgewählten Luftqualitätsindex angezeigt werden. Mit diesem Parameter kann ein nicht standardmäßiger AQI für ein bestimmtes Land angegeben werden, um beispielsweise den US-EPA-Index für Kanada und nicht den Standardindex für Kanada zu erhalten.
`pageSize`	`integer` Optional. Maximale Anzahl von stündlichen Informationseinträgen, die pro Seite zurückgegeben werden sollen (Standard: 24).
`pageToken`	`string` Optional. Ein Seitentoken, das von einem vorherigen Prognoseaufruf empfangen wurde. Sie wird verwendet, um die nachfolgende Seite abzurufen.
`dateTime`	`string (Timestamp format)` Ein Zeitstempel, für den die Daten für einen bestimmten Zeitpunkt zurückgegeben werden sollen. Der Zeitstempel wird auf die genaue vorherige Stunde aufgerundet. Dadurch werden nur für den angeforderten Zeitstempel stündliche Daten zurückgegeben (d.h. ein einzelnes stündliches Infoelement). Beispiel: Eine Anfrage, die gesendet wurde und für den Parameter „dateTime“ auf „2023-01-03T11:05:49Z“ festgelegt ist, wird auf 2023-01-03T11:00:00Z abgerundet. Hinweis: In einer Anfrage können entweder `dateTime` oder `startTime` und `endTime` verwendet werden.
`period`	`object (Interval)` Gibt den `startTime`- und `endTime`-Zeitraum an, für den Prognosedaten abgerufen werden sollen. `endTime` ist einschließlich. Der Zeitstempel wird auf die genaue vorherige Stunde aufgerundet. Hinweis: In einer Anfrage können entweder `dateTime` oder `startTime` und `endTime` verwendet werden.
`universalAqi`	`boolean` Optional. Wenn die Richtlinie auf „true“ gesetzt ist, wird der universelle LQI in das Feld „indexes“ der Antwort aufgenommen (Standardeinstellung: „true“).
`languageCode`	`string` Optional. Ermöglicht dem Client, die Sprache für die Antwort auszuwählen. Wenn für diese Sprache keine Daten zur Verfügung gestellt werden können, verwendet die API die beste Übereinstimmung. Zulässige Werte basieren auf dem IETF-Standard (Standard = 'en').

Antworttext

Das Antwortobjekt der Luftqualitätsprognose-API.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung
{ "hourlyForecasts": [ { object (`HourlyForecast`) } ], "regionCode": string, "nextPageToken": string }

Felder

Felder
`hourlyForecasts[]`	`object (HourlyForecast)` Optional. Enthält die Daten zur Luftqualität für jede Stunde im angeforderten Bereich. Wenn beispielsweise eine Prognose für 48 Stunden angefordert wird, gibt es 48 Elemente für stündliche Prognosen.
`regionCode`	`string` Optional. Der Alpha-2-Code gemäß ISO_3166-1 des Landes/der Region, die dem in der Anfrage angegebenen Standort entspricht. Dieses Feld kann in der Antwort weggelassen werden, wenn sich der in der Anfrage angegebene Standort in einem umstrittenen Gebiet befindet.
`nextPageToken`	`string` Optional. Das Token zum Abrufen der nächsten Seite.

hourlyForecasts[]

object (HourlyForecast)

Optional. Enthält die Daten zur Luftqualität für jede Stunde im angeforderten Bereich. Wenn beispielsweise eine Prognose für 48 Stunden angefordert wird, gibt es 48 Elemente für stündliche Prognosen.

regionCode

string

Optional. Der Alpha-2-Code gemäß ISO_3166-1 des Landes/der Region, die dem in der Anfrage angegebenen Standort entspricht. Dieses Feld kann in der Antwort weggelassen werden, wenn sich der in der Anfrage angegebene Standort in einem umstrittenen Gebiet befindet.

nextPageToken

string

Optional. Das Token zum Abrufen der nächsten Seite.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

HourlyForecast

Enthält die Daten zur Luftqualität für jede Stunde im angeforderten Bereich. Wenn beispielsweise eine Prognose für 48 Stunden angefordert wird, gibt es 48 Elemente für stündliche Prognosen.

JSON-Darstellung
{ "dateTime": string, "indexes": [ { object (`AirQualityIndex`) } ], "pollutants": [ { object (`Pollutant`) } ], "healthRecommendations": { object (`HealthRecommendations`) } }

Felder
`dateTime`	`string (Timestamp format)` Ein abgerundeter Zeitstempel, der die Zeit (Stunde) angibt, auf die sich die Daten im Format RFC3339 UTC „Zulu“ beziehen. Beispiel: „2014-10-02T15:00:00Z“.
`indexes[]`	`object (AirQualityIndex)` Abhängig von den Anfrageparametern enthält diese Liste (bis zu) zwei Luftqualitätsindexe: Universeller Luftqualitätsindex (LQI). Wird zurückgegeben, wenn der boolesche Wert `universalAqi` auf „true“ festgelegt ist. LQI vor Ort Wird zurückgegeben, wenn die zusätzliche LOCAL_AQI-Berechnung angegeben wird.
`pollutants[]`	`object (Pollutant)` Eine Liste der Schadstoffe, die sich auf den in der Anfrage angegebenen Ort auswirken. Hinweis: Dieses Feld wird nur für Anfragen zurückgegeben, in denen mindestens eine der folgenden zusätzlichen Berechnungen angegeben wurde: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
`healthRecommendations`	`object (HealthRecommendations)` Gesundheitstipps und empfohlene Maßnahmen in Bezug auf die gemeldete Luftqualität. Die Empfehlungen werden unterschiedlich auf gefährdete Bevölkerungsgruppen, Gruppen mit höherer Schadstoffempfindlichkeit und Allgemeinbevölkerung zugeschnitten.