Method: forecast.lookup

Restituisce una previsione sulla qualità dell'aria per una località specifica per un determinato intervallo di tempo.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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
}
Campi
location

object (LatLng)

Obbligatoria. La latitudine e la longitudine per le quali l'API cerca i dati sulla qualità dell'aria.
extraComputations[]

enum (ExtraComputation)

Campo facoltativo. Funzionalità aggiuntive che possono essere abilitate facoltativamente. Se specifichi calcoli aggiuntivi, nella risposta verranno restituiti gli elementi e i campi pertinenti.
uaqiColorPalette

enum (ColorPalette)

Campo facoltativo. Consente di stabilire la tavolozza dei colori utilizzata per i dati forniti dall 'indice di qualità dell'aria universale (UAQI). Questa tavolozza dei colori è pertinente solo per l'UAQI, mentre gli altri IQA hanno una tavolozza dei colori predeterminata che non può essere controllata.
customLocalAqis[]

object (CustomLocalAqi)

Campo facoltativo. Indica la relazione tra "paese/regione e l'IQA". Associa un paese/una regione all'IQA desiderato in modo che i dati sulla qualità dell'aria richiesti per quel paese/regione vengano visualizzati in base all'IQA scelto. Questo parametro può essere utilizzato per specificare un IQA non predefinito per un determinato paese, ad esempio per ottenere l'indice EPA degli Stati Uniti per il Canada anziché l'indice predefinito per il Canada.
pageSize

integer

Campo facoltativo. Il numero massimo di record di informazioni orarie da restituire per pagina (valore predefinito = 24).
pageToken

string

Campo facoltativo. Un token di pagina ricevuto da una precedente chiamata di previsione. Viene utilizzato per recuperare la pagina successiva.
dateTime

string (Timestamp format)

Un timestamp per il quale restituire i dati per un momento specifico. Il timestamp viene arrotondato all'ora esatta precedente.

Verranno restituiti i dati orari relativi solo al timestamp richiesto (ovvero un singolo elemento informativo orario). Ad esempio, una richiesta inviata in cui il parametro dateTime è impostato su 2023-01-03T11:05:49Z verrà arrotondata per difetto a 2023-01-03T11:00:00Z.

Nota: è possibile utilizzare dateTime o startTime e endTime in una richiesta.
period

object (Interval)

Indica il periodo startTime e endTime per cui ottenere i dati di previsione. La tariffa (endTime) è inclusa. Il timestamp viene arrotondato all'ora esatta precedente.

Nota: è possibile utilizzare dateTime o startTime e endTime in una richiesta.
universalAqi

boolean

Campo facoltativo. Se è impostato su true, l'IQA universale verrà incluso nel campo "Indici" della risposta (valore predefinito = true).
languageCode

string

Campo facoltativo. Consente al client di scegliere la lingua per la risposta. Se non è possibile fornire dati per quella lingua, l'API utilizza la corrispondenza più vicina. I valori consentiti si basano sullo standard IETF (predefinito = "en").

Corpo della risposta

L'oggetto risposta dell'API di previsione della qualità dell'aria.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

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

object (HourlyForecast)

Campo facoltativo. Contiene le informazioni sulla qualità dell'aria per ogni ora nell'intervallo richiesto. Ad esempio, se la richiesta riguarda 48 ore di previsione, ci saranno 48 elementi di previsioni orarie.
regionCode

string

Campo facoltativo. Il codice ISO_3166-1 alpha-2 del paese o della regione corrispondente alla località fornita nella richiesta. Questo campo potrebbe essere omesso dalla risposta se la località specificata nella richiesta si trova in un territorio conteso.
nextPageToken

string

Campo facoltativo. Il token per recuperare la pagina successiva.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la pagina Panoramica di OAuth 2.0.

HourlyForecast

Contiene le informazioni sulla qualità dell'aria per ogni ora nell'intervallo richiesto. Ad esempio, se la richiesta riguarda 48 ore di previsione, ci saranno 48 elementi di previsioni orarie.

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

string (Timestamp format)

Un timestamp arrotondato per difetto che indica l'ora (ora) a cui fanno riferimento i dati nel formato "Zulu" UTC RFC3339. Ad esempio: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

In base ai parametri della richiesta, questo elenco include (fino a) due indici di qualità dell'aria:

  • IQA universale. Viene restituito se il valore booleano universalAqi è impostato su true.
  • IQA locale. Viene restituito se viene specificato il calcolo extra LOCAL_AQI.
pollutants[]

object (Pollutant)

Un elenco di inquinanti che interessano la località specificata nella richiesta.

Nota: questo campo verrà restituito solo per le richieste che specificavano uno o più dei seguenti calcoli aggiuntivi: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

Consigli sulla salute e azioni consigliate in merito alle condizioni della qualità dell'aria segnalate. Le raccomandazioni vengono adattate in modo diverso alla popolazione a rischio, ai gruppi con maggiore sensibilità agli inquinanti e alla popolazione generale.