Menampilkan perkiraan kualitas udara di 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 ( |
Kolom | |
---|---|
location |
Wajib. Lintang dan bujur yang data kualitas udaranya dicari API. |
extraComputations[] |
Opsional. Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menghasilkan elemen dan kolom yang relevan untuk ditampilkan dalam respons. |
uaqiColorPalette |
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[] |
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. |
pageSize |
Opsional. Jumlah maksimum data info per jam yang akan ditampilkan per halaman (default = 24). |
pageToken |
Opsional. Token halaman diterima dari panggilan perkiraan sebelumnya. Ini digunakan untuk mengambil halaman berikutnya. |
dateTime |
Stempel waktu yang digunakan untuk menampilkan data pada titik waktu tertentu. Stempel waktu dibulatkan ke jam persis sebelumnya. Tindakan 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. Catatan: |
period |
Menunjukkan periode Catatan: |
universalAqi |
Opsional. Jika ditetapkan ke true, AQI Universal akan disertakan dalam kolom 'indeks' respons (default = true). |
languageCode |
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 (default = 'en'). |
Isi respons
Objek respons API perkiraan kualitas udara.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"hourlyForecasts": [
{
object ( |
Kolom | |
---|---|
hourlyForecasts[] |
Opsional. Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaan berupa perkiraan selama 48 jam, akan ada 48 elemen perkiraan per jam. |
regionCode |
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 |
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.
HourlyForecast
Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaan berupa perkiraan selama 48 jam, akan ada 48 elemen perkiraan per jam.
Representasi JSON |
---|
{ "dateTime": string, "indexes": [ { object ( |
Kolom | |
---|---|
dateTime |
Stempel waktu yang dibulatkan ke bawah menunjukkan waktu (jam) yang dirujuk data dalam format "Zulu" RFC3339 UTC. Misalnya: "2014-10-02T15:00:00Z". |
indexes[] |
Berdasarkan parameter permintaan, daftar ini akan mencakup (hingga) dua indeks kualitas udara:
|
pollutants[] |
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 |
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. |