Region Code Biasing (US)

  • This sample demonstrates how to send a geocoding request for "Toledo" and receive a US-based result using the Google Maps JavaScript API.

  • The returned geocoding result can vary depending on the specified map region.

  • Sample code is provided in both TypeScript and JavaScript, along with HTML and CSS for displaying the results on a map.

  • Users can try the sample using JSFiddle or Google Cloud Shell, or clone the repository and run it locally with Node.js.

This demonstrates sending a geocoding request for "Toledo" and receiving a result in the US. The result returned depends on the region of the map. See also the demo for the ES region.

Read the documentation.

TypeScript

async function init(): Promise<void> {
    const [{ Geocoder }, { AdvancedMarkerElement }] = await Promise.all([
        google.maps.importLibrary('geocoding'),
        google.maps.importLibrary('marker'),
        google.maps.importLibrary('maps'),
    ]);

    const mapElement = document.querySelector('gmp-map')!;
    const innerMap = mapElement.innerMap;
    const geocoder = new Geocoder();

    geocoder
        .geocode({ address: 'Toledo' })
        .then((response) => {
            const position = response.results[0].geometry.location;

            innerMap.setCenter(position);
            new AdvancedMarkerElement({
                map: innerMap,
                position,
            });
        })
        .catch((e: unknown) => {
            window.alert(
                'Geocode was not successful for the following reason: ' + e
            );
        });
}

void init();

JavaScript

async function init() {
    const [{ Geocoder }, { AdvancedMarkerElement }] = await Promise.all([
        google.maps.importLibrary('geocoding'),
        google.maps.importLibrary('marker'),
        google.maps.importLibrary('maps'),
    ]);

    const mapElement = document.querySelector('gmp-map');
    const innerMap = mapElement.innerMap;
    const geocoder = new Geocoder();

    geocoder
        .geocode({ address: 'Toledo' })
        .then((response) => {
            const position = response.results[0].geometry.location;

            innerMap.setCenter(position);
            new AdvancedMarkerElement({
                map: innerMap,
                position,
            });
        })
        .catch((e) => {
            window.alert(
                'Geocode was not successful for the following reason: ' + e
            );
        });
}

void init();

CSS

/* 
 * Optional: Makes the sample page fill the window. 
 */
html,
body {
    height: 100%;
    margin: 0;
    padding: 0;
}

HTML

<html>
    <head>
        <title>Geocoding Region - US</title>

        <link rel="stylesheet" type="text/css" href="./style.css" />
        <script type="module" src="./index.js"></script>
        <script>
            // prettier-ignore
            (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: "GOOGLE_MAPS_API_KEY",
                region: "US" 
            });
        </script>
    </head>
    <body>
        <gmp-map zoom="8" map-id="DEMO_MAP_ID"></gmp-map>
    </body>
</html>

Clone Sample

Git and Node.js are required to run this sample locally. Follow these instructions to install Node.js and NPM. You will also need a Google Maps API key.

The following commands clone the repository, install dependencies, and copy the environment file. 

  git clone https://github.com/googlemaps-samples/js-api-samples.git
  cd js-api-samples
  npm i
  cp .env.template .env

Once you copy the environment file, make sure to open the .env file and replace <Insert your own development API key here> with your actual API key before starting the sample. 

  cd samples/geocoding-region-us
  npm start