Method: forecast.lookup

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

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

object (LatLng)

Wajib diisi. Lintang dan bujur tempat API mencari data kualitas udara.
extraComputations[]

enum (ExtraComputation)

Opsional. Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menghasilkan elemen dan kolom yang relevan 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 relevan hanya untuk UAQI, AQI lain memiliki palet warna yang telah ditentukan yang tidak dapat dikontrol.
customLocalAqis[]

object (CustomLocalAqi)

Opsional. Menunjukkan 'negara/wilayah ke AQI' hubungan. 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.
pageSize

integer

Opsional. Jumlah maksimum data info per jam yang akan ditampilkan per halaman (default = 24).
pageToken

string

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

string (Timestamp format)

Stempel waktu yang akan digunakan untuk menampilkan data pada waktu tertentu. Stempel waktu dibulatkan ke jam persis sebelumnya.

Ini akan menampilkan data per jam hanya untuk stempel waktu yang diminta (yaitu, elemen info per jam tunggal). Misalnya, permintaan yang dikirim dengan parameter dateTime yang ditetapkan ke 2023-01-03T11:05:49Z akan dibulatkan ke 2023-01-03T11:00:00Z.

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

object (Interval)

Menunjukkan periode startTime dan endTime untuk mendapatkan data perkiraan. endTime bersifat inklusif. Stempel waktu dibulatkan ke jam persis sebelumnya.

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

boolean

Opsional. Jika ditetapkan ke true, AQI Universal akan disertakan dalam 'indeks' kolom respons (default = true).
languageCode

string

Opsional. Memungkinkan klien memilih bahasa untuk respons. Jika data tidak dapat diberikan untuk bahasa tersebut, API akan menggunakan pencocokan terdekat. Nilai yang diizinkan bergantung pada standar IETF (default = 'en').

Isi respons

Objek respons API perkiraan kualitas udara.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (HourlyForecast)

Opsional. Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaannya adalah perkiraan 48 jam, akan ada 48 elemen prakiraan cuaca per jam.
regionCode

string

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

string

Opsional. Token untuk mengambil halaman berikutnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

HourlyForecast

Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaannya adalah perkiraan 48 jam, akan ada 48 elemen prakiraan cuaca 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 yang menunjukkan waktu (jam) yang dirujuk data dalam RFC3339 UTC "Zulu" format font. 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 ditetapkan ke true.
  • AQI lokal. Akan ditampilkan 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 tinggi terhadap polutan, dan populasi umum.