- בקשת HTTP
- פרמטרים של שאילתות
- גוף הבקשה
- גוף התגובה
- היקפי הרשאה
- ForecastDay
- תאריך
- ForecastDayPart
- SunEvents
- MoonEvents
- MoonPhase
הפונקציה מחזירה עד 10 תחזיות יומיות במיקום נתון, החל מהיום הנוכחי.
בקשת HTTP
GET https://weather.googleapis.com/v1/forecast/days:lookup
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
location |
חובה. המיקום שבו רוצים לקבל את התחזית היומית. |
units |
זה שינוי אופציונלי. מערכת היחידות שבה נעשה שימוש לתנאי מזג האוויר שמוחזרים. אם לא יצוין ערך, תנאי מזג האוויר שיוחזרו יהיו לפי השיטה המטרית (ברירת המחדל = METRIC). |
page |
זה שינוי אופציונלי. המספר המקסימלי של רשומות של תחזיות יומיות שיוחזר בכל דף – ערך בין 1 ל-10 (כולל). ערך ברירת המחדל הוא 5. |
page |
זה שינוי אופציונלי. אסימון דף שהתקבל מבקשה קודמת. הוא משמש לאחזור הדף הבא. |
days |
זה שינוי אופציונלי. הגבלת מספר הימים הכולל לאחזור, החל מהיום הנוכחי – ערך בין 1 ל-10 (כולל). ערך ברירת המחדל הוא הערך המקסימלי המותר, 10. |
language |
זה שינוי אופציונלי. מאפשרת ללקוח לבחור את שפת התגובה. אם לא ניתן לספק נתונים בשפה הזו, המערכת תשתמש בהתאמה הקרובה ביותר ב-API. הערכים המותרים מבוססים על תקן IETF BCP-47. ערך ברירת המחדל הוא 'en'. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התגובה של ה-RPC days.lookup.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{ "forecastDays": [ { object ( |
שדות | |
---|---|
forecast |
תחזית היומית מתועדת בהתאם למספר הימים ולגודל הדף שצוינו בבקשה. |
time |
אזור הזמן במיקום המבוקש. |
next |
האסימון לאחזור הדף הבא. |
היקפי הרשאה
נדרשת הרשאת OAuth ברמה הבאה:
https://www.googleapis.com/auth/cloud-platform
ForecastDay
שדה שמייצג רשומת תחזית יומית במיקום נתון.
ייצוג ב-JSON |
---|
{ "interval": { object ( |
שדות | |
---|---|
interval |
מרווח הזמן בפורמט UTC שבו היום הזה מתחיל (כולל) ומסתיים (לא כולל). הערה: יום מתחיל בשעה 7:00 ונגמר בשעה 7:00 ביום העוקב, לפי השעון המקומי. לדוגמה: אם אזור הזמן המקומי הוא UTC-7, מרווח הזמן יתחיל בשעה |
display |
התאריך המקומי באזור הזמן של המיקום (לפי שעון אזרחי) שבו התחזית היומית הזו מחושבת. יכול להיות שהשדה הזה ישמש למטרות תצוגה אצל הלקוח. |
daytime |
תנאי מזג האוויר הצפויים במהלך היום (7:00 עד 19:00 לפי השעון המקומי). |
nighttime |
תנאי מזג האוויר הצפויים בשעות הלילה (19:00 עד 7:00 בבוקר של היום הבא, לפי השעון המקומי). |
max |
הטמפרטורה המקסימלית (הגבוהה) במהלך היום. |
min |
הטמפרטורה המינימלית (הנמוכה) במהלך היום. |
feels |
הטמפרטורה המורגשת המקסימלית (הגבוהה) במהלך היום. |
feels |
הטמפרטורה המורגשת המינימלית (הנמוכה) במהלך היום. |
max |
הטמפרטורה המקסימלית של מדד החום במהלך היום. |
sun |
האירועים שקשורים לשמש (למשל, זריחה, שקיעה). |
moon |
האירועים שקשורים לירח (למשל: זריחת ירח, שקיעת ירח). |
ice |
כמות הקרח שנצברה במהלך היום כולו. |
תאריך
מייצג תאריך קלנדרי מלא או חלקי, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שהם לא חשובים. התאריך מתייחס ליומן הגרגוריאני. הערך הזה יכול לייצג אחת מהאפשרויות הבאות:
- תאריך מלא, עם ערכים שאינם אפס לשנה, לחודש וליום.
- חודש ויום, עם אפס בשנה (לדוגמה, יום נישואין).
- שנה לבד, עם אפס חודש ואפס יום.
- שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגת תוקף של כרטיס אשראי).
סוגים קשורים:
google.type.TimeOfDay
google.type.DateTime
google.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, מרווח הזמן בשעות היום יתחיל בשעה |
weather |
תנאי מזג האוויר הצפויים. |
precipitation |
כמות המשקעים הצפויה. |
wind |
כיוון הרוח הממוצע, המהירות המקסימלית והמשב המקסימלי. |
relative |
אחוז הלחות היחסית הצפוי (ערכים מ-0 עד 100). |
uv |
מדד הקרינה האולטרה סגולה (UV) המקסימלי הצפוי. |
thunderstorm |
הסבירות הממוצעת לסופת רעמים. |
cloud |
אחוז כיסוי השמיים הממוצע בעננים. |
SunEvents
מייצג את האירועים שקשורים לשמש (למשל, זריחה, שקיעה).
ייצוג ב-JSON |
---|
{ "sunriseTime": string, "sunsetTime": string } |
שדות | |
---|---|
sunrise |
השעה שבה השמש זורחת. הערה: במקרים ייחודיים מסוימים (למשל, צפונית לחוג הארקטי), יכול להיות שלא יהיה זמן זריחה ביום מסוים. במקרים כאלה, השדה הזה לא יוגדר. הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: |
sunset |
השעה שבה השמש שוקעת. הערה: במקרים ייחודיים מסוימים (למשל, צפונית לחוג הארקטי), יכול להיות שלא יהיה זמן שקיעה ביום מסוים. במקרים כאלה, השדה הזה לא יוגדר. הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: |
MoonEvents
מייצג את האירועים הקשורים לירח (למשל, זריחת הירח, שקיעתו).
ייצוג ב-JSON |
---|
{
"moonriseTimes": [
string
],
"moonsetTimes": [
string
],
"moonPhase": enum ( |
שדות | |
---|---|
moonrise |
השעה שבה הקצה העליון של הירח מופיע מעל האופק (מידע נוסף זמין בכתובת https://en.wikipedia.org/wiki/Moonrise_and_moonset). הערה: ברוב המקרים, יהיה זמן אחד ביום שבו הירח ייראה. במקרים אחרים, הרשימה עשויה להיות ריקה (למשל, כשהירח זורח אחרי חצות של היום הבא). עם זאת, במקרים ייחודיים (למשל באזורים הקוטביים), הרשימה עשויה להכיל יותר מערך אחד. במקרים כאלה, הערכים ממוינים בסדר עולה. הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: |
moonset |
השעה שבה הקצה העליון של הירח נעלם מתחת לאופק (מידע נוסף זמין בכתובת https://en.wikipedia.org/wiki/Moonrise_and_moonset). הערה: ברוב המקרים, יהיה רק זמן אחד ביום שבו הירח ייעלם. במקרים אחרים, יכול להיות שהרשימה תהיה ריקה (למשל, כשהירח שוקע אחרי חצות של היום הבא). עם זאת, במקרים ייחודיים (למשל באזורים הקוטביים), הרשימה עשויה להכיל יותר מערך אחד. במקרים כאלה, הערכים ממוינים בסדר עולה. הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: |
moon |
שלב הירח (נקרא גם מופע הירח). |
MoonPhase
סימון של שלב הירח (נקרא גם 'שלב ירחי').
טיפוסים בני מנייה (enum) | |
---|---|
MOON_PHASE_UNSPECIFIED |
שלב הירח לא צוין. |
NEW_MOON |
הירח לא מואר על ידי השמש. |
WAXING_CRESCENT |
הירח מואר ב-0% עד 50% בצד ימין שלו בחצי הכדור הצפוני 🌒 ובצד שמאל שלו בחצי הכדור הדרומי 🌘. |
FIRST_QUARTER |
הירח מואר ב-50.1% בצד ימין שלו בחצי הכדור הצפוני 🌓 ובצד ימין שלו בחצי הכדור הדרומי 🌗. |
WAXING_GIBBOUS |
הירח מואר ב-50%-100% בצד ימין שלו בחצי הכדור הצפוני 🌔 ובצד ימין שלו בחצי הכדור הדרומי 🌖. |
FULL_MOON |
הירח מואר במלואו. |
WANING_GIBBOUS |
הירח מואר ב-50%-100% בצד שמאל שלו בחצי הכדור הצפוני 🌖 ובצד ימין שלו בחצי הכדור הדרומי 🌔. |
LAST_QUARTER |
הירח מואר ב-50.1% בצד ימין בחצי הכדור הצפוני 🌗 ובצד ימין בחצי הכדור הדרומי 🌓. |
WANING_CRESCENT |
הירח מואר ב-0% עד 50% בצד שמאל שלו בחצי הכדור הצפוני 🌘 ובצד ימין שלו בחצי הכדור הדרומי 🌒. |