โหลด Maps JavaScript API

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

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

โหลด Maps JavaScript API ด้วยการเพิ่มตัวโหลด Boottrap ในบรรทัดลงในโค้ดแอปพลิเคชันของคุณ ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

<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>

นอกจากนี้ คุณยังเพิ่มโค้ดตัวโหลด Boottrap ลงในโค้ด 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: รหัสภูมิภาคที่จะใช้ ซึ่งจะปรับเปลี่ยนลักษณะการทำงานของแผนที่ตามประเทศหรือเขตแดนหนึ่งๆ

  • authReferrerPolicy: ลูกค้า Maps JS สามารถกำหนดค่าข้อจำกัดของผู้อ้างอิง 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 ในโค้ดตัวอย่างของเรา

ใช้แพ็กเกจ NPM js-api-loader

แพ็กเกจ @googlemaps/js-api-loader พร้อมใช้งานสำหรับการโหลดผ่านโปรแกรมจัดการแพ็กเกจ NPM ติดตั้งโดยใช้ คำสั่งต่อไปนี้

npm install @googlemaps/js-api-loader

สามารถนำเข้าแพ็กเกจนี้ไปยังแอปพลิเคชันด้วย:

import { Loader } from "@googlemaps/js-api-loader"

ตัวโหลดแสดงอินเทอร์เฟซ Promise และโค้ดเรียกกลับ ข้อมูลต่อไปนี้สาธิตการใช้เมธอด 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

ตัวอย่างต่อไปนี้แสดงการใช้ 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
});

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

ส่วนนี้จะแสดงวิธีใช้แท็กการโหลดสคริปต์โดยตรง Google ขอแนะนำให้ย้ายข้อมูลไปยัง Dynamic Library Loading API

เพิ่มแท็กสคริปต์

หากต้องการโหลด 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"
&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>

พารามิเตอร์ที่จำเป็น (โดยตรง)

ต้องระบุพารามิเตอร์ต่อไปนี้เมื่อโหลด Maps JavaScript API

  • key: คีย์ API ของคุณ Maps JavaScript API จะไม่โหลดหากไม่ระบุคีย์ API ที่ถูกต้อง

  • callback: ชื่อของฟังก์ชันส่วนกลางที่จะใช้เรียกเมื่อ Maps JavaScript API โหลดเสร็จสมบูรณ์

พารามิเตอร์ที่ไม่บังคับ (โดยตรง)

ใช้พารามิเตอร์เหล่านี้เพื่อขอ Maps JavaScript API เวอร์ชันที่เจาะจง โหลดไลบรารีเพิ่มเติม แปลแผนที่ หรือระบุนโยบายการตรวจสอบ URL ที่มา HTTP

  • loading: กลยุทธ์การโหลดโค้ดที่ Maps JavaScript API ใช้ได้ ตั้งค่าเป็น async เพื่อระบุว่า Maps JavaScript API ไม่ได้โหลดแบบพร้อมกัน และไม่มีการทริกเกอร์โค้ด JavaScript โดยเหตุการณ์ load ของสคริปต์ เราขอแนะนำอย่างยิ่งให้ตั้งค่าเป็น async ทุกครั้งที่เป็นไปได้เพื่อประสิทธิภาพที่ดีขึ้น (ใช้พารามิเตอร์ callback แทนเพื่อดำเนินการเมื่อ Maps JavaScript API พร้อมใช้งาน) พร้อมใช้งานตั้งแต่เวอร์ชัน 3.55

  • callback: ชื่อของฟังก์ชันส่วนกลางที่จะใช้เรียกเมื่อ Maps JavaScript API โหลดเสร็จสมบูรณ์

  • v: เวอร์ชันของ Maps JavaScript API ที่ใช้ได้

  • libraries: รายการไลบรารีเพิ่มเติมสำหรับ Maps JavaScript API ที่คั่นด้วยคอมมา

  • language: ภาษาที่จะใช้ ส่วนนี้จะมีผลต่อชื่อของการควบคุม ประกาศเกี่ยวกับลิขสิทธิ์ เส้นทางการขับขี่ และป้ายกำกับการควบคุม รวมถึงการตอบกลับคำขอบริการ ดูรายการภาษาที่รองรับ

  • region: รหัสภูมิภาคที่จะใช้ ซึ่งจะปรับเปลี่ยนลักษณะการทำงานของแผนที่ตามประเทศหรือเขตแดนหนึ่งๆ

  • auth_referrer_policy: ลูกค้ากำหนดค่าข้อจำกัดของผู้อ้างอิง 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 ในโค้ดตัวอย่างของเรา

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

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

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

ขั้นตอนแรก ให้แทนที่แท็กการโหลดสคริปต์โดยตรงด้วยแท็ก Bootstrap Loader แบบอินไลน์

ก่อน

<script async
    src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&loading=async&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();