דף זה תורגם על ידי Cloud Translation API.

שיטות מומלצות לשימוש ב-Street View Static API

ממשקי ה-API הסטטיים באינטרנט של הפלטפורמה של מפות Google הם אוסף של ממשקי HTTP לשירותי Google שיוצרים תמונות שאפשר להטמיע ישירות בדף האינטרנט.

שירותי האינטרנט של הפלטפורמה של מפות Google הם אוסף של ממשקי HTTP לשירותי Google שמספקים נתונים גיאוגרפיים לאפליקציות של המפות שלכם.

במדריך הזה מתוארות כמה שיטות נפוצות שמועילות להגדרת בקשות לתמונות ולעיבוד תגובות לשירותי אינטרנט. התיעוד המלא של Street View Static API זמין במדריך למפתחים.

ה-API הסטטי של Street View מתנהג כמו API סטטי לאינטרנט, אבל אפשר להתייחס לשירות המטא-נתונים בתור שירות אינטרנט. למידע נוסף על שירות המטא-נתונים, קראו את המאמר מטא-נתונים של תמונות ב-Street View.

מה זה Static Web API?

ממשקי ה-API הסטטיים באינטרנט של הפלטפורמה של מפות Google מאפשרים להטמיע תמונה של מפות Google בדף האינטרנט שלכם, ללא צורך ב-JavaScript או בטעינת דף דינמית. ממשקי ה-API הסטטיים לאינטרנט יוצרים תמונה על סמך פרמטרים של כתובות URL, שנשלחות באמצעות בקשת HTTPS רגילה.

בדרך כלל, בקשת API סטטית של Street View היא בתבנית הבאה:

  https://www.googleapis.com/streetview/z/x/y?parameters

מהו שירות אינטרנט?

שירותי האינטרנט של הפלטפורמה של מפות Google הם ממשק לבקשת נתונים של ממשק ה-API של מפות Google משירותים חיצוניים ולשימוש בנתונים מתוך אפליקציות מפות Google שלכם. השימוש בשירותים האלה בשילוב עם מפה, בהתאם להגבלות הרישיון בתנאים ובהגבלות של הפלטפורמה של מפות Google.

שירותי האינטרנט של ממשקי ה-API של מפות Google משתמשים בבקשות HTTP(S) לכתובות URL ספציפיות, ומעבירים פרמטרים של כתובות אתרים או נתוני POST בפורמט JSON כארגומנטים לשירותים. באופן כללי, השירותים האלו מחזירים נתונים בגוף התגובה כ-JSON לצורך ניתוח ו/או עיבוד של האפליקציה.

בקשת מטא-נתונים של API סטטי של Street View היא בפורמט הבא:

https://maps.googleapis.com/maps/api/streetview/parameters

הערה: כל האפליקציות של Street View Static API מחייבות אימות. מידע נוסף על פרטי כניסה לאימות

גישת SSL/TLS

חובה להשתמש ב-HTTPS לכל הבקשות של הפלטפורמה של מפות Google שמשתמשות במפתחות API או שמכילות נתוני משתמשים. בקשות שמבוצעות באמצעות HTTP ומכילות מידע אישי רגיש עשויות להידחות.

יצירת כתובת URL חוקית

יכול להיות שתחשבו שכתובת URL 'תקפה' מובנת מאליה, אבל זה לא המצב. לדוגמה, כתובת URL שהוזנה בסרגל הכתובות בדפדפן עשויה להכיל תווים מיוחדים (למשל, "上海+中國"). לפני ההעברה, הדפדפן צריך לתרגם את התווים האלה לקידוד שונה. באותו אסימון, כל קוד שיוצר או מקבל קלט UTF-8 עלול להתייחס לכתובות URL עם תווי UTF-8 כ'תקינים', אבל הוא יצטרך לתרגם את התווים האלה לפני שהם שולחים אותם לשרת אינטרנט. התהליך הזה נקרא קידוד כתובות URL או קידוד באחוזים.

תווים מיוחדים

אנחנו צריכים לתרגם תווים מיוחדים כי כל כתובות ה-URL צריכות להתאים לתחביר שצוין במפרט Uniform Resource Identifier (URI). למעשה, כתובות URL חייבות להכיל רק קבוצת משנה מיוחדת של תווי ASCII: הסמלים האלפאנומריים המוכרים, וחלק מהתווים השמורים לשימוש כתווי בקרה בכתובות URL. הטבלה הזו מסכמת את התווים הבאים:

