Restituisce la previsione della qualità dell'aria per una località specifica in 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 ( |
Campi | |
---|---|
location |
Obbligatorio. La latitudine e la longitudine per cui l'API cerca i dati sulla qualità dell'aria. |
extraComputations[] |
(Facoltativo) Funzionalità aggiuntive che possono essere attivate facoltativamente. Se specifichi calcoli aggiuntivi, gli elementi e i campi pertinenti verranno restituiti nella risposta. |
uaqiColorPalette |
(Facoltativo) consente di determinare la tavolozza dei colori utilizzata per i dati forniti dall'"Indice di qualità dell'aria universale" (UAQI). Questa tavolozza dei colori è pertinente solo per gli UAQI, mentre altri IQA hanno una tavolozza dei colori predeterminata che non può essere controllata. |
customLocalAqis[] |
(Facoltativo) Indica un "paese/regione in IQA" relazione tra utenti. Associa un paese o 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 US EPA per il Canada anziché l'indice predefinito per il Canada. |
pageSize |
(Facoltativo) Il numero massimo di record di informazioni orari da restituire per pagina (valore predefinito = 24). |
pageToken |
(Facoltativo) Un token di pagina ricevuto da una precedente chiamata di previsione. Viene utilizzato per recuperare la pagina successiva. |
dateTime |
Un timestamp per cui restituire i dati relativi a un momento specifico. Il timestamp viene arrotondato all'ora esatta precedente. Verranno restituiti i dati orari solo per il 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: in una richiesta è possibile utilizzare |
period |
Indica il periodo Nota: in una richiesta è possibile utilizzare |
universalAqi |
(Facoltativo) Se impostato su true, l'IQA universale verrà incluso negli "indici" campo della risposta (predefinito = vero). |
languageCode |
(Facoltativo) Consente al client di scegliere la lingua per la risposta. Se non è possibile fornire dati per la lingua, l'API utilizza la corrispondenza più simile. I valori consentiti si basano sullo standard IETF (predefinito = "en"). |
Corpo della risposta
L'oggetto risposta dell'API per le previsioni della qualità dell'aria.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"hourlyForecasts": [
{
object ( |
Campi | |
---|---|
hourlyForecasts[] |
(Facoltativo) Contiene le informazioni sulla qualità dell'aria per ogni ora nell'intervallo richiesto. Ad esempio, se la richiesta riguarda 48 ore di previsione, saranno presenti 48 elementi di previsioni orarie. |
regionCode |
(Facoltativo) Il codice ISO_3166-1 alpha-2 del paese/della regione corrispondente alla località indicata nella richiesta. Questo campo potrebbe essere omesso dalla risposta se la località fornita nella richiesta si trova in un territorio conteso. |
nextPageToken |
(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 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, saranno presenti 48 elementi di previsioni orarie.
Rappresentazione JSON |
---|
{ "dateTime": string, "indexes": [ { object ( |
Campi | |
---|---|
dateTime |
Un timestamp arrotondato per difetto che indica l'ora (ora) a cui si riferiscono i dati nel fuso orario RFC3339 UTC "Zulu" formato. Ad esempio: "2014-10-02T15:00:00Z". |
indexes[] |
In base ai parametri della richiesta, questo elenco includerà (fino a) due indici di qualità dell'aria:
|
pollutants[] |
Un elenco di inquinanti che interessano la località specificata nella richiesta. Nota: questo campo verrà restituito solo per le richieste che specificano uno o più dei seguenti calcoli aggiuntivi: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
healthRecommendations |
Consigli sulla salute e azioni consigliate in relazione alle condizioni di qualità dell'aria segnalate. I consigli vengono adattati in modo diverso in base alle popolazioni a rischio, ai gruppi con una maggiore sensibilità agli inquinanti e alla popolazione generale. |