Method: history.lookup

Gibt den Verlauf der Luftqualität für einen bestimmten Ort für einen bestimmten Zeitraum zurück.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

integer

Optional. Die maximale Anzahl stündlicher Datensätze, die pro Seite zurückgegeben werden sollen. Der Standardwert ist 72 und der Maximalwert 168 (Daten aus 7 Tagen).
pageToken

string

Optional. Ein von einem vorherigen Verlaufsaufruf empfangenes Seitentoken. Sie wird verwendet, um die nachfolgende Seite abzurufen.

Wenn Sie einen Wert für diesen Parameter angeben, müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat (der vorherige Aufruf).
location

object (LatLng)

Erforderlich. Breiten- und Längengrad, für den die API nach Luftqualitätsverlaufsdaten 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.
dateTime

string (Timestamp format)

Ein Zeitstempel, für den historische Daten zurückgegeben werden sollen. Der Zeitstempel wird auf die genaue vorherige Stunde aufgerundet.

Hinweis: 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.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: „2014-10-02T15:01:23Z“ und „2014-10-02T15:01:23.045123456Z“.

Hinweis: In einer Anfrage können entweder dateTime oder startTime und endTime verwendet werden.
hours

integer

Zahl von 1 bis 720, die den Stundenbereich für die Anfrage angibt. Beispiel: Ein Wert von 48 liefert Daten aus den letzten 48 Stunden.
period

object (Interval)

Gibt den startTime- und endTime-Zeitraum an, für den Verlaufsdaten abgerufen werden sollen. 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. Der Standardwert ist "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. Der Standardwert ist „en“.

Antworttext

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

JSON-Darstellung 
{
  "hoursInfo": [
    {
      object (HourInfo)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Felder
hoursInfo[]

object (HourInfo)

Optional. Enthält die Daten zur Luftqualität für jede Stunde im angeforderten Bereich. Wenn sich die Anfrage beispielsweise auf einen Verlauf von 48 Stunden bezieht, sind 48 Stündliche Informationen aus 48 Elementen vorhanden.
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.

HourInfo

Enthält die Daten zur Luftqualität für jede Stunde im angeforderten Bereich. Wenn sich die Anfrage beispielsweise auf einen Verlauf von 48 Stunden bezieht, sind 48 Stündliche Informationen aus 48 Elementen vorhanden.

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

string (Timestamp format)

Ein abgerundeter Zeitstempel, der die Zeit angibt, auf die sich die Daten im Format RFC3339 UTC „Zulu““ beziehen, mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. 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.