Method: history.lookup

Gibt den Luftqualitätsverlauf für einen bestimmten Standort 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 Informationsdatensätze, die pro Seite zurückgegeben werden sollen. Der Standardwert ist 72 und der Maximalwert 168 (Daten für 7 Tage).
pageToken

string

Optional. Ein von einem vorherigen Aufrufverlauf empfangenes Seitentoken. Damit wird die nachfolgende Seite abgerufen.

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. Der Breiten- und Längengrad, für den die API nach Verlaufsdaten der Luftqualität sucht.
extraComputations[]

enum (ExtraComputation)

Optional. Zusätzliche Funktionen, die optional aktiviert werden können. Die Angabe zusätzlicher Berechnungen führt dazu, dass die relevanten Elemente und Felder in der Antwort zurückgegeben werden.
uaqiColorPalette

enum (ColorPalette)

Optional. Legt die Farbpalette fest, die für die vom universellen Luftqualitätsindex bereitgestellten Daten verwendet wird (UAQI). Diese Farbvorlage ist nur für UAQI relevant. Andere LQI haben eine vordefinierte Farbvorlage, die nicht geändert werden kann.
customLocalAqis[]

object (CustomLocalAqi)

Optional. Drückt ein Land/eine Region in LQI aus Beziehung. Verbindet ein Land/eine Region mit einem gewünschten LQI, sodass für dieses Land/diese Region erforderliche Luftqualitätsdaten entsprechend dem ausgewählten LQI angezeigt werden. Mit diesem Parameter kann ein nicht standardmäßiger LQI für ein bestimmtes Land angegeben werden, beispielsweise um den EPA-Index der USA für Kanada anstelle des Standardindex für Kanada abzurufen.
dateTime

string (Timestamp format)

Ein Zeitstempel, für den Verlaufsdaten zurückgegeben werden sollen. Der Zeitstempel wird auf die genaue vorherige Stunde gerundet.

Hinweis: Es werden nur stündliche Daten für den angeforderten Zeitstempel zurückgegeben (d.h. ein einzelnes stündliches Infoelement). Beispiel: Eine Anfrage, die gesendet wird, bei der der Parameter „dateTime“ auf 2023-01-03T11:05:49Z gesetzt wurde, 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. Beispiel: „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 zwischen 1 und 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 Zeitraum startTime und endTime an, für den Verlaufsdaten abgerufen werden sollen. Der Zeitstempel wird auf die genaue vorherige Stunde gerundet.

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

boolean

Optional. Wenn dieser Wert auf „true“ gesetzt ist, wird der universelle AQI in die „Indexe“ aufgenommen der Antwort ein. 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 bereitgestellt werden können, verwendet die API die genaueste Übereinstimmung. Die zulässigen 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 Informationen zur Luftqualität für jede Stunde im angeforderten Bereich. Wenn sich die Anfrage beispielsweise auf einen Verlauf von 48 Stunden bezieht, gibt es 48 Stündliche Informationen.
regionCode

string

Optional. Der Alpha-2-Code nach ISO_3166-1 des Landes bzw. der Region, die dem in der Anfrage angegebenen Ort 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 Informationen zur Luftqualität für jede Stunde im angeforderten Bereich. Wenn sich die Anfrage beispielsweise auf einen Verlauf von 48 Stunden bezieht, gibt es 48 Stündliche Informationen.

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 in RFC3339 UTC "Zulu" beziehen mit bis zu neun Nachkommastellen im Nanosekundenformat. Beispiel: „2014-10-02T15:00:00Z“.
indexes[]

object (AirQualityIndex)

Basierend auf den Anfrageparametern enthält diese Liste (bis zu) zwei Luftqualitätsindexe:

  • Universeller LQI. Wird zurückgegeben, wenn der boolesche Wert „universalAqi“ auf „true“ festgelegt ist.
  • Lokaler LQI Wird zurückgegeben, wenn die zusätzliche Berechnung für LOCAL_AQI angegeben ist.
pollutants[]

object (Pollutant)

Eine Liste der Schadstoffe, die den in der Anfrage angegebenen Standort beeinflussen. Hinweis: Dieses Feld wird nur für Anfragen zurückgegeben, in denen eine oder mehrere der folgenden zusätzlichen Berechnungen angegeben wurden: 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 sind unterschiedlich auf gefährdete Bevölkerungsgruppen, Gruppen mit höherer Empfindlichkeit gegenüber Schadstoffen und die Allgemeinbevölkerung zugeschnitten.