Se usó la API de Cloud Translation para traducir esta página.

Method: forecast.lookup

Solicitud HTTP
Cuerpo de la solicitud
- Representación JSON
Cuerpo de la respuesta
- Representación JSON
Permisos de autorización
HourlyForecast
- Representación JSON

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

Solicitud HTTP

POST https://airquality.googleapis.com/v1/forecast: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

Representación 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 }

{
  "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
}

Campos
`location`	`object (LatLng)` Obligatorio. La latitud y la longitud para las que la API busca datos sobre la calidad del aire.
`extraComputations[]`	`enum (ExtraComputation)` Opcional. Funciones adicionales que se pueden habilitar de manera opcional Especificar cálculos adicionales hará que se devuelvan los elementos y campos relevantes en la respuesta.
`uaqiColorPalette`	`enum (ColorPalette)` Opcional. Determina la paleta de colores que se usa para los datos proporcionados por el "Índice universal de calidad del aire". (UAQI). Esta paleta de colores es relevante solo para el UAQI; otros ICA tienen una paleta de colores predeterminada que no se puede controlar.
`customLocalAqis[]`	`object (CustomLocalAqi)` Opcional. Expresa un "país/región a ICA". relación. Vincula un país o una región con un ICA deseado para que los datos de la calidad del aire necesarios para ese país o región se muestren de acuerdo con el ICA elegido. Este parámetro se puede utilizar para especificar un ICA no predeterminado en un país determinado; por ejemplo, para obtener el índice de la EPA de EE.UU. para Canadá en lugar del índice predeterminado para este país.
`pageSize`	`integer` Opcional. La cantidad máxima de registros de información por hora que se muestran por página (valor predeterminado = 24).
`pageToken`	`string` Opcional. Un token de página recibido de una llamada de previsión anterior. Se usa para recuperar la página siguiente.
`dateTime`	`string (Timestamp format)` Una marca de tiempo para mostrar los datos de un momento específico. La marca de tiempo se redondea a la hora exacta anterior. Se mostrarán solo los datos por hora de 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 esté configurado como 2023-01-03T11:05:49Z se redondeará a 2023-01-03T11:00:00Z. Nota: Se pueden usar `dateTime` o `startTime` y `endTime` en una solicitud.
`period`	`object (Interval)` Indica el período `startTime` y `endTime` para obtener los datos de previsión. El `endTime` es inclusivo. 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 verdadero, el ICA universal se incluirá en los "índices" de la respuesta (predeterminado = true).
`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 dependen del estándar IETF (predeterminado = 'en').

Cuerpo de la respuesta

El objeto de respuesta de la API de previsión de la calidad del aire.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{ "hourlyForecasts": [ { object (`HourlyForecast`) } ], "regionCode": string, "nextPageToken": string }

Campos

Campos
`hourlyForecasts[]`	`object (HourlyForecast)` Opcional. Contiene la información de la calidad del aire para cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de previsión, habrá 48 elementos de previsiones por hora.
`regionCode`	`string` Opcional. El código ISO_3166-1 alpha-2 del país o la región correspondiente a la ubicación proporcionada en la solicitud. Este campo puede omitirse en la respuesta si la ubicación proporcionada en la solicitud se encuentra en un territorio en disputa.
`nextPageToken`	`string` Opcional. El token para recuperar la página siguiente.

hourlyForecasts[]

object (HourlyForecast)

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

regionCode

string

Opcional. El código ISO_3166-1 alpha-2 del país o la región correspondiente a la ubicación proporcionada en la solicitud. Este campo puede omitirse en la respuesta si la ubicación proporcionada en la solicitud se encuentra 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.

HourlyForecast

Contiene la información de la calidad del aire para cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de previsión, habrá 48 elementos de previsiones 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 (hora) a la que hacen referencia los datos en RFC3339 UTC “Zulú” de un conjunto de datos tengan un formato común. Por ejemplo: “2014-10-02T15:00:00Z”.
`indexes[]`	`object (AirQualityIndex)` En función de los parámetros de solicitud, esta lista incluirá (hasta) dos índices de calidad del aire: ICA universal. Se mostrará si el booleano `universalAqi` se establece 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 mostrará solo para las solicitudes que especifiquen uno o más de los siguientes cálculos adicionales: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION o POLLUTANT_CONCENTRATION.
`healthRecommendations`	`object (HealthRecommendations)` Consejos de salud y acciones recomendadas en relación con las condiciones de calidad del aire informadas. Las recomendaciones se adaptan de manera diferente para las poblaciones en riesgo, los grupos con mayor sensibilidad a los contaminantes y la población general.