Maps JavaScript API'yi yükleme

Bu kılavuzda, Maps JavaScript API'nin nasıl yükleneceği gösterilmektedir. Bunu yapmanın üç yolu vardır:

Dinamik kitaplık içe aktarma özelliğini kullanma

Dinamik kitaplık içe aktarma, kitaplıkları çalışma zamanında yükleme olanağı sağlar. Bu sayede, yükleme sırasında hepsini birden istemek yerine ihtiyaç duyduğunuz anda gerekli kitaplıkları isteyebilirsiniz. Ayrıca sayfanızın Maps JavaScript API'yi birden çok kez yüklemesini de engeller.

Aşağıdaki snippet'te gösterildiği gibi, satır içi bootstrap yükleyiciyi uygulama kodunuza ekleyerek Maps JavaScript API'yi yükleyin:

<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 yükleyici kodunu doğrudan JavaScript kodunuza da ekleyebilirsiniz.

Kitaplıkları çalışma zamanında yüklemek için await operatörünü kullanarak async işlevi içinden importLibrary() işlevini çağırın. Gerekli sınıflar için değişkenleri bildirmek, aşağıdaki kod örneğinde gösterildiği gibi nitelikli bir yol (ör. google.maps.Map) kullanmayı atlamanıza olanak tanır:

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();
index.js

İşleviniz, gerekli sınıflar için değişken bildirmeden de kitaplıkları yükleyebilir. Bu durum, özellikle gmp-map öğesini kullanarak harita eklediyseniz kullanışlıdır. Değişken olmadan nitelikli yollar kullanmanız gerekir. Örneğin 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();

Alternatif olarak, kitaplıkları doğrudan HTML'ye yükleyebilirsiniz.

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

Dinamik Kitaplık Yükleme API'sine nasıl geçiş yapacağınızı öğrenin.

Gerekli parametreler

  • key: API anahtarınız. Geçerli bir API anahtarı belirtilmediği sürece Maps JavaScript API yüklenmez.

İsteğe bağlı parametreler

  • v: Yüklenecek Maps JavaScript API'nin sürümü.

  • libraries: Yüklenecek ek Maps JavaScript API kitaplıklarının dizisi. Sabit bir kitaplık grubu belirtmek genellikle önerilmez ancak web sitelerindeki önbelleğe alma davranışını hassas bir şekilde ayarlamak isteyen geliştiriciler için kullanılabilir.

  • language: Kullanılacak dil. Bu durum; kontrollerin adlarını, telif hakkı bildirimlerini, yol tariflerini, kontrol etiketlerini ve hizmet isteklerine verilen yanıtları etkiler. Desteklenen dillerin listesini inceleyin.

  • region: Kullanılacak bölge kodu. Bu, API'nin davranışını belirli bir ülke veya bölgeye göre değiştirir.

  • authReferrerPolicy: Maps JS müşterileri, belirli bir API anahtarının kullanılmasına izin verilen URL'leri sınırlamak için Cloud Console'da HTTP yönlendiren kısıtlamalarını yapılandırabilir. Varsayılan olarak, bu kısıtlamalar yalnızca belirli yolların API anahtarı kullanmasına izin verecek şekilde yapılandırılabilir. Aynı alan veya kaynakta bulunan herhangi bir URL API anahtarını kullanabilirse Maps JavaScript API'den gelen istekler yetkilendirilirken gönderilen veri miktarını sınırlamak için authReferrerPolicy: "origin" değerini ayarlayabilirsiniz. Bu parametre belirtildiğinde ve Cloud Console'da HTTP yönlendiren kısıtlamaları etkinleştirildiğinde Maps JavaScript API yalnızca yol belirtilmeden mevcut web sitesinin alanıyla eşleşen bir HTTP yönlendiren kısıtlaması varsa yüklenebilir.

  • mapIds: Harita kimlikleri dizisi. Belirtilen harita kimliklerinin yapılandırmasının önceden yüklenmesine neden olur. Burada harita kimliklerinin belirtilmesi, harita kimliklerinin kullanımı için gerekli değildir ancak ağ performansını hassas bir şekilde ayarlamak isteyen geliştiriciler için kullanılabilir.

  • channel: Kanal başına kullanım izleme başlıklı makaleyi inceleyin.

  • solutionChannel: Google Haritalar Platformu, hızlı bir şekilde kullanmaya başlamanıza yardımcı olmak için birçok örnek kod türü sunar. Google, daha karmaşık kod örneklerimizin kullanımını izlemek ve çözüm kalitesini artırmak için örnek kodumuzdaki API çağrılarına solutionChannel sorgu parametresini ekler.