סיכום תווים חוקיים של כתובת URL

סיום	תווים	שימוש בכתובת URL
אלפאנומרי	a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V X Y Z 0 1 2 3	מחרוזות טקסט, שימוש בסכמה (`http`), יציאה (`8080`) וכו'.
לא שמור	- _ . ~	מחרוזות טקסט
בוצעה הזמנה	! * ' ( ) ; : @ & = + $ , / ? % # [ ]	תווי בקרה ו/או מחרוזות טקסט

כשיוצרים כתובת URL תקינה, צריך לוודא שהיא מכילה רק את התווים שמוצגים בטבלה. שינוי של כתובת URL לשימוש בקבוצת התווים הזו מוביל בדרך כלל לשתי בעיות, אחת להשמטת נתונים והחלפה:

התווים שבהם ברצונך לטפל קיימים מחוץ לקבוצה שלמעלה. לדוגמה, תווים בשפות זרות כמו 上海+中國 צריכים להיות מקודדים באמצעות התווים שלמעלה. לפי המוסכמה הפופולרית, רווחים (שלא מותרים בכתובות URL) מיוצגים לעיתים קרובות גם באמצעות תו '+'.
התווים קיימים במסגרת הקבוצה כתווים שמורים, אבל צריך להשתמש בהם באופן מילולי. לדוגמה, הפונקציה ? משמשת בכתובות URL כדי לציין את ההתחלה של מחרוזת השאילתה. אם רוצים להשתמש במחרוזת '?' וב-Mysterions', צריך לקודד את התו '?'.

כל התווים לקידודי התווים שמתאימים לכתובות URL מקודדים באמצעות תו '%' וערך הקסדצימלי בן שני תווים שתואם לתו UTF-8. לדוגמה, 上海+中國 בקידוד UTF-8 יותאם לקידודי התווים שמתאימים לכתובות URL באופן הבא: %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B. המחרוזת ? and the Mysterians תהיה בקידוד כתובת ה-URL כ-%3F+and+the+Mysterians או כ-%3F%20and%20the%20Mysterians.

תווים נפוצים שדורשים קידוד

הנה מספר תווים נפוצים שחובה לקודד:

תו לא בטוח	ערך מקודד
מרחב	`%20`
"	`%22`
<	`%3C`
>	`%3E`
#	`%23`
%	`%25`
\|	`%7C`

לפעמים קשה להמיר כתובת URL שמקבלים מפרטים של משתמשים. לדוגמה, משתמש יכול להזין כתובת בפורמט "רחוב חמישי וראשון" באופן כללי, צריך ליצור את כתובת ה-URL מהחלקים שלה ולהתייחס לכל קלט של משתמשים כתווים מילוליים.

בנוסף, כתובות ה-URL מוגבלות ל-16,384 תווים לכל שירותי האינטרנט וממשקי ה-API הסטטיים באינטרנט של הפלטפורמה של מפות Google. ברוב השירותים שלרוב תתקרבו למגבלת התווים הזו. עם זאת, חשוב לשים לב שלשירותים מסוימים יש מספר פרמטרים שעשויים להוביל לכתובות URL ארוכות.

שימוש מנומס בממשקי API של Google

לקוחות API שלא מעוצבים כראוי יכולים ליצור עומס גדול יותר מהנדרש גם באינטרנט וגם בשרתים של Google. הקטע הזה כולל כמה שיטות מומלצות ללקוחות של ממשקי ה-API. כדאי לפעול לפי השיטות המומלצות האלה כדי למנוע את חסימת האפליקציה עקב ניצול לרעה של ממשקי ה-API בטעות.

השהיה מעריכית לפני ניסיון חוזר (exponential backoff)

במקרים נדירים, יכול להיות שמשהו ישתבש בזמן מילוי הבקשה: יכול להיות שתקבלו קוד תגובה 4XX או 5XX של HTTP, או שחיבור ה-TCP פשוט ייכשל במקום כלשהו בין הלקוח לשרת של Google. לעיתים קרובות משתלם לנסות שוב את הבקשה, כי בקשת ההמשך עשויה להצליח כאשר הבקשה המקורית נכשלה. עם זאת, חשוב לא ליצור בקשות חוזרות ונשנות לשרתים של Google. הלולאה הזו עלולה לגרום לעומס יתר על הרשת בין הלקוח ל-Google, ולגרום לבעיות לגורמים רבים.

