คู่มือนี้แสดงวิธีโหลด Maps JavaScript API โดยมี 3 วิธีดังนี้
- ใช้การนําเข้าไลบรารีแบบไดนามิก (แนะนํา)
- ใช้แพ็กเกจ NPM js-api-loader
- ใช้แท็กการโหลดสคริปต์เดิม
ใช้การนําเข้าไลบรารีแบบไดนามิก
โหลด Maps JavaScript API โดยการเพิ่มตัวโหลด Bootsrap ในบรรทัดลงในโค้ดของแอปพลิเคชัน ดังที่แสดงในข้อมูลโค้ดต่อไปนี้
<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_HERE", 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>
คุณยังเพิ่มโค้ดตัวโหลด Bootsrap ลงในโค้ด 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();
พารามิเตอร์ที่จำเป็น
key
: คีย์ API ของคุณ Maps JavaScript API จะไม่โหลดเว้นแต่ว่าจะมีการระบุคีย์ API ที่ถูกต้อง
พารามิเตอร์ที่ไม่บังคับ
v
: เวอร์ชันของ Maps JavaScript API ที่จะโหลดlibraries
: รายการที่คั่นด้วยเครื่องหมายจุลภาคของไลบรารี Maps JavaScript API เพิ่มเติมที่จะโหลด เราไม่แนะนําให้ระบุชุดไลบรารีคงที่ แต่นักพัฒนาซอฟต์แวร์ที่ต้องการปรับลักษณะการทํางานการแคชในเว็บไซต์อย่างละเอียดlanguage
: ภาษาที่จะใช้ การตั้งค่านี้จะมีผลกับชื่อของการควบคุม ประกาศเกี่ยวกับลิขสิทธิ์ เส้นทางการขับขี่ และป้ายกํากับการควบคุม รวมถึงการตอบกลับคําขอบริการ ดูรายการภาษาที่รองรับregion
: รหัสภูมิภาคที่จะใช้ วิธีนี้จะเปลี่ยนการทํางานของแผนที่ตามประเทศหรือดินแดนที่กําหนดsolutionChannel
: Google Maps Platform มีโค้ดตัวอย่างหลายประเภท ที่จะช่วยให้คุณเริ่มต้นใช้งานได้อย่างรวดเร็ว หากต้องการติดตามการใช้ตัวอย่างโค้ดที่ซับซ้อนยิ่งขึ้นและปรับปรุงคุณภาพโซลูชัน Google จะรวมพารามิเตอร์การค้นหาsolutionChannel
ในการเรียก API ในโค้ดตัวอย่างของเราauthReferrerPolicy
: ลูกค้า Maps JS สามารถกําหนดค่าข้อจํากัดผู้อ้างอิง HTTP ใน Cloud Console เพื่อจํากัด URL ที่อนุญาตให้ใช้คีย์ API ได้ โดยค่าเริ่มต้น คุณจะกําหนดค่าข้อจํากัดเหล่านี้เพื่อให้ เส้นทางบางอย่างใช้คีย์ API ได้ หาก URL บนโดเมนหรือต้นทางเดียวกันอาจใช้คีย์ API คุณตั้งค่าauthReferrerPolicy: "origin"
เพื่อจํากัดปริมาณข้อมูลที่ส่งเมื่อให้สิทธิ์คําขอจาก Maps JavaScript API ได้ เมื่อระบุพารามิเตอร์นี้และเปิดใช้การจํากัดผู้อ้างอิง HTTP บน Cloud Console แล้ว Maps JavaScript API จะสามารถโหลดได้ก็ต่อเมื่อมีข้อจํากัดของผู้อ้างอิง HTTP ที่ตรงกับโดเมนของเว็บไซต์ปัจจุบันโดยไม่มีเส้นทางที่ระบุเท่านั้น
ใช้แพ็กเกจ NPM js-api-loader
แพ็กเกจ @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, }); });
ใช้แท็กการโหลดสคริปต์แบบเดิม
ระบบยังคงรองรับแท็กการโหลดสคริปต์เดิมอยู่ ส่วนนี้มีไว้เพื่อรองรับการผสานรวมโดยใช้แท็กการโหลดสคริปต์เดิม Google สนับสนุนการย้ายข้อมูลไปยัง Dynamic Library Loading API
เพิ่มแท็กสคริปต์
หากต้องการโหลด Maps JavaScript API ในบรรทัดในไฟล์ HTML ให้เพิ่มแท็ก script
ตามที่แสดงด้านล่าง
<script async
src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap">
</script>
พารามิเตอร์ URL การโหลดสคริปต์แบบเดิม
ส่วนนี้จะอธิบายถึงพารามิเตอร์ทั้งหมดที่คุณระบุในสตริงการค้นหาของ URL การโหลดสคริปต์เมื่อโหลด Maps JavaScript API
จําเป็นต้องมีพารามิเตอร์บางอย่างขณะที่พารามิเตอร์อื่นๆ เป็นตัวเลือก ตามมาตรฐานใน URL
พารามิเตอร์ทั้งหมดจะถูกคั่นด้วยอักขระ "และ" (&
)
URL ตัวอย่างต่อไปนี้มีตัวยึดตําแหน่งสําหรับพารามิเตอร์ที่เป็นไปได้ทั้งหมด
https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY
&callback=FUNCTION_NAME
&v=VERSION
&libraries="LIBRARIES"
&language="LANGUAGE"
®ion="REGION"
&solution_channel="SOLUTION_IDENTIFIER"
&auth_referrer_policy="AUTH_REFERRER_POLICY"
URL ในแท็ก script
ตัวอย่างต่อไปนี้โหลด Maps JavaScript API
<script async
src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap">
</script>
พารามิเตอร์ที่จําเป็น (เดิม)
ต้องระบุพารามิเตอร์ต่อไปนี้เมื่อโหลด Maps JavaScript API
key
: คีย์ API ของคุณ โหลด Maps JavaScript API เว้นแต่ว่าระบุคีย์ API ที่ถูกต้องไว้callback
: ชื่อของฟังก์ชันส่วนกลางที่จะเรียกใช้เมื่อ Maps JavaScript API โหลดเสร็จเรียบร้อยแล้ว
พารามิเตอร์ที่ไม่บังคับ (เดิม)
ใช้พารามิเตอร์เหล่านี้เพื่อขอ Maps JavaScript API เวอร์ชันเฉพาะ โหลดไลบรารีเพิ่มเติม แปลแผนที่ หรือระบุนโยบายการตรวจสอบผู้อ้างอิง HTTP
v
: เวอร์ชันของ Maps JavaScript API ที่จะใช้libraries
: รายการที่คั่นด้วยเครื่องหมายจุลภาคของไลบรารี Maps JavaScript API เพิ่มเติมที่จะโหลดlanguage
: ภาษาที่จะใช้ การกระทําเช่นนี้มีผลต่อชื่อของการควบคุม ประกาศเกี่ยวกับลิขสิทธิ์ เส้นทางการขับขี่ และป้ายกํากับการควบคุม รวมถึงการตอบกลับคําขอบริการ ดูรายการภาษาที่รองรับregion
: รหัสภูมิภาคที่จะใช้ วิธีนี้จะเปลี่ยนการทํางานของแผนที่ตามประเทศหรือดินแดนที่กําหนดsolution_channel
: Google Maps Platform มีโค้ดตัวอย่างหลายประเภท ที่จะช่วยให้คุณเริ่มต้นใช้งานได้อย่างรวดเร็ว หากต้องการติดตามการใช้ตัวอย่างโค้ดที่ซับซ้อนยิ่งขึ้นและปรับปรุงคุณภาพโซลูชัน Google จะรวมพารามิเตอร์การค้นหาsolution_channel
ในการเรียก API ในโค้ดตัวอย่างของเราauth_referrer_policy
: ลูกค้า Maps JS สามารถกําหนดค่าข้อจํากัดผู้อ้างอิง HTTP ใน Cloud Console เพื่อจํากัด URL ที่อนุญาตให้ใช้คีย์ API ได้ โดยค่าเริ่มต้น คุณจะกําหนดค่าข้อจํากัดเหล่านี้เพื่อให้ เส้นทางบางอย่างใช้คีย์ API ได้ หาก URL บนโดเมนหรือต้นทางเดียวกันอาจใช้คีย์ API คุณตั้งค่าauth_referrer_policy=origin
เพื่อจํากัดปริมาณข้อมูลที่ส่งเมื่อให้สิทธิ์คําขอจาก Maps JavaScript API ได้ ซึ่งมีในเวอร์ชัน 3.46 เมื่อระบุพารามิเตอร์นี้และเปิดใช้การจํากัดผู้อ้างอิง HTTP บน Cloud Console แล้ว Maps JavaScript API จะสามารถโหลดได้ก็ต่อเมื่อมีข้อจํากัด HTTP Referrer ที่ตรงกับโดเมนของเว็บไซต์ปัจจุบันโดยไม่มีการระบุเส้นทาง
ย้ายข้อมูลไปยัง Dynamic Library Import API
ส่วนนี้จะครอบคลุมขั้นตอนที่จําเป็นในการย้ายข้อมูลการผสานรวมของคุณเพื่อใช้ Dynamic Library Import API
ขั้นตอนการย้ายข้อมูล
ก่อนอื่นให้แทนที่แท็กโหลดสคริปต์เดิมด้วยแท็กตัวโหลด Bootsrap ในบรรทัด
ก่อน
<script async
src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&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_HERE", 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();