Doğrudan komut dosyası yükleme etiketini kullanma

Bu bölümde, doğrudan komut dosyası yükleme etiketinin nasıl kullanılacağı gösterilmektedir. Doğrudan komut dosyası, harita yüklendiğinde kitaplıkları yüklediğinden çalışma zamanında kitaplıkların açıkça istenmesi ihtiyacını ortadan kaldırarak gmp-map öğesi kullanılarak oluşturulan haritaları basitleştirebilir. Doğrudan komut dosyası yükleme etiketi, komut dosyası yüklendiğinde istenen tüm kitaplıkları aynı anda yüklediğinden bazı uygulamalarda performans etkilenebilir. Doğrudan komut dosyası yükleme etiketini sayfa yükleme başına yalnızca bir kez ekleyin.

Komut dosyası etiketi ekleme

Maps JavaScript API'yi bir HTML dosyasına satır içi olarak yüklemek için aşağıdaki gibi bir script etiketi ekleyin.

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

Doğrudan komut dosyası yükleme URL parametreleri

Bu bölümde, Maps JavaScript API'si yüklenirken komut dosyası yükleme URL'sinin sorgu dizesinde belirtebileceğiniz tüm parametreler ele alınmaktadır. Bazı parametreler zorunlu, bazıları ise isteğe bağlıdır. URL'lerde standart olduğu gibi, tüm parametreler "ve" işareti (&) kullanılarak ayrılır.

Aşağıdaki örnek URL'de olası tüm parametreler için yer tutucular bulunmaktadır:

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"

Aşağıdaki örnekteki script etiketindeki URL, Maps JavaScript API'yi yükler:

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

Gerekli parametreler (doğrudan)

Maps JavaScript API yüklenirken aşağıdaki parametreler gereklidir.

  • key: API anahtarınız. Geçerli bir API anahtarı belirtilmediği sürece Maps JavaScript API yüklenmez.

İsteğe bağlı parametreler (doğrudan)

