คู่มือนี้แสดงวิธีโหลด Maps JavaScript API ซึ่งทำได้ 3 วิธีดังนี้
ใช้การนำเข้าไลบรารีแบบไดนามิก
การนำเข้าไลบรารีแบบไดนามิกทำให้โหลดไลบรารีขณะรันไทม์ได้ ซึ่งจะช่วยให้คุณขอไลบรารีที่ต้องการในจุดที่ต้องการได้ แทนที่จะขอทั้งหมดในครั้งเดียวเมื่อโหลด และยังป้องกันไม่ให้หน้าเว็บของคุณโหลด 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
ดังที่แสดงในตัวอย่างโค้ดต่อไปนี้
TypeScript
let map: google.maps.Map; async function initMap(): Promise<void> { const { Map } = await google.maps.importLibrary("maps") as google.maps.MapsLibrary; map = new Map(document.getElementById("map") as HTMLElement, { center: { lat: -34.397, lng: 150.644 }, zoom: 8, }); } initMap();
JavaScript
let map; async function initMap() { const { Map } = await google.maps.importLibrary("maps"); map = new Map(document.getElementById("map"), { center: { lat: -34.397, lng: 150.644 }, zoom: 8, }); } initMap();
หากคุณเพิ่มแผนที่โดยใช้องค์ประกอบ gmp-map
ฟังก์ชัน initMap()
จะโหลดไลบรารีได้โดยไม่ต้องประกาศตัวแปรสำหรับคลาสที่ต้องการ ดังนี้
async function initMap() { google.maps.importLibrary("maps"); google.maps.importLibrary("marker"); } initMap();
หรือคุณสามารถโหลดไลบรารีโดยตรงใน HTML ตามที่แสดงที่นี่
<script> google.maps.importLibrary("maps"); google.maps.importLibrary("marker"); </script>
ดูวิธีย้ายข้อมูลไปยัง API การโหลดไลบรารีแบบไดนามิก
พารามิเตอร์ที่จำเป็น
key
: คีย์ API ของคุณ Maps JavaScript API จะไม่โหลด เว้นแต่จะระบุคีย์ API ที่ถูกต้อง
พารามิเตอร์ที่ไม่บังคับ
v
: เวอร์ชันของ Maps JavaScript API ที่จะโหลดlibraries
: รายการไลบรารี Maps JavaScript API เพิ่มเติมที่คั่นด้วยจุลภาคที่จะโหลด โดยทั่วไปเราไม่แนะนำให้ระบุชุดไลบรารีแบบคงที่ แต่มีไว้สำหรับนักพัฒนาซอฟต์แวร์ที่ต้องการปรับแต่งลักษณะการแคชบนเว็บไซต์อย่างละเอียดlanguage
: ภาษาที่จะใช้ ซึ่งจะมีผลต่อชื่อของการควบคุม ประกาศเกี่ยวกับลิขสิทธิ์ เส้นทางการขับขี่ และป้ายกำกับการควบคุม และการตอบกลับคำขอบริการ ดูรายการภาษาที่รองรับregion
: รหัสภูมิภาคที่จะใช้ ซึ่งจะเปลี่ยนลักษณะการทำงานของแผนที่ตามประเทศหรือเขตแดนที่ระบุauthReferrerPolicy
: ลูกค้า Maps JS สามารถกำหนดค่าข้อจำกัดของ URL ที่มา HTTP ใน Cloud Console เพื่อจำกัด URL ที่ได้รับอนุญาตให้ใช้คีย์ API นั้นๆ ได้ โดยค่าเริ่มต้น คุณจะกำหนดค่าข้อจำกัดเหล่านี้เพื่ออนุญาตให้ใช้คีย์ API ได้บางเส้นทางเท่านั้น หาก URL ในโดเมนหรือต้นทางเดียวกันอาจใช้คีย์ API คุณก็ตั้งค่าauthReferrerPolicy: "origin"
เพื่อจำกัดปริมาณข้อมูลที่ส่งเมื่อให้สิทธิ์คำขอจาก Maps JavaScript API ได้ เมื่อระบุพารามิเตอร์นี้และเปิดใช้ข้อจำกัดผู้อ้างอิง HTTP ใน Cloud Console แล้ว Maps JavaScript API จะโหลดได้ก็ต่อเมื่อมีข้อจำกัดผู้อ้างอิง HTTP ที่ตรงกับโดเมนของเว็บไซต์ปัจจุบันที่ไม่ได้ระบุเส้นทางไว้mapIds
: อาร์เรย์ของรหัสแผนที่ ทำให้การกำหนดค่าสำหรับรหัสแผนที่ที่ระบุโหลดล่วงหน้าchannel
: ดูการติดตามการใช้งานต่อแชแนลsolutionChannel
: Google Maps Platform มีโค้ดตัวอย่างมากมาย เพื่อช่วยให้คุณเริ่มต้นใช้งานได้อย่างรวดเร็ว Google ได้ใส่พารามิเตอร์การค้นหาsolutionChannel
ไว้ในการเรียก API ในโค้ดตัวอย่าง เพื่อติดตามการใช้งานตัวอย่างโค้ดที่ซับซ้อนมากขึ้นและปรับปรุงคุณภาพโซลูชัน
ใช้แท็กการโหลดสคริปต์โดยตรง
ส่วนนี้จะแสดงวิธีใช้แท็กการโหลดสคริปต์โดยตรง เนื่องจากสคริปต์โดยตรงจะโหลดไลบรารีเมื่อแผนที่โหลดขึ้นมา จึงสามารถลดความซับซ้อนของแผนที่ที่สร้างขึ้นโดยใช้เอลิเมนต์ gmp-map
โดยทำให้ไม่จำเป็นต้องขอไลบรารีโดยตรงขณะรันไทม์ แต่ควรระวังให้รวม URL เพียงครั้งเดียวต่อการโหลดหน้าเว็บ
เพิ่มแท็กสคริปต์
หากต้องการโหลด 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 ตัวอย่างต่อไปนี้มีตัวยึดตำแหน่งสำหรับพารามิเตอร์ที่เป็นไปได้ทั้งหมด
https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY
&loading=async
&callback=FUNCTION_NAME
&v=VERSION
&libraries="LIBRARIES"
&language="LANGUAGE"
®ion="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>
พารามิเตอร์ที่จำเป็น (โดยตรง)
ต้องระบุพารามิเตอร์ต่อไปนี้เมื่อโหลด Maps JavaScript API
key
: คีย์ API ของคุณ Maps JavaScript API จะไม่โหลด เว้นแต่จะระบุคีย์ API ที่ถูกต้อง
พารามิเตอร์ที่ไม่บังคับ (โดยตรง)
ใช้พารามิเตอร์เหล่านี้เพื่อขอเวอร์ชันเฉพาะของ Maps JavaScript API, โหลดไลบรารีเพิ่มเติม, แปลแผนที่ของคุณ หรือระบุนโยบายการตรวจสอบผู้อ้างอิง HTTP
loading
: กลยุทธ์การโหลดโค้ดที่ Maps JavaScript API ใช้ได้ ตั้งค่าเป็นasync
เพื่อระบุว่าไม่ได้โหลด Maps JavaScript API แบบพร้อมกัน และไม่มีการเรียกใช้โค้ด JavaScript จากเหตุการณ์load
ของสคริปต์ ขอแนะนำให้ตั้งค่าเป็นasync
ทุกครั้งที่ทำได้เพื่อปรับปรุงประสิทธิภาพให้ดียิ่งขึ้น (ใช้พารามิเตอร์callback
แทนเพื่อดำเนินการต่างๆ เมื่อ Maps JavaScript API พร้อมใช้งาน) พร้อมให้บริการตั้งแต่เวอร์ชัน 3.55callback
: ชื่อของฟังก์ชันส่วนกลางที่จะเรียกใช้เมื่อ Maps JavaScript API โหลดเสร็จสมบูรณ์v
: เวอร์ชันของ Maps JavaScript API ที่จะใช้libraries
: รายการไลบรารี Maps JavaScript API เพิ่มเติมที่คั่นด้วยจุลภาคที่จะโหลดlanguage
: ภาษาที่จะใช้ ซึ่งจะมีผลต่อชื่อของการควบคุม ประกาศเกี่ยวกับลิขสิทธิ์ เส้นทางการขับขี่ และป้ายกำกับการควบคุม รวมถึงการตอบกลับคำขอบริการ ดูรายการภาษาที่รองรับregion
: รหัสภูมิภาคที่จะใช้ ซึ่งจะเปลี่ยนลักษณะการทำงานของแผนที่ตามประเทศหรือเขตแดนที่ระบุauth_referrer_policy
: ลูกค้าจะกำหนดค่าข้อจำกัดของ URL ที่มา HTTP ใน Cloud Console เพื่อจำกัด URL ที่ได้รับอนุญาตให้ใช้คีย์ API ได้ โดยค่าเริ่มต้น คุณจะกำหนดค่าข้อจำกัดเหล่านี้เพื่ออนุญาตให้ใช้คีย์ API ได้บางเส้นทางเท่านั้น หาก URL ในโดเมนหรือต้นทางเดียวกันอาจใช้คีย์ API คุณก็ตั้งค่าauth_referrer_policy=origin
เพื่อจำกัดปริมาณข้อมูลที่ส่งเมื่อให้สิทธิ์คำขอจาก Maps JavaScript API ได้ ซึ่งมีให้ตั้งแต่เวอร์ชัน 3.46 เป็นต้นไป เมื่อระบุพารามิเตอร์นี้และเปิดใช้ข้อจำกัดผู้อ้างอิง HTTP ใน Cloud Console แล้ว Maps JavaScript API จะโหลดได้ต่อเมื่อมีข้อจำกัดผู้อ้างอิง HTTP ที่ตรงกับโดเมนของเว็บไซต์ปัจจุบันโดยไม่ระบุเส้นทางไว้mapIds
: รายการรหัสแผนที่ที่คั่นด้วยคอมมา ทำให้การกำหนดค่าสำหรับรหัสแผนที่ที่ระบุโหลดล่วงหน้าchannel
: ดูการติดตามการใช้งานต่อแชแนลsolution_channel
: Google Maps Platform มีโค้ดตัวอย่างมากมาย เพื่อช่วยให้คุณเริ่มต้นใช้งานได้อย่างรวดเร็ว Google ได้ใส่พารามิเตอร์การค้นหาsolution_channel
ไว้ในการเรียก API ในโค้ดตัวอย่าง เพื่อติดตามการใช้งานตัวอย่างโค้ดที่ซับซ้อนมากขึ้นและปรับปรุงคุณภาพโซลูชัน
ใช้แพ็กเกจ js-api-loader ของ NPM
มีแพ็กเกจ @googlemaps/js-api-loader ให้ใช้งานสำหรับการโหลดผ่านโปรแกรมจัดการแพ็กเกจ NPM ติดตั้งโดยใช้คำสั่งต่อไปนี้
npm install @googlemaps/js-api-loader
คุณสามารถนำเข้าแพ็กเกจนี้ลงในแอปพลิเคชันพร้อมกับ
import { Loader } from "@googlemaps/js-api-loader"
ตัวโหลดจะแสดงอินเทอร์เฟซ Promise และ Callback รายการต่อไปนี้แสดงการใช้เมธอด Promise ที่เป็นค่าเริ่มต้น load()
TypeScript
const loader = new Loader({ apiKey: "YOUR_API_KEY", version: "weekly", ...additionalOptions, }); loader.load().then(async () => { const { Map } = await google.maps.importLibrary("maps") as google.maps.MapsLibrary; map = new Map(document.getElementById("map") as HTMLElement, { center: { lat: -34.397, lng: 150.644 }, zoom: 8, }); });
JavaScript
const loader = new Loader({ apiKey: "YOUR_API_KEY", version: "weekly", ...additionalOptions, }); loader.load().then(async () => { const { Map } = await google.maps.importLibrary("maps"); map = new Map(document.getElementById("map"), { center: { lat: -34.397, lng: 150.644 }, zoom: 8, }); });
ตัวอย่างต่อไปนี้แสดงการใช้ loader.importLibrary()
เพื่อโหลดไลบรารี
const loader = new Loader({
apiKey: "YOUR_API_KEY",
version: "weekly",
...additionalOptions,
});
loader
.importLibrary('maps')
.then(({Map}) => {
new Map(document.getElementById("map"), mapOptions);
})
.catch((e) => {
// do something
});
ย้ายข้อมูลไปยัง API การนำเข้าไลบรารีแบบไดนามิก
ส่วนนี้จะครอบคลุมขั้นตอนที่จำเป็นในการย้ายข้อมูลการผสานรวมเพื่อใช้ 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();