- בקשת HTTP
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התגובה
- היקפי הרשאה
- ForecastDay
- תאריך
- ForecastDayPart
- SunEvents
- MoonEvents
- MoonPhase
הפונקציה מחזירה תחזיות יומיות ל-10 ימים לכל היותר במיקום נתון, החל מהיום הנוכחי.
בקשת HTTP
GET https://weather.googleapis.com/v1/forecast/days:lookup
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
location |
חובה. המיקום שלגביו רוצים לקבל את התחזית היומית. |
unitsSystem |
אופציונלי. מערכת היחידות שבה יש להשתמש לתנאי מזג האוויר שמוחזרים. אם לא תציינו יחידות, תנאי מזג האוויר שיוחזרו יהיו במערכת המטרית (ברירת מחדל = METRIC). |
pageSize |
אופציונלי. מספר הרשומות המקסימלי של תחזיות יומיות שיוחזרו בכל דף – ערך בין 1 ל-10 (כולל). ערך ברירת המחדל הוא 5. |
pageToken |
אופציונלי. טוקן של דף שהתקבל מבקשה קודמת. הוא משמש לאחזור הדף הבא. |
days |
אופציונלי. מגביל את מספר הימים הכולל לאחזור החל מהיום הנוכחי – ערך מ-1 עד 10 (כולל). ערך ברירת המחדל הוא הערך המקסימלי המותר, 10. |
languageCode |
אופציונלי. מאפשר ללקוח לבחור את השפה של התשובה. אם אי אפשר לספק נתונים בשפה הזו, ה-API ישתמש בהתאמה הקרובה ביותר. הערכים המותרים מבוססים על התקן IETF BCP-47. ערך ברירת המחדל הוא en. |
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
תשובה לקריאה לשירות מרוחק (RPC) של days.lookup.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "forecastDays": [ { object ( |
| שדות | |
|---|---|
forecastDays[] |
התחזית היומית מתועדת לפי מספר הימים וגודל הדף שצוינו בבקשה. |
timeZone |
אזור הזמן במיקום המבוקש. |
nextPageToken |
הטוקן לאחזור הדף הבא. |
היקפי הרשאה
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/cloud-platform
ForecastDay
מייצג רשומה של תחזית יומית במיקום נתון.
| ייצוג ב-JSON |
|---|
{ "interval": { object ( |
| שדות | |
|---|---|
interval |
מרווח הזמן ב-UTC שבו מתחיל (כולל) ומסתיים (לא כולל) היום הזה בתחזית. הערה: יום מתחיל בשעה 7:00 בבוקר ומסתיים בשעה 7:00 בבוקר של היום הבא, לפי הזמן המקומי. לדוגמה: אם אזור הזמן המקומי הוא UTC-7, המרווח יתחיל בשעה |
displayDate |
התאריך המקומי באזור הזמן של המיקום (השעה האזרחית) שעבורו מחושבת התחזית היומית הזו. יכול להיות שהשדה הזה ישמש למטרות הצגה בלקוח. |
daytimeForecast |
תחזית תנאי מזג האוויר לחלק היום שבין 7:00 בבוקר ל-7:00 בערב (לפי השעה המקומית). |
nighttimeForecast |
תחזית תנאי מזג האוויר לחלק הלילי של היום (19:00 עד 7:00 ביום הבא, זמן מקומי). |
maxTemperature |
הטמפרטורה המקסימלית (הגבוהה) במהלך היום. |
minTemperature |
הטמפרטורה המינימלית (הנמוכה) במהלך היום. |
feelsLikeMaxTemperature |
הטמפרטורה המורגשת המקסימלית (הגבוהה) במהלך היום. |
feelsLikeMinTemperature |
הטמפרטורה המורגשת המינימלית (הנמוכה) במהלך היום. |
maxHeatIndex |
הטמפרטורה המקסימלית של מדד החום במהלך היום. |
sunEvents |
האירועים שקשורים לשמש (למשל, זריחה, שקיעה). |
moonEvents |
האירועים שקשורים לירח (למשל, זריחת הירח, שקיעת הירח). |
תאריך
מייצג תאריך מלא או חלקי ביומן, כמו יום הולדת. השעה ביום ואזור הזמן צוינו במקום אחר או שהם לא משמעותיים. התאריך הוא ביחס ללוח השנה הגרגוריאני. הערך הזה יכול לייצג את אחת מהאפשרויות הבאות:
- תאריך מלא, עם ערכים שאינם אפס לשנה, לחודש וליום.
- חודש ויום, עם שנה אפסית (לדוגמה, יום נישואין).
- שנה לבד, עם חודש אפס ויום אפס.
- שנה וחודש, עם יום אפס (לדוגמה, תאריך התפוגה של כרטיס אשראי).
סוגים קשורים:
google.type.TimeOfDaygoogle.type.DateTimegoogle.protobuf.Timestamp
| ייצוג ב-JSON |
|---|
{ "year": integer, "month": integer, "day": integer } |
| שדות | |
|---|---|
year |
השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה. |
month |
החודש בשנה. הערך צריך להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום. |
day |
היום בחודש. הערך חייב להיות בין 1 ל-31, והוא צריך להיות תקף לשנה ולחודש, או 0 כדי לציין רק שנה או שנה וחודש שבהם היום לא משמעותי. |
ForecastDayPart
מייצג רשומה של תחזית לחלק מהיום.
| ייצוג ב-JSON |
|---|
{ "interval": { object ( |
| שדות | |
|---|---|
interval |
התאריך והשעה ב-UTC שבהם מתחיל (כולל) ומסתיים (לא כולל) החלק הזה של היום. הערה: חלק מהיום מתחיל בשעה 7:00 ומסתיים בשעה 19:00 באותו יום, לפי הזמן המקומי. לדוגמה: אם אזור הזמן המקומי הוא UTC-7, אז מרווח הזמן של שעות היום יתחיל בשעה |
weatherCondition |
תחזית מזג האוויר. |
precipitation |
התחזית למשקעים. |
wind |
הכיוון הממוצע של הרוח והמהירות המקסימלית של הרוח והמשבים. |
iceThickness |
הכמות המצטברת של הקרח בחלק של היום. |
relativeHumidity |
התחזית של אחוז הלחות היחסית (ערכים מ-0 עד 100). |
uvIndex |
מדד קרינת ה-UV החזוי המקסימלי. |
thunderstormProbability |
הסבירות הממוצעת לסופת רעמים. |
cloudCover |
אחוז הכיסוי הממוצע של העננים. |
SunEvents
מייצג את האירועים שקשורים לשמש (למשל זריחה, שקיעה).
| ייצוג ב-JSON |
|---|
{ "sunriseTime": string, "sunsetTime": string } |
| שדות | |
|---|---|
sunriseTime |
השעה שבה השמש זורחת. הערה: במקרים ייחודיים מסוימים (למשל, צפונית לחוג הארקטי) יכול להיות שלא תהיה שעת זריחה ביום מסוים. במקרים כאלה, השדה הזה לא יוגדר. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
sunsetTime |
השעה שבה השמש שוקעת. הערה: במקרים ייחודיים מסוימים (למשל, צפונית לחוג הארקטי) יכול להיות שלא תהיה שעת שקיעה ביום מסוים. במקרים כאלה, השדה הזה לא יוגדר. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
MoonEvents
מייצג את האירועים שקשורים לירח (למשל, זריחת הירח, שקיעת הירח).
| ייצוג ב-JSON |
|---|
{
"moonriseTimes": [
string
],
"moonsetTimes": [
string
],
"moonPhase": enum ( |
| שדות | |
|---|---|
moonriseTimes[] |
השעה שבה הגפה העליונה של הירח מופיעה מעל האופק (ראו https://en.wikipedia.org/wiki/Moonrise_and_moonset). הערה: ברוב המקרים, תהיה שעת זריחה אחת של הירח בכל יום. במקרים אחרים, הרשימה עשויה להיות ריקה (למשל, כשהירח זורח אחרי חצות של היום הבא). עם זאת, במקרים ייחודיים (למשל באזורים קוטביים), הרשימה עשויה להכיל יותר מערך אחד. במקרים כאלה, הערכים ממוינים בסדר עולה. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
moonsetTimes[] |
השעה שבה הגפה העליונה של הירח נעלמת מתחת לאופק (ראו https://en.wikipedia.org/wiki/Moonrise_and_moonset). הערה: ברוב המקרים, תהיה שעת שקיעה אחת של הירח בכל יום. במקרים אחרים, הרשימה עשויה להיות ריקה (למשל, כשהירח שוקע אחרי חצות של היום הבא). עם זאת, במקרים ייחודיים (למשל באזורים קוטביים), הרשימה עשויה להכיל יותר מערך אחד. במקרים כאלה, הערכים ממוינים בסדר עולה. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
moonPhase |
מופע הירח (נקרא גם שלב הירח). |
MoonPhase
מציין את מופע הירח.
| טיפוסים בני מנייה (enum) | |
|---|---|
MOON_PHASE_UNSPECIFIED |
לא צוין מופע ירח. |
NEW_MOON |
הירח לא מואר על ידי השמש. |
WAXING_CRESCENT |
בחצי הכדור הצפוני, הירח מואר ב-0% עד 50% בצד ימין שלו 🌒, ובחצי הכדור הדרומי הוא מואר ב-0% עד 50% בצד שמאל שלו 🌘. |
FIRST_QUARTER |
בצד ימין של הירח בחצי הכדור הצפוני מואר 50.1% 🌓, ובצד שמאל שלו בחצי הכדור הדרומי מואר 50.1% 🌗. |
WAXING_GIBBOUS |
בצד ימין של הירח בחצי הכדור הצפוני 🌔 ובצד שמאל שלו בחצי הכדור הדרומי 🌖 מוארים 50% עד 100% מהירח. |
FULL_MOON |
הירח מואר באופן מלא. |
WANING_GIBBOUS |
בצד שמאל של הירח בחצי הכדור הצפוני 🌖 ובצד ימין שלו בחצי הכדור הדרומי 🌔 מוארים 50% עד 100% מהירח. |
LAST_QUARTER |
50.1% מהירח מוארים בצד שמאל בחצי הכדור הצפוני 🌗 ובצד ימין בחצי הכדור הדרומי 🌓. |
WANING_CRESCENT |
הירח מואר ב-0% עד 50% בצד שמאל שלו בחצי הכדור הצפוני 🌘 ובצד ימין שלו בחצי הכדור הדרומי 🌒. |