Class LookupForecastRequest

The request object of the air quality forecast API.

Inheritance
object
LookupForecastRequest
Implements
Inherited Members
Namespace: Google.Apis.AirQuality.v1.Data
Assembly: Google.Apis.AirQuality.v1.dll
Syntax
public class LookupForecastRequest : IDirectResponseSchema

Properties

CustomLocalAqis

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.

Declaration
[JsonProperty("customLocalAqis")]
public virtual IList<CustomLocalAqi> CustomLocalAqis { get; set; }
Property Value
Type Description
IList<CustomLocalAqi>

DateTime

object representation of DateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DateTimeDateTimeOffset instead.")]
public virtual object DateTime { get; set; }
Property Value
Type Description
object

DateTimeDateTimeOffset

DateTimeOffset representation of DateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DateTimeRaw

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.

Declaration
[JsonProperty("dateTime")]
public virtual string DateTimeRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExtraComputations

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.

Declaration
[JsonProperty("extraComputations")]
public virtual IList<string> ExtraComputations { get; set; }
Property Value
Type Description
IList<string>

LanguageCode

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').

Declaration
[JsonProperty("languageCode")]
public virtual string LanguageCode { get; set; }
Property Value
Type Description
string

Location

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

Declaration
[JsonProperty("location")]
public virtual LatLng Location { get; set; }
Property Value
Type Description
LatLng

PageSize

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

Declaration
[JsonProperty("pageSize")]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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

Declaration
[JsonProperty("pageToken")]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Period

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

Declaration
[JsonProperty("period")]
public virtual Interval Period { get; set; }
Property Value
Type Description
Interval

UaqiColorPalette

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.

Declaration
[JsonProperty("uaqiColorPalette")]
public virtual string UaqiColorPalette { get; set; }
Property Value
Type Description
string

UniversalAqi

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

Declaration
[JsonProperty("universalAqi")]
public virtual bool? UniversalAqi { get; set; }
Property Value
Type Description
bool?

Implements