עדיף לנסות שוב ושוב עם יותר עיכובים בין הניסיונות. בדרך כלל ההשהיה גדלת בגורם מכפיל בכל ניסיון, גישה שנקראת השהיה מעריכית לפני ניסיון חוזר (exponential backoff).

לדוגמה, נניח שיש לכם אפליקציה שרוצה לשלוח את הבקשה הזו ל-Time Zone API:

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

הדוגמה הבאה ב-Python מראה איך לשלוח את הבקשה עם השהיה מעריכית לפני ניסיון חוזר (exponential backoff):

import json
import time
import urllib.error
import urllib.parse
import urllib.request

# The maps_key defined below isn't a valid Google Maps API key.
# You need to get your own API key.
# See https://developers.google.com/maps/documentation/timezone/get-api-key
API_KEY = "YOUR_KEY_HERE"
TIMEZONE_BASE_URL = "https://maps.googleapis.com/maps/api/timezone/json"


def timezone(lat, lng, timestamp):

    # Join the parts of the URL together into one string.
    params = urllib.parse.urlencode(
        {"location": f"{lat},{lng}", "timestamp": timestamp, "key": API_KEY,}
    )
    url = f"{TIMEZONE_BASE_URL}?{params}"

    current_delay = 0.1  # Set the initial retry delay to 100ms.
    max_delay = 5  # Set the maximum retry delay to 5 seconds.

    while True:
        try:
            # Get the API response.
            response = urllib.request.urlopen(url)
        except urllib.error.URLError:
            pass  # Fall through to the retry loop.
        else:
            # If we didn't get an IOError then parse the result.
            result = json.load(response)

            if result["status"] == "OK":
                return result["timeZoneId"]
            elif result["status"] != "UNKNOWN_ERROR":
                # Many API errors cannot be fixed by a retry, e.g. INVALID_REQUEST or
                # ZERO_RESULTS. There is no point retrying these requests.
                raise Exception(result["error_message"])

        if current_delay > max_delay:
            raise Exception("Too many retry attempts.")

        print("Waiting", current_delay, "seconds before retrying.")

        time.sleep(current_delay)
        current_delay *= 2  # Increase the delay each time we retry.


if __name__ == "__main__":
    tz = timezone(39.6034810, -119.6822510, 1331161200)
    print(f"Timezone: {tz}")

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

בקשות מסונכרנות

מספר גדול של בקשות מסונכרנות לממשקי ה-API של Google יכולות להיראות כמו התקפת מניעת שירות מבוזרת (DDoS) בתשתית של Google, וצריך לטפל בהן בהתאם. כדי למנוע זאת, צריך לוודא שבקשות ה-API לא מסונכרנות בין הלקוחות.

לדוגמה, נבחן אפליקציה שמציגה את השעה באזור הזמן הנוכחי. האפליקציה כנראה תגדיר התראה במערכת ההפעלה של הלקוח שמוציאה אותה ממצב שינה בתחילת הדקה, כדי שיהיה אפשר לעדכן את השעה המוצגת. האפליקציה לא צריכה לבצע קריאות ל-API כחלק מהעיבוד שמשויך להתראה הזו.

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

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

מלבד תחילת הדקה, זמני סנכרון נפוצים אחרים שבהם כדאי להיזהר לא לטרגט הם בתחילת השעה, בתחילת כל יום בחצות.

מתבצע עיבוד של התשובות

בקטע הזה מוסבר איך לחלץ את הערכים האלה באופן דינמי מתשובות של שירותי אינטרנט.

שירותי האינטרנט של מפות Google מספקים תשובות קלות להבנה, אבל לא בדיוק ידידותיות למשתמש. כשמריצים שאילתה, במקום להציג קבוצת נתונים, עדיף לחלץ כמה ערכים ספציפיים. באופן כללי, רצוי לנתח תשובות משירות האינטרנט ולחלץ רק את הערכים שמעניינים אתכם.

סכימת הניתוח שבה משתמשים תלויה בשאלה אם מחזירים פלט ב-JSON. תגובות JSON, שהן כבר אובייקטים של JavaScript, יכולות לעבור עיבוד בתוך JavaScript עצמו אצל הלקוח.