טעינת Maps JavaScript API

במדריך הזה נסביר איך לטעון את Maps JavaScript API. יש שלוש דרכים לעשות זאת:

• שימוש בייבוא דינמי של ספריות
• שימוש בתג לטעינה ישירה של סקריפט
• שימוש בחבילת NPM js-api-loader

שימוש בייבוא דינמי של ספריות

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

כדי לטעון את Maps JavaScript API, מוסיפים את טוען ה-bootstrap בתוך השורה לקוד האפליקציה, כמו שמוצג בקטע הקוד הבא:

<script>
  (g=>{var h,a,k,p="The Google Maps JavaScript API",c="google",l="importLibrary",q="__ib__",m=document,b=window;b=b[c]||(b[c]={});var d=b.maps||(b.maps={}),r=new Set,e=new URLSearchParams,u=()=>h||(h=new Promise(async(f,n)=>{await (a=m.createElement("script"));e.set("libraries",[...r]+"");for(k in g)e.set(k.replace(/[A-Z]/g,t=>"_"+t[0].toLowerCase()),g[k]);e.set("callback",c+".maps."+q);a.src=`https://maps.${c}apis.com/maps/api/js?`+e;d[q]=f;a.onerror=()=>h=n(Error(p+" could not load."));a.nonce=m.querySelector("script[nonce]")?.nonce||"";m.head.append(a)}));d[l]?console.warn(p+" only loads once. Ignoring:",g):d[l]=(f,...n)=>r.add(f)&&u().then(()=>d[l](f,...n))})({
    key: "YOUR_API_KEY",
    v: "weekly",
    // Use the 'v' parameter to indicate the version to use (weekly, beta, alpha, etc.).
    // Add other bootstrap parameters as needed, using camel case.
  });
</script>

אפשר גם להוסיף את קוד הטעינה של bootstrap ישירות לקוד ה-JavaScript.

כדי לטעון ספריות בזמן ריצה, משתמשים באופרטור await כדי לקרוא ל-importLibrary() מתוך פונקציית async. הצהרה על משתנים עבור המחלקות הנדרשות מאפשרת לדלג על שימוש בנתיב מוסמך (למשל google.maps.Map), כפי שמוצג בדוגמת הקוד הבאה:

async function init() {
    // Import the needed libraries.
    await google.maps.importLibrary('maps');

    // Access the map.
    const mapElement = document.querySelector('gmp-map');
    // Access the underlying map object.
    const innerMap = mapElement.innerMap;

    console.log({ mapElement, innerMap });
}

void init();
index.js

הפונקציה יכולה גם לטעון ספריות בלי להצהיר על משתנה למחלקות הנדרשות, וזה שימושי במיוחד אם הוספתם מפה באמצעות רכיב gmp-map. בלי המשתנה, צריך להשתמש בנתיבים מלאים, למשל google.maps.Map:

let map;
let center =  { lat: -34.397, lng: 150.644 };

async function initMap() {
  await google.maps.importLibrary("maps");
  await google.maps.importLibrary("marker");

  map = new google.maps.Map(document.getElementById("map"), {
    center,
    zoom: 8,
    mapId: "DEMO_MAP_ID",
  });

  addMarker();
}

async function addMarker() {
  const marker = new google.maps.marker.AdvancedMarkerElement({
    map,
    position: center,
  });
}

initMap();

אפשרות אחרת היא לטעון את הספריות ישירות ב-HTML, כמו שמוצג כאן:

<script>
google.maps.importLibrary("maps");
google.maps.importLibrary("marker");
</script>

איך עוברים ל-Dynamic Library Loading API

פרמטרים נדרשים

• ‫key: מפתח ה-API. ממשק Maps JavaScript API לא ייטען אם לא מציינים מפתח API תקין.

פרמטרים אופציונליים

• ‫v: הגרסה של Maps JavaScript API שרוצים לטעון. אם לא מציינים במפורש ערוץ או גרסה, מקבלים כברירת מחדל את הערוץ השבועי. אם עברתם ממינוי פרימיום ולא ציינתם במפורש ערוץ או גרסה, תקבלו כברירת מחדל את הערוץ הרבעוני. אם תציינו גרסה לא תקינה, תקבלו את הערוץ שמוגדר כברירת מחדל. מידע נוסף

• ‫libraries: מערך של ספריות נוספות של Maps JavaScript API שרוצים להתחיל לטעון מראש. בדרך כלל לא מומלץ לציין קבוצה קבועה של ספריות, אבל האפשרות הזו זמינה למפתחים שרוצים לכוון במדויק את התנהגות הקאשינג באתר שלהם. עדיין חשוב להפעיל את הפונקציה google.maps.importLibrary() לכל ספרייה שנבחרה לפני השימוש בה.

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

