Method: history.lookup

Restituisce la cronologia della qualità dell'aria per una località specifica per un determinato intervallo di tempo.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "pageSize": integer,
  "pageToken": string,
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],

  // Union field time_range can be only one of the following:
  "dateTime": string,
  "hours": integer,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Campi
pageSize

integer

Campo facoltativo. Il numero massimo di record di informazioni orari da restituire per pagina. Il valore predefinito è 72 e il valore massimo è 168 (dati di 7 giorni).

pageToken

string

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

Tieni presente che quando fornisci un valore per questo parametro, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token di pagina (la chiamata precedente).

location

object (LatLng)

Obbligatorio. La latitudine e la longitudine per le quali l'API cerca i dati storici sulla qualità dell'aria.

extraComputations[]

enum (ExtraComputation)

Campo facoltativo. Funzionalità aggiuntive che è possibile abilitare 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 gli IQA, mentre gli altri IQA hanno una tavolozza dei colori predeterminata che non può essere controllata.

customLocalAqis[]

object (CustomLocalAqi)

Campo facoltativo. Indica una relazione di tipo "paese/regione rispetto all'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.

Campo di unione time_range. L'intervallo di tempo per i dati richiesti sulla qualità dell'aria. Se non specifichi un campo relativo all'intervallo di tempo, verrà restituito un errore INVALID_ARGUMENT. time_range può essere solo uno dei seguenti: time_range può essere solo uno dei seguenti:
dateTime

string (Timestamp format)

Un timestamp per cui restituire i dati storici. Il timestamp viene arrotondato all'ora esatta precedente.

Nota: verranno restituiti 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.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

hours

integer

Numero da 1 a 720 che indica l'intervallo di ore per la richiesta. Ad esempio: un valore pari a 48 restituirà i dati delle ultime 48 ore.

period

object (Interval)

Indica il periodo di inizio e di fine per il quale ottenere i dati storici. Il timestamp viene arrotondato all'ora esatta precedente.

universalAqi

boolean

Campo facoltativo. Se è impostato su true, l'IQA universale verrà incluso nel campo "Indici" della risposta. Il 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. Il valore predefinito è en.

Corpo della risposta

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

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

object (HourInfo)

Campo facoltativo. Contiene le informazioni sulla qualità dell'aria per ogni ora nell'intervallo richiesto. Ad esempio, se la richiesta riguarda 48 ore di cronologia, ci saranno 48 elementi di informazioni 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à fornita 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 Panoramica di OAuth 2.0.

Intervallo

Rappresenta un intervallo di tempo, codificato come inizio timestamp (incluso) e come fine timestamp (esclusivo).

L'inizio deve essere inferiore o uguale alla fine. Quando l'inizio corrisponde alla fine, l'intervallo è vuoto (non corrisponde a nessun orario). Quando sia l'inizio che la fine non sono specificati, l'intervallo corrisponde a un momento qualsiasi.

Rappresentazione JSON
{
  "startTime": string,
  "endTime": string
}
Campi
startTime

string (Timestamp format)

Campo facoltativo. Inizio inclusivo dell'intervallo.

Se specificato, un timestamp che corrisponde a questo intervallo dovrà essere uguale o successivo all'inizio.

endTime

string (Timestamp format)

Campo facoltativo. Fine dell'intervallo esclusiva.

Se specificato, un timestamp che corrisponde a questo intervallo dovrà essere precedente alla fine.

HourInfo

Contiene le informazioni sulla qualità dell'aria per ogni ora nell'intervallo richiesto. Ad esempio, se la richiesta riguarda 48 ore di cronologia, ci saranno 48 elementi di informazioni 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 a cui fanno riferimento i dati in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Ad esempio: "2014-10-02T15:00:00Z".

indexes[]

object (AirQualityIndex)

In base ai parametri della richiesta, questo elenco includerà (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 aggiuntivo di 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 relazione alle condizioni di qualità dell'aria segnalate. I consigli sono personalizzati in modo diverso per la popolazione a rischio, i gruppi con maggiore sensibilità agli inquinanti e la popolazione generale.