Method: history.lookup

Muestra el historial de calidad del aire de una ubicación específica durante un período determinado.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "pageSize": integer,
  "pageToken": string,
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "dateTime": string,
  "hours": integer,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Campos
pageSize

integer

Opcional. La cantidad máxima de registros de información por hora que se muestran por página. El valor predeterminado es 72 y el valor máximo es 168 (7 días de datos).

pageToken

string

Opcional. Un token de página recibido de una llamada del historial anterior. Se usa para recuperar la página siguiente.

Ten en cuenta que cuando proporcionas un valor para este parámetro, todos los demás parámetros deben coincidir con la llamada que proporcionó el token de la página (la llamada anterior).

location

object (LatLng)

Obligatorio. La latitud y la longitud para las que la API busca datos históricos de calidad del aire.

extraComputations[]

enum (ExtraComputation)

Opcional. Funciones adicionales que se pueden habilitar de forma opcional Si especificas cálculos adicionales, se mostrarán los elementos y campos relevantes en la respuesta.

uaqiColorPalette

enum (ColorPalette)

Opcional. Determina la paleta de colores que se utiliza para los datos que proporciona el "Índice Universal de Calidad del Aire" (UAQI). Esta paleta de colores es relevante solo para UAQI; otros AQI tienen una paleta de colores predeterminada que no se puede controlar.

customLocalAqis[]

object (CustomLocalAqi)

Opcional. Expresa una relación de “país/región con el índice de calidad de aire”. Vincula un país o una región con un ICA deseado para que se muestren los datos de la calidad del aire necesarios para ese país o región según el ICA elegido. Este parámetro se puede usar para especificar un ICA no predeterminado para un país determinado; por ejemplo, para obtener el índice de la EPA de EE.UU. para Canadá en lugar del índice predeterminado para Canadá.

dateTime

string (Timestamp format)

Una marca de tiempo para la que se deben mostrar los datos históricos. La marca de tiempo se redondea a la hora exacta anterior.

Nota: Esto mostrará datos por hora solo para la marca de tiempo solicitada (es decir, un solo elemento de información por hora). Por ejemplo, una solicitud enviada en la que el parámetro dateTime se establece en 2023-01-03T11:05:49Z se redondeará a 2023-01-03T11:00:00Z.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: “2014-10-02T15:01:23Z” y “2014-10-02T15:01:23.045123456Z”.

Nota: Se pueden usar dateTime o startTime y endTime en una solicitud.

hours

integer

Es un número del 1 al 720 que indica el intervalo de horas de la solicitud. Por ejemplo: El valor 48 proporcionará datos de las últimas 48 horas.

period

object (Interval)

Indica los períodos startTime y endTime para los que se deben obtener los datos históricos. La marca de tiempo se redondea a la hora exacta anterior.

Nota: Se pueden usar dateTime o startTime y endTime en una solicitud.

universalAqi

boolean

Opcional. Si se configura como true, el ICA universal se incluirá en el campo "Índices" de la respuesta. El valor predeterminado es verdadero.

languageCode

string

Opcional. Permite que el cliente elija el idioma de la respuesta. Si no se pueden proporcionar datos para ese idioma, la API usa la coincidencia más cercana. Los valores permitidos se basan en el estándar IETF. El valor predeterminado es "en".

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "hoursInfo": [
    {
      object (HourInfo)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Campos
hoursInfo[]

object (HourInfo)

Opcional. Contiene la información sobre la calidad del aire cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de historial, habrá 48 elementos de información por hora.

regionCode

string

Opcional. El código ISO_3166-1 alpha-2 del país o la región que corresponde a la ubicación proporcionada en la solicitud. Este campo podría omitirse en la respuesta si la ubicación proporcionada en la solicitud reside en un territorio en disputa.

nextPageToken

string

Opcional. El token para recuperar la página siguiente.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

HourInfo

Contiene la información sobre la calidad del aire cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de historial, habrá 48 elementos de información por hora.

Representación JSON
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Campos
dateTime

string (Timestamp format)

Una marca de tiempo redondeada hacia abajo que indica la hora a la que hacen referencia los datos en el formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Por ejemplo: “2014-10-02T15:00:00Z”.

indexes[]

object (AirQualityIndex)

Según los parámetros de la solicitud, esta lista incluirá (hasta) dos índices de calidad del aire:

  • ICA universal. Se mostrará si el valor booleano universalAqi está configurado como verdadero.
  • ICA local. Se mostrará si se especifica el cálculo adicional LOCAL_AQI.
pollutants[]

object (Pollutant)

Una lista de contaminantes que afectan la ubicación especificada en la solicitud. Nota: Este campo se devolverá solo para las solicitudes que especificaron uno o más de los siguientes cálculos adicionales: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.

healthRecommendations

object (HealthRecommendations)

Consejos de salud y acciones recomendadas relacionadas con las condiciones de calidad del aire informadas. Las recomendaciones se adaptan de manera diferente para las poblaciones en riesgo, los grupos más sensibles a los contaminantes y la población general.