LookupForecastRequest

import type { LookupForecastRequest } from "https://googleapis.deno.dev/v1/airquality:v1.ts";

The request object of the air quality forecast API.

interface LookupForecastRequest {

customLocalAqis?: CustomLocalAqi[];

dateTime?: Date;

extraComputations?:

| "EXTRA_COMPUTATION_UNSPECIFIED"

| "LOCAL_AQI"

| "HEALTH_RECOMMENDATIONS"

| "POLLUTANT_ADDITIONAL_INFO"

| "DOMINANT_POLLUTANT_CONCENTRATION"

| "POLLUTANT_CONCENTRATION"[];

languageCode?: string;

location?: LatLng;

pageSize?: number;

pageToken?: string;

period?: Interval;

uaqiColorPalette?:

| "COLOR_PALETTE_UNSPECIFIED"

| "RED_GREEN"

| "INDIGO_PERSIAN_DARK"

| "INDIGO_PERSIAN_LIGHT";

universalAqi?: boolean;

}

§Properties

customLocalAqis?: CustomLocalAqi[]

[src]

Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada.

dateTime?: Date

[src]

A timestamp for which to return the data for a specific point in time. The timestamp is rounded to the previous exact hour. Note: this will return hourly data for the requested timestamp only (i.e. a single hourly info element). For example, a request sent where the date_time parameter is set to 2023-01-03T11:05:49Z will be rounded down to 2023-01-03T11:00:00Z.

[src]

Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response.

languageCode?: string

[src]

Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard (default = 'en').

location?: LatLng

[src]

Required. The latitude and longitude for which the API looks for air quality data.

pageSize?: number

[src]

Optional. The maximum number of hourly info records to return per page (default = 24).

pageToken?: string

[src]

Optional. A page token received from a previous forecast call. It is used to retrieve the subsequent page.

period?: Interval

[src]

Indicates the start and end period for which to get the forecast data. The timestamp is rounded to the previous exact hour.

uaqiColorPalette?: "COLOR_PALETTE_UNSPECIFIED" | "RED_GREEN" | "INDIGO_PERSIAN_DARK" | "INDIGO_PERSIAN_LIGHT"

[src]

Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled.

universalAqi?: boolean

[src]

Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response (default = true).