Method: forecast.lookup

Belirli bir zaman aralığı için belirli bir konumla ilgili hava kalitesi tahminini döndürür.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "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
}
Alanlar
location

object (LatLng)

Zorunlu. API'nin hava kalitesi verilerini aradığı enlem ve boylam.
extraComputations[]

enum (ExtraComputation)

İsteğe bağlı. İsteğe bağlı olarak etkinleştirilebilen ek özellikler. Ek hesaplamalar belirtmek, ilgili öğelerin ve alanların yanıtta döndürülmesini sağlar.
uaqiColorPalette

enum (ColorPalette)

İsteğe bağlı. "Evrensel Hava Kalitesi İndeksi" tarafından sağlanan veriler için kullanılan renk paletini belirler (UAQI). Bu renk paleti yalnızca UAQI ile ilgilidir. Diğer HKİ'lerin kontrol edilemeyen önceden belirlenmiş bir renk paleti vardır.
customLocalAqis[]

object (CustomLocalAqi)

İsteğe bağlı. "HKİ'ye ülke/bölge" ifade eder ilişkilidir. Bir ülkeyi/bölgeyi istenen HKİ ile eşleştirir. Böylece, o ülke/bölge için gerekli olan hava kalitesi verileri, seçilen HKİ'ye göre görüntülenir. Bu parametre, belirli bir ülke için varsayılan olmayan bir HKİ belirtmek amacıyla kullanılabilir. Örneğin, bu parametre Kanada için varsayılan dizin yerine Kanada için ABD EPA dizinini almak amacıyla kullanılabilir.
pageSize

integer

İsteğe bağlı. Sayfa başına döndürülecek maksimum saatlik bilgi kaydı sayısı (varsayılan = 24).
pageToken

string

İsteğe bağlı. Önceki bir tahmin çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için kullanılır.
dateTime

string (Timestamp format)

Belirli bir zamana ait verilerin döndürüleceği zaman damgası. Zaman damgası, önceki tam saate yuvarlanır.

Bu, yalnızca istenen zaman damgası için saatlik verileri (ör. tek bir saatlik bilgi öğesi) döndürür. Örneğin, dateTime parametresinin 2023-01-03T11:05:49Z olarak ayarlandığı bir istek, 2023-01-03T11:00:00Z değerine yuvarlanır.

Not: İstekte dateTime veya startTime ve endTime kullanılabilir.
period

object (Interval)

Tahmin verilerinin alınacağı startTime ve endTime dönemini belirtir. endTime, kapsayıcıdır. Zaman damgası, önceki tam saate yuvarlanır.

Not: İstekte dateTime veya startTime ve endTime kullanılabilir.
universalAqi

boolean

İsteğe bağlı. Doğru değerine ayarlanırsa Evrensel HKİ, "dizinlere" eklenir alanına (varsayılan = doğru) girin.
languageCode

string

İsteğe bağlı. İstemcinin yanıtın dilini seçmesine izin verir. Bu dil için veri sağlanamıyorsa API en yakın eşleşmeyi kullanır. İzin verilen değerler IETF standardına dayanır (varsayılan = 'en').

Yanıt gövdesi

Hava kalitesi tahmini API'sinin yanıt nesnesi.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Alanlar
hourlyForecasts[]

object (HourlyForecast)

İsteğe bağlı. İstenen aralıktaki her saat için hava kalitesi bilgilerini içerir. Örneğin, istek 48 saatlik tahmin içinse 48 saatlik tahminler öğesi olacaktır.
regionCode

string

İsteğe bağlı. İstekte sağlanan konuma karşılık gelen ülkenin/bölgenin ISO_3166-1 alpha-2 kodu. İstekte belirtilen konum itiraz edilen bir bölgedeyse bu alan yanıttan çıkarılabilir.
nextPageToken

string

İsteğe bağlı. Sonraki sayfayı alma jetonu.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview (OAuth 2.0'a Genel Bakış) sayfasına göz atın.

HourlyForecast

İstenen aralıktaki her saat için hava kalitesi bilgilerini içerir. Örneğin, istek 48 saatlik tahmin içinse 48 saatlik tahminler öğesi olacaktır.

JSON gösterimi 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Alanlar
dateTime

string (Timestamp format)

RFC3339 UTC "Zulu" bölümünde verilerin belirttiği zamanı (saat) gösteren aşağı yuvarlanmış bir zaman damgası biçimindedir. Örneğin: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

İstek parametrelerine bağlı olarak bu liste (en fazla) iki hava kalitesi indeksi içerecektir:

  • Evrensel HKİ. universalAqi boole değeri doğru olarak ayarlanırsa döndürülür.
  • Yerel HKİ. LOCAL_AQI ek hesaplaması belirtilirse döndürülür.
pollutants[]

object (Pollutant)

İstekte belirtilen konumu etkileyen kirliliğe yol açan maddelerin listesi.

Not: Bu alan yalnızca şu ek hesaplamalardan bir veya daha fazlasının belirtildiği istekler için döndürülür: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

Bildirilen hava kalitesi koşullarıyla ilgili sağlık önerileri ve önerilen işlemler. Öneriler; risk altındaki popülasyonlar, kirliliğe yol açan maddelere karşı hassasiyeti daha yüksek olan gruplar ve genel nüfus için farklı şekilde uyarlanır.