โหลด Maps JavaScript API

คู่มือนี้แสดงวิธีโหลด Maps JavaScript API ซึ่งทำได้ 3 วิธีดังนี้

ใช้การนำเข้าไลบรารีแบบไดนามิก

โหลด 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();

พารามิเตอร์ที่จำเป็น

  • 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,
  });
});

ดูตัวอย่างที่มี js-api-loader

ใช้แท็กการโหลดสคริปต์เดิม

แท็กโหลดสคริปต์เดิมจะยังคงใช้งานได้อยู่ ส่วนนี้มีไว้เพื่อรองรับการผสานรวมโดยใช้แท็กโหลดสคริปต์เดิม 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"
&region="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 เวอร์ชันที่เจาะจง โหลดไลบรารีเพิ่มเติม แปลแผนที่ หรือระบุนโยบายการตรวจสอบ URL ที่มา 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 ที่ตรงกับโดเมนของเว็บไซต์ปัจจุบันโดยไม่ระบุเส้นทางเท่านั้น

ย้ายข้อมูลไปยัง Dynamic Library Import API

ส่วนนี้ครอบคลุมขั้นตอนที่จำเป็นในการย้ายข้อมูลการผสานรวมเพื่อใช้ Dynamic Library Import API

ขั้นตอนการย้ายข้อมูล

ก่อนอื่น ให้แทนที่แท็กการโหลดสคริปต์เดิมด้วยแท็ก Bootstraploader แบบอินไลน์

ก่อน

<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",
    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();