• ‫region: קוד האזור שבו רוצים להשתמש. הפעולה הזו משנה את התנהגות ה-API על סמך מדינה או טריטוריה מסוימת.

• ‫authReferrerPolicy: לקוחות Maps JavaScript יכולים להגדיר הגבלות של מפנה HTTP במסוף Cloud כדי להגביל את כתובות ה-URL שיכולות להשתמש במפתח API מסוים. כברירת מחדל, אפשר להגדיר את ההגבלות האלה כך שרק נתיבים מסוימים יוכלו להשתמש במפתח API. אם יש סיכוי שמפתח ה-API ישמש כתובות URL כלשהן באותו דומיין או באותו מקור, אפשר להגדיר את authReferrerPolicy: "origin" כדי להגביל את כמות הנתונים שנשלחים כשמאשרים בקשות מ-Maps JavaScript API. כשמציינים את הפרמטר הזה וההגבלות של HTTP Referrer מופעלות ב-Cloud Console, אפשר לטעון את Maps JavaScript API רק אם יש הגבלה של HTTP Referrer שתואמת לדומיין הנוכחי של האתר בלי שצוינה נתיב.

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

• ‫channel: מעקב אחר השימוש בכל ערוץ

שימוש בתג לטעינה ישירה של סקריפט

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

הוספת תג סקריפט

כדי לטעון את Maps JavaScript API בשורה בקובץ HTML, מוסיפים תג script כמו בדוגמה הבאה.

<script async
    src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&loading=async&callback=initMap">
</script>

פרמטרים של כתובת URL לטעינה ישירה של סקריפט

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

בדוגמה הבאה של כתובת URL יש placeholder לכל הפרמטרים האפשריים:

https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY
&loading=async
&callback=FUNCTION_NAME
&v=VERSION
&libraries="LIBRARIES"
&language="LANGUAGE"
&region="REGION"
&auth_referrer_policy="AUTH_REFERRER_POLICY"
&map_ids="MAP_IDS"
&channel="CHANNEL"
&solution_channel="SOLUTION_IDENTIFIER"

כתובת ה-URL בתג script בדוגמה הבאה טוענת את Maps JavaScript API:

<script async
    src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&loading=async&callback=initMap">
</script>

פרמטרים נדרשים (ישיר) {:.hide-from-toc}

כשמטעינים את Maps JavaScript API, חובה לציין את הפרמטרים הבאים.

• ‫key: מפתח ה-API. ממשק ה-API של JavaScript במפות Google לא ייטען אלא אם מצוין מפתח API תקין.

פרמטרים אופציונליים (ישירים) {:.hide-from-toc}

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

• ‫loading: אסטרטגיית טעינת הקוד שבה יכול להשתמש Maps JavaScript API. מגדירים את הערך async כדי לציין ש-Maps JavaScript API לא נטען באופן סינכרוני, ושאירוע load של הסקריפט לא מפעיל קוד JavaScript. מומלץ מאוד להגדיר את הערך הזה ל-async בכל הזדמנות אפשרית, כדי לשפר את הביצועים. (במקום זאת, אפשר להשתמש בפרמטר callback כדי לבצע פעולות כש-Maps JavaScript API זמין). הפרמטר הזה זמין החל מגרסה 3.55.

• ‫callback: השם של פונקציה גלובלית שתיקרא אחרי ש-Maps JavaScript API ייטען באופן מלא.

• ‫v: הגרסה של Maps JavaScript API שבה ייעשה שימוש.

• ‫libraries: רשימה מופרדת בפסיקים של ספריות נוספות של Maps JavaScript API לטעינה.

• ‫language: השפה שבה רוצים להשתמש. ההגדרה הזו משפיעה על השמות של אמצעי הבקרה, על הודעות זכויות היוצרים, על הוראות הנהיגה ועל תוויות אמצעי הבקרה, וגם על התשובות לבקשות שירות. כאן אפשר לעיין ברשימת השפות הנתמכות.

• ‫region: קוד האזור שבו רוצים להשתמש. הפעולה הזו משנה את התנהגות ה-API על סמך מדינה או טריטוריה מסוימת.

• ‫auth_referrer_policy: לקוחות יכולים להגדיר הגבלות על מפנים HTTP במסוף Cloud כדי להגביל את כתובות ה-URL שיכולות להשתמש במפתח API מסוים. כברירת מחדל, אפשר להגדיר את ההגבלות האלה כך שרק נתיבים מסוימים יוכלו להשתמש במפתח API. אם יש סיכוי שכתובת URL כלשהי באותו דומיין או מקור תשתמש במפתח ה-API, אפשר להגדיר את auth_referrer_policy=origin כדי להגביל את כמות הנתונים שנשלחים כשמאשרים בקשות מ-Maps JavaScript API. האפשרות הזו זמינה החל מגרסה 3.46. כשמציינים את הפרמטר הזה ומגבילים את השימוש ב-HTTP Referrer ב-Cloud Console, אפשר לטעון את Maps JavaScript API רק אם יש הגבלת HTTP Referrer שתואמת לדומיין הנוכחי של האתר בלי לציין נתיב.

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

