Method: publicAlerts.lookup

הפונקציה מחזירה התראות ציבוריות לגבי מזג האוויר במיקום נתון.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
location

object (LatLng)

חובה. המיקום שעבורו רוצים לקבל התראות ציבוריות על מזג האוויר. השירות יחזיר התראות שהאזור המושפע שלהן מצטלב עם המיקום הזה.
pageSize

integer

אופציונלי. המספר המקסימלי של רשומות של התראות מזג אוויר ציבוריות שיוחזרו בכל דף.
pageToken

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של publicAlerts.lookup. צריך להזין את הטוקן כדי לאחזר את הדף הבא. כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-publicAlerts.lookup חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
languageCode

string

אופציונלי. מאפשר ללקוח לבחור את השפה של התשובה. אם אי אפשר לספק נתונים בשפה הזו, ה-API ישתמש בהתאמה הקרובה ביותר. הערכים המותרים מבוססים על התקן IETF BCP-47. ערך ברירת המחדל הוא en.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תשובה לקריאה לשירות מרוחק (RPC) של publicAlerts.lookup.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-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" לציון 4 שעות אחרי שעון UTC.
startTime

string (Timestamp format)

שעת ההתחלה של האירוע.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של 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 ושימוש ב-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 ולייצג פוליגון (לאזור רציף יחיד) או MultiPolygon (למספר אזורים נפרדים).

דוגמה:

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

סוג אירוע מזג האוויר.

טיפוסים בני מנייה (enum)
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 אירוע של סופת חורף.

מידת החומרה

הקוד שמציין את רמת החומרה של האירוע שקשור להודעת ההתראה.

טיפוסים בני מנייה (enum)
SEVERITY_UNKNOWN דרגת החומרה לא ידועה.
EXTREME סכנה יוצאת דופן לנפש או לרכוש.
SEVERE סכנה משמעותית לחיים או לרכוש.
MODERATE סכנה אפשרית לחיים או לרכוש.
MINOR סכנה קלה לנפש או לרכוש.

ודאות

הקוד שמציין את רמת הוודאות של אירוע הנושא בהודעת ההתראה.

טיפוסים בני מנייה (enum)
CERTAINTY_UNKNOWN רמת הוודאות לא ידועה.
OBSERVED נקבע שהאירוע התרחש או שהוא מתרחש כרגע.
VERY_LIKELY סביר מאוד.
LIKELY סביר (p > ~50%).
POSSIBLE אפשרי אבל לא סביר (p <= ~50%).
UNLIKELY סביר להניח שלא (p ~ 0%).

דחיפות

הקוד שמציין את הדחיפות של אירוע הנושא בהודעת ההתראה.

טיפוסים בני מנייה (enum)
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

כתובת האתר של הרשות.

בעל תוכן דיגיטלי

המוציא לאור של ההתראה.

טיפוסים בני מנייה (enum)
PUBLISHER_UNSPECIFIED לא צוין בעל תוכן דיגיטלי.
AUSTRALIA_ACT_ESA אוסטרליה טריטוריית הבירה האוסטרלית
AUSTRALIA_NSW_RFS ניו סאות' ויילס
AUSTRALIA_QLD_QFES Queensland
AUSTRALIA_SA_CFS דרום אוסטרליה
METEO_ALARM_AT Meteoalarm / EUMETNET Austria
METEO_ALARM_BS בוסניה
BRAZIL_CENAD Brazil Disaster Agency בברזיל
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 Great Britain
METEO_ALARM_GR יוון
METEO_ALARM_HU הונגריה
METEO_ALARM_IS איסלנד
METEO_ALARM_IE אירלנד
METEO_ALARM_IT איטליה
JM_JMS ג'מייקה
JMA יפן
METEO_ALARM_NL Meteoalarm / EUMETNET Netherlands
METEO_ALARM_LV לטביה
METEO_ALARM_LT ליטא
METEO_ALARM_LU לוקסמבורג
MEXICO_CIRES מקסיקו מקסיקו CIRES
NZ_GEONET ניו זילנד New Zealand GeoNet
NZ_NMS MetService
METEO_ALARM_MK Meteoalarm / EUMETNET North Macedonia
METEO_ALARM_NO נורווגיה
PHILIPPINES_PAGASA הפיליפינים
METEO_ALARM_PL Meteoalarm / EUMETNET Poland
METEO_ALARM_PT פורטוגל
METEO_ALARM_RO רומניה
METEO_ALARM_RS סרביה
SG_MSS סינגפור
METEO_ALARM_SK Meteoalarm / EUMETNET Slovakia
METEO_ALARM_SI סלובניה
SB_MET איי שלמה
METEO_ALARM_ES Meteoalarm / EUMETNET Spain
METEO_ALARM_SE שוודיה
METEO_ALARM_CH שווייץ
TAIWAN_NCDR טאיוואן
NOAA ‫NOAA בארצות הברית
WCATWC National Tsunami Warning Center