Method: history.lookup

Menampilkan histori kualitas udara untuk lokasi tertentu selama rentang waktu tertentu.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "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
}
Kolom
pageSize

integer

Opsional. Jumlah maksimum data info per jam yang akan ditampilkan per halaman. Defaultnya adalah 72 dan nilai maks adalah 168 (data 7 hari).
pageToken

string

Opsional. Token halaman yang diterima dari panggilan histori sebelumnya. Ini digunakan untuk mengambil halaman berikutnya.

Perhatikan bahwa saat memberikan nilai untuk parameter ini, semua parameter lain yang disediakan harus cocok dengan panggilan yang menyediakan token halaman (panggilan sebelumnya).
location

object (LatLng)

Wajib. Lintang dan bujur yang dicari data histori kualitas udara oleh API.
extraComputations[]

enum (ExtraComputation)

Opsional. Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menghasilkan elemen dan kolom yang relevan untuk ditampilkan dalam respons.
uaqiColorPalette

enum (ColorPalette)

Opsional. Menentukan palet warna yang digunakan untuk data yang disediakan oleh 'Universal Air Quality Index' (UAQI). Palet warna ini hanya relevan untuk UAQI, AQI lainnya memiliki palet warna yang telah ditentukan yang tidak dapat dikontrol.
customLocalAqis[]

object (CustomLocalAqi)

Opsional. Menyatakan hubungan 'negara/wilayah ke AQI'. Menyambungkan negara/wilayah dengan AQI yang diinginkan sehingga data kualitas udara yang diperlukan untuk negara/wilayah tersebut akan ditampilkan sesuai dengan AQI yang dipilih. Parameter ini dapat digunakan untuk menentukan AQI non-default untuk negara tertentu, misalnya, untuk mendapatkan indeks EPA AS untuk Kanada, bukan indeks default untuk Kanada.
dateTime

string (Timestamp format)

Stempel waktu yang menampilkan data historis. Stempel waktu dibulatkan ke jam persis sebelumnya.

Catatan: metode ini akan menampilkan data per jam untuk stempel waktu yang diminta saja (yaitu, satu elemen info per jam). Misalnya, permintaan yang dikirim dengan parameter dateTime ditetapkan ke 2023-01-03T11:05:49Z akan dibulatkan ke bawah menjadi 2023-01-03T11:00:00Z.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Catatan: dateTime atau startTime dan endTime dapat digunakan dalam permintaan.
hours

integer

Angka dari 1 hingga 720 yang menunjukkan rentang jam untuk permintaan. Misalnya: Nilai 48 akan menghasilkan data dari 48 jam terakhir.
period

object (Interval)

Menunjukkan periode startTime dan endTime yang digunakan untuk mendapatkan data historis. Stempel waktu dibulatkan ke jam persis sebelumnya.

Catatan: dateTime atau startTime dan endTime dapat digunakan dalam permintaan.
universalAqi

boolean

Opsional. Jika ditetapkan ke benar, AQI Universal akan disertakan di kolom 'indeks' respons. Nilai default adalah true.
languageCode

string

Opsional. Memungkinkan klien memilih bahasa untuk respons. Jika data tidak dapat diberikan untuk bahasa tersebut, API akan menggunakan bahasa terdekat yang cocok. Nilai yang diizinkan bergantung pada standar IETF. Nilai defaultnya adalah en.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "hoursInfo": [
    {
      object (HourInfo)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Kolom
hoursInfo[]

object (HourInfo)

Opsional. Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaan dibuat untuk histori selama 48 jam, akan ada 48 elemen info per jam.
regionCode

string

Opsional. Kode ISO_3166-1 alpha-2 untuk negara/wilayah yang sesuai dengan lokasi yang diberikan dalam permintaan. Kolom ini mungkin dihapus dari respons jika lokasi yang diberikan dalam permintaan berada di wilayah sengketa.
nextPageToken

string

Opsional. Token untuk mengambil halaman berikutnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

HourInfo

Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaan dibuat untuk histori selama 48 jam, akan ada 48 elemen info per jam.

Representasi JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Kolom
dateTime

string (Timestamp format)

Stempel waktu yang dibulatkan ke bawah menunjukkan waktu yang dirujuk data dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit pecahan. Misalnya: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

Berdasarkan parameter permintaan, daftar ini akan mencakup (hingga) dua indeks kualitas udara:

  • AQI Universal. Akan ditampilkan jika boolean universalAqi disetel ke benar (true).
  • AQI lokal. Akan dikembalikan jika komputasi tambahan LOCAL_AQI ditentukan.
pollutants[]

object (Pollutant)

Daftar polutan yang memengaruhi lokasi yang ditentukan dalam permintaan. Catatan: Kolom ini hanya akan ditampilkan untuk permintaan yang menentukan satu atau beberapa komputasi tambahan berikut: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

Saran kesehatan dan tindakan yang disarankan terkait kondisi kualitas udara yang dilaporkan. Rekomendasi disesuaikan secara berbeda untuk populasi yang berisiko, kelompok dengan sensitivitas lebih besar terhadap polutan, dan populasi umum.