• channel: מידע נוסף זמין במאמר בנושא מעקב אחר השימוש בכל ערוץ.

שימוש בחבילה NPM js-api-loader

חבילת ‎@googlemaps/js-api-loader זמינה לטעינה באמצעות מנהל החבילות NPM. מתקינים אותו באמצעות הפקודה הבאה:

npm install @googlemaps/js-api-loader

מייבאים את החבילה כמו שמוצג כאן:

// Import the needed libraries.
import { setOptions, importLibrary } from '@googlemaps/js-api-loader';
index.ts

// Import the needed libraries.
import { setOptions, importLibrary } from '@googlemaps/js-api-loader';
index.js

הטוען משתמש ב-Promises כדי להפוך ספריות לזמינות. טוענים ספריות באמצעות ה-method‏ importLibrary(). בדוגמה הבאה מוצג שימוש ב-loader כדי לטעון מפה:

// Import the needed libraries.
import { setOptions, importLibrary } from '@googlemaps/js-api-loader';

const API_KEY = 'AIzaSyA6myHzS10YXdcazAFalmXvDkrYCp5cLc8';

async function init(): Promise<void> {
    // Set loader options.
    setOptions({
        key: API_KEY,
    });

    // Load the Maps library.
    const { Map } = await importLibrary('maps');

    // Set map options.
    const mapOptions = {
        center: { lat: 48.8566, lng: 2.3522 },
        zoom: 3,
    };

    // Declare the map.
    new Map(document.getElementById('map')!, mapOptions);
}

void init();
index.ts

// Import the needed libraries.
import { setOptions, importLibrary } from '@googlemaps/js-api-loader';

const API_KEY = 'AIzaSyA6myHzS10YXdcazAFalmXvDkrYCp5cLc8';

async function init() {
    // Set loader options.
    setOptions({
        key: API_KEY,
    });

    // Load the Maps library.
    const { Map } = await importLibrary('maps');

    // Set map options.
    const mapOptions = {
        center: { lat: 48.8566, lng: 2.3522 },
        zoom: 3,
    };

    // Declare the map.
    new Map(document.getElementById('map'), mapOptions);
}

void init();
index.js

קוד מלא לדוגמה

מעבר ל-Dynamic Library Import API

בקטע הזה מוסבר איך להעביר את השילוב שלכם לשימוש ב-Dynamic Library Import API.

שלבים בהעברה

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

לפני

<script async
    src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&loading=async&libraries=maps&callback=initMap">
</script>

אחרי

<script>
  (g=>{var h,a,k,p="The Google Maps JavaScript API",c="google",l="importLibrary",q="__ib__",m=document,b=window;b=b[c]||(b[c]={});var d=b.maps||(b.maps={}),r=new Set,e=new URLSearchParams,u=()=>h||(h=new Promise(async(f,n)=>{await (a=m.createElement("script"));e.set("libraries",[...r]+"");for(k in g)e.set(k.replace(/[A-Z]/g,t=>"_"+t[0].toLowerCase()),g[k]);e.set("callback",c+".maps."+q);a.src=`https://maps.${c}apis.com/maps/api/js?`+e;d[q]=f;a.onerror=()=>h=n(Error(p+" could not load."));a.nonce=m.querySelector("script[nonce]")?.nonce||"";m.head.append(a)}));d[l]?console.warn(p+" only loads once. Ignoring:",g):d[l]=(f,...n)=>r.add(f)&&u().then(()=>d[l](f,...n))})({
    key: "YOUR_API_KEY",
    v: "weekly",
    // Use the 'v' parameter to indicate the version to use (weekly, beta, alpha, etc.).
    // Add other bootstrap parameters as needed, using camel case.
  });
</script>

לאחר מכן, מעדכנים את קוד האפליקציה:

• משנים את הפונקציה initMap() לאסינכרונית.
• מתקשרים אל importLibrary() כדי לטעון את הספריות שדרושות לכם ולגשת אליהן.

לפני

let map;

function initMap() {
  map = new google.maps.Map(document.getElementById("map"), {
    center: { lat: -34.397, lng: 150.644 },
    zoom: 8,
  });
}

window.initMap = initMap;

אחרי

let map;
// initMap is now async
async function initMap() {
    // Request libraries when needed, not in the script tag.
    const { Map } = await google.maps.importLibrary("maps");
    // Short namespaces can be used.
    map = new Map(document.getElementById("map"), {
        center: { lat: -34.397, lng: 150.644 },
        zoom: 8,
    });
}

initMap();