Maps JavaScript API'nin belirli bir sürümünü istemek, ek kitaplıklar yüklemek, haritanızı yerelleştirmek veya HTTP yönlendiren kontrol politikasını belirtmek için bu parametreleri kullanın.

  • loading: Maps JavaScript API'nin kullanabileceği kod yükleme stratejisi. Maps JavaScript API'nin eşzamanlı olarak yüklenmediğini ve komut dosyasının load etkinliği tarafından herhangi bir JavaScript kodunun tetiklenmediğini belirtmek için async olarak ayarlayın. Performansı artırmak için mümkün olduğunda bu ayarı async olarak ayarlamanız önemle tavsiye edilir. (Maps JavaScript API kullanılabilir olduğunda işlemleri gerçekleştirmek için bunun yerine callback parametresini kullanın.) 3.55 sürümünden itibaren kullanılabilir.

  • callback: Maps JavaScript API tamamen yüklendikten sonra bir kez çağrılacak genel işlevin adı.

  • v: Kullanılacak Maps JavaScript API'nin sürümü.

  • libraries: Yüklenecek ek Maps JavaScript API kitaplıklarının virgülle ayrılmış listesi.

  • language: Kullanılacak dil. Bu durum; kontrollerin adlarını, telif hakkı bildirimlerini, yol tariflerini ve kontrol etiketlerinin yanı sıra hizmet isteklerine verilen yanıtları etkiler. Desteklenen dillerin listesini inceleyin.

  • region: Kullanılacak bölge kodu. Bu, API'nin davranışını belirli bir ülke veya bölgeye göre değiştirir.

  • auth_referrer_policy: Müşteriler, belirli bir API anahtarının kullanılmasına izin verilen URL'leri sınırlamak için Cloud Console'da HTTP yönlendiren kısıtlamalarını yapılandırabilir. Varsayılan olarak, bu kısıtlamalar yalnızca belirli yolların API anahtarı kullanmasına izin verecek şekilde yapılandırılabilir. Aynı alan veya kaynakta bulunan herhangi bir URL API anahtarını kullanabilirse Maps JavaScript API'den gelen istekler yetkilendirilirken gönderilen veri miktarını sınırlamak için auth_referrer_policy=origin değerini ayarlayabilirsiniz. Bu özellik, 3.46 sürümünden itibaren kullanılabilir. Bu parametre belirtildiğinde ve Cloud Console'da HTTP yönlendiren kısıtlamaları etkinleştirildiğinde Maps JavaScript API yalnızca yol belirtilmeden mevcut web sitesinin alanıyla eşleşen bir HTTP yönlendiren kısıtlaması varsa yüklenebilir.

  • mapIds: Virgülle ayrılmış harita kimlikleri listesi. Belirtilen harita kimliklerinin yapılandırmasının önceden yüklenmesine neden olur. Harita kimliklerinin kullanımı için harita kimliklerinin burada belirtilmesi gerekmez ancak ağ performansını hassas bir şekilde ayarlamak isteyen geliştiriciler bu özelliği kullanabilir.

  • channel: Kanal başına kullanım izleme başlıklı makaleyi inceleyin.

  • solution_channel: Google Haritalar Platformu, hızlı bir şekilde kullanmaya başlamanıza yardımcı olmak için birçok örnek kod türü sunar. Google, daha karmaşık kod örneklerimizin kullanımını izlemek ve çözüm kalitesini artırmak için örnek kodumuzdaki API çağrılarına solution_channel sorgu parametresini ekler.

NPM js-api-loader paketini kullanma

NPM paket yöneticisi kullanılarak yükleme için @googlemaps/js-api-loader paketi kullanılabilir. Aşağıdaki komutu kullanarak yükleyin:

npm install @googlemaps/js-api-loader

Bu paket, uygulamaya aşağıdakilerle içe aktarılabilir:

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

Yükleyici, bir Promise ve geri çağırma arayüzü sunar. Aşağıda, varsayılan Promise yönteminin load() kullanımı gösterilmektedir.

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,
  });
});
index.ts

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

index.js

js-api-loader'ı içeren bir örneği inceleyin.

Aşağıdaki örnekte, kitaplıkları yüklemek için loader.importLibrary() kullanımı gösterilmektedir:

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

Dinamik Kitaplık İçe Aktarma API'sine geçiş yapma

Bu bölümde, entegrasyonunuzu Dinamik Kitaplık İçe Aktarma API'sini kullanacak şekilde taşımak için gereken adımlar açıklanmaktadır.

Taşıma adımları

Öncelikle doğrudan komut dosyası yükleme etiketini satır içi bootstrap yükleyici etiketiyle değiştirin.

Önce

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

Sonra

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

Ardından, uygulama kodunuzu güncelleyin:

  • initMap() işlevinizi eşzamansız olacak şekilde değiştirin.
  • İhtiyacınız olan kitaplıkları yüklemek ve bunlara erişmek için importLibrary() işlevini çağırın.

Önce

let map;

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

window.initMap = initMap;

Sonra

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