Method: publicAlerts.lookup

返回指定地点的公开天气警报。

HTTP 请求

GET https://weather.googleapis.com/v1/publicAlerts:lookup

网址采用 gRPC 转码语法。

查询参数

参数
location

object (LatLng)

必需。要接收公共天气警报的位置。该服务将返回受影响区域与此位置相交的提醒。

pageSize

integer

可选。每页返回的公共天气警报记录数上限。

pageToken

string

可选。从之前的 publicAlerts.lookup 调用接收的页面令牌。利用其进行后续页面检索。进行分页时,提供给 publicAlerts.lookup 的所有其他参数必须与提供页面令牌的调用相一致。

languageCode

string

可选。允许客户端选择回答的语言。如果无法提供相应语言的数据,API 会使用最接近的匹配项。允许的值取决于 IETF BCP-47 标准。默认值为“en”。

请求正文

请求正文必须为空。

响应正文

针对 publicAlerts.lookup RPC 的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "weatherAlerts": [
    {
      object (PublicAlerts)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
字段
weatherAlerts[]

object (PublicAlerts)

根据请求中指定的提醒数量和页面大小,返回公开天气预警记录。

regionCode

string

与请求中提供的位置对应的地区的 ISO_3166-1 alpha-2 代码。地区使用 ISO_3166-1_alpha-2 表示。

nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

授权范围

需要以下 OAuth 范围:

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

PublicAlerts

表示公共天气警报。

JSON 表示法
{
  "alertId": string,
  "alertTitle": {
    object (LocalizedText)
  },
  "eventType": enum (WeatherEventType),
  "areaName": string,
  "instruction": [
    string
  ],
  "safetyRecommendations": [
    {
      object (SafetyRecommendation)
    }
  ],
  "timezoneOffset": string,
  "startTime": string,
  "expirationTime": string,
  "dataSource": {
    object (DataSource)
  },
  "polygon": string,
  "description": string,
  "severity": enum (Severity),
  "certainty": enum (Certainty),
  "urgency": enum (Urgency)
}
字段
alertId

string

相应提醒的唯一标识符。

alertTitle

object (LocalizedText)

提醒的本地化标题。

eventType

enum (WeatherEventType)

天气事件的类型。

areaName

string

发布提醒的区域的名称。

instruction[]

string

发布商推荐的说明。请注意,虽然此字段应进行本地化,但无法保证一定能实现本地化。

safetyRecommendations[]

object (SafetyRecommendation)

向用户提供的安全建议指令,这些指令可由发布商或其他权威机构提供。

timezoneOffset

string

相应提醒所在位置相对于世界协调时间 (UTC) 的时区偏移量。该值的格式为以“s”结尾的字符串,例如 “-14400s”表示比 UTC 晚 4 小时。

startTime

string (Timestamp format)

活动的开始时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

expirationTime

string (Timestamp format)

活动的到期时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

dataSource

object (DataSource)

发布相应提醒的出版商的详细信息。

polygon

string

发布提醒的区域的 GeoJSON 表示法。

GeoJSON 数据必须采用 RFC 7946 格式,并且表示多边形(对于单个连续区域)或多重多边形(对于多个不同的区域)。

示例:

{ "type": "Polygon", "coordinates": [ [ [-1, -1], [-1, 0], [0, 0], [-1, -1] ] ] }

MultiPolygon GeoJson 字符串的示例如下所示:

{ "type": "MultiPolygon", "coordinates": [ [ [0, 0], [-1, 0], [-1, 1], [0, 0] ], [ [0, 0], [-2, 0], [-2, 2], [0, 0] ] ]

description

string

由官方机构发布的最新提醒说明文本。请注意,虽然此字段应进行本地化,但无法保证一定能实现本地化。

severity

enum (Severity)

提醒的严重程度。

certainty

enum (Certainty)

提醒的确定性。

urgency

enum (Urgency)

提醒的紧急程度。

WeatherEventType

天气事件的类型。

枚举
WEATHER_EVENT_TYPE_UNSPECIFIED 未指定天气事件类型。
ACID_RAIN 酸雨事件。
AFTERSHOCK 余震事件。
AVALANCHE 雪崩事件。
BLIZZARD 暴风雪事件。
BLOWING_SNOW 高吹雪事件。
BUSHFIRE 森林大火事件。
COASTAL_FLOOD 沿海洪水事件。
COASTAL_HAZARD 沿海灾害事件。
COLD 冷事件。
CYCLONE 旋风事件。
DROUGHT 干旱事件。
DUST_STORM 沙尘暴事件。
EARTHQUAKE 地震事件。
EXTRATROPICAL_CYCLONE 温带气旋事件。
FIRE 触发事件。
FIRE_WEATHER 火险天气事件。
FLASH_FLOOD 山洪暴发事件。
FLOOD 洪水事件。
FOG 雾事件。
FREEZING 死机事件。
FREEZING_AIR_TEMPERATURE 空气温度降至冰点事件。
FREEZING_DRIZZLE 冻毛毛雨事件。
FREEZING_RAIN_EVENT 冻雨事件。
FROST 霜冻事件。
GALE 大风事件。
GLAZE 釉面活动。
HAIL 冰雹事件。
HAZARDOUS_SEAS 灾害性海浪事件。
HEAT 热浪事件。
HUMIDITY 湿度事件。
HURRICANE 飓风事件。
ICE_STORM 冰暴事件。
INDUSTRIAL_FIRE 工业火灾事件。
LAKE_EFFECT_SNOW 湖泊效应降雪事件。
LANDSLIDE 滑坡事件。
MONSOON 季风事件。
MUDDY_FLOOD 泥石流事件。
OUTFLOW 流出事件。
RADIATION 辐射事件。
RAIN_EVENT 降雨事件。
RIVER_FLOODING 河流洪灾事件。
SEVERE_THUNDERSTORM_WARNING 严重雷暴警报事件。
SNOWSQUALL 暴风雪事件。
SNOW_EVENT 降雪事件。
STORM 风暴事件。
STORM_SURGE 风暴潮事件。
THUNDER 雷声事件。
THUNDERSTORM 雷暴事件。
TORNADO 龙卷风事件。
TORNADO_WARNING 龙卷风警报事件。
TROPICAL_CYCLONE 热带气旋事件。
TROPICAL_CYCLONE_WARNINGS_AND_WATCHES 热带气旋警告和警戒事件。
TROPICAL_DISTURBANCE 热带扰动事件。
TROPICAL_STORM 热带风暴事件。
TSUNAMI 海啸事件。
TYPHOON 台风事件。
VOLCANIC_ASH 火山灰事件。
VOLCANIC_ERUPTION 火山喷发事件。
WILDFIRE 野火事件。
WIND 风事件。
WIND_CHILL 风寒效应事件。
WIND_WAVE 风浪事件。
WINTER_STORM 冬季风暴事件。

严重程度

表示警报消息的主题事件严重程度的代码。

枚举
SEVERITY_UNKNOWN 严重程度未知。
EXTREME 生命或财产面临非同寻常的威胁。
SEVERE 生命或财产受到严重威胁。
MODERATE 可能会危及生命或财产。
MINOR 生命或财产受到轻微威胁。

确定性

表示警报消息的主题事件的确定性的代码。

枚举
CERTAINTY_UNKNOWN 确定性未知。
OBSERVED 确定已发生或正在发生。
VERY_LIKELY 很有可能。
LIKELY 可能性高(p > ~50%)。
POSSIBLE 可能,但不太可能(p <= ~50%)。
UNLIKELY 不太可能(p ~ 0%)。

紧急情况

表示警报消息的主题事件的紧急程度的代码。

枚举
URGENCY_UNKNOWN 紧急程度未知。
IMMEDIATE 应立即采取响应措施。
EXPECTED 应尽快(在下一小时内)采取响应措施。
FUTURE 应在不久的将来采取响应措施。
PAST 不再需要采取响应措施。

SafetyRecommendation

表示安全建议。

JSON 表示法
{
  "directive": string,
  "subtext": string
}
字段
directive

string

面向用户的指令。请注意,虽然此字段应进行本地化,但无法保证一定能实现本地化。

subtext

string

指令的可选子文本,可能包含用户的其他背景信息。请注意,虽然此字段应进行本地化,但无法保证一定能实现本地化。

DataSource

表示指向数据源的链接。

JSON 表示法
{
  "publisher": enum (Publisher),
  "name": string,
  "authorityUri": string
}
字段
publisher

enum (Publisher)

提醒的发布者。

name

string

官方发布商名称。请注意,虽然此字段应进行本地化,但无法保证一定能实现本地化。

authorityUri

string

相应机构网站的网址。

发布商

提醒的发布者。

枚举
PUBLISHER_UNSPECIFIED 发布商未指定。
AUSTRALIA_ACT_ESA 澳大利亚澳大利亚首都领地
AUSTRALIA_NSW_RFS 新南威尔士
AUSTRALIA_QLD_QFES 昆士兰州
AUSTRALIA_SA_CFS 南澳大利亚
METEO_ALARM_AT Meteoalarm / EUMETNET Austria
METEO_ALARM_BS 波斯尼亚
BRAZIL_CENAD 巴西灾难机构(巴西)
BRAZIL_INMET 巴西气象机构
UK_ENV_AGENCY 英国
METEO_ALARM_BG Meteoalarm / EUMETNET Bulgaria
METEO_ALARM_CR 克罗地亚
METEO_ALARM_CY 塞浦路斯
METEO_ALARM_CS 捷克
METEO_ALARM_DK 丹麦
EC_INAMHI 厄瓜多尔
METEO_ALARM_FI Meteoalarm / EUMETNET Finland
METEO_ALARM_FR 法国
DE_DWD 德国
METEO_ALARM_GB Meteoalarm / EUMETNET 英国
METEO_ALARM_GR 希腊
METEO_ALARM_HU 匈牙利
METEO_ALARM_IS 冰岛
METEO_ALARM_IE 爱尔兰
METEO_ALARM_IT 意大利
JM_JMS 牙买加
JMA 日本
METEO_ALARM_NL Meteoalarm / EUMETNET 荷兰
METEO_ALARM_LV 拉脱维亚
METEO_ALARM_LT 立陶宛
METEO_ALARM_LU 卢森堡
MEXICO_CIRES 墨西哥墨西哥 CIRES
NZ_GEONET 新西兰新西兰 GeoNet
NZ_NMS MetService
METEO_ALARM_MK Meteoalarm / EUMETNET 北马其顿
METEO_ALARM_NO 挪威
PHILIPPINES_PAGASA 菲律宾
METEO_ALARM_PL Meteoalarm / EUMETNET 波兰
METEO_ALARM_PT 葡萄牙
METEO_ALARM_RO 罗马尼亚
METEO_ALARM_RS 塞尔维亚
SG_MSS 新加坡
METEO_ALARM_SK Meteoalarm / EUMETNET 斯洛伐克
METEO_ALARM_SI 斯洛文尼亚
SB_MET 所罗门群岛
METEO_ALARM_ES Meteoalarm / EUMETNET 西班牙
METEO_ALARM_SE 瑞典
METEO_ALARM_CH 瑞士
TAIWAN_NCDR 台湾
NOAA 美国国家海洋和大气管理局 (NOAA)
WCATWC 国家海啸预警中心