Geocoding Component Restrictions

This example creates a request to the geocoding service that restricts the results to a particular postal area within Sydney, Australia.

Read the documentation.

TypeScript

function initMap(): void {
  const geocoder = new google.maps.Geocoder();
  const map = new google.maps.Map(
    document.getElementById("map") as HTMLElement,
    {
      zoom: 8,
      center: { lat: -33.865, lng: 151.209 },
    }
  );

  (document.getElementById("submit") as HTMLElement).addEventListener(
    "click",
    () => {
      geocodeAddress(geocoder, map);
    }
  );
}

function geocodeAddress(geocoder: google.maps.Geocoder, map: google.maps.Map) {
  geocoder.geocode(
    {
      componentRestrictions: {
        country: "AU",
        postalCode: "2000",
      },
    },
    (
      results: google.maps.GeocoderResult[],
      status: google.maps.GeocoderStatus
    ) => {
      if (status === "OK") {
        map.setCenter(results[0].geometry.location);
        new google.maps.Marker({
          map,
          position: results[0].geometry.location,
        });
      } else {
        window.alert(
          "Geocode was not successful for the following reason: " + status
        );
      }
    }
  );
}

JavaScript

function initMap() {
  const geocoder = new google.maps.Geocoder();
  const map = new google.maps.Map(document.getElementById("map"), {
    zoom: 8,
    center: { lat: -33.865, lng: 151.209 },
  });
  document.getElementById("submit").addEventListener("click", () => {
    geocodeAddress(geocoder, map);
  });
}

function geocodeAddress(geocoder, map) {
  geocoder.geocode(
    {
      componentRestrictions: {
        country: "AU",
        postalCode: "2000",
      },
    },
    (results, status) => {
      if (status === "OK") {
        map.setCenter(results[0].geometry.location);
        new google.maps.Marker({
          map,
          position: results[0].geometry.location,
        });
      } else {
        window.alert(
          "Geocode was not successful for the following reason: " + status
        );
      }
    }
  );
}

CSS

/* Always set the map height explicitly to define the size of the div
       * element that contains the map. */
#map {
  height: 100%;
}

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

#floating-panel {
  position: absolute;
  top: 10px;
  left: 25%;
  z-index: 5;
  background-color: #fff;
  padding: 5px;
  border: 1px solid #999;
  text-align: center;
  font-family: "Roboto", "sans-serif";
  line-height: 30px;
  padding-left: 10px;
}

HTML

<!DOCTYPE html>
<html>
  <head>
    <title>Geocoding Component Restriction</title>
    <script src="https://polyfill.io/v3/polyfill.min.js?features=default"></script>
    <link rel="stylesheet" type="text/css" href="./style.css" />
    <script src="./index.js"></script>
  </head>
  <body>
    <div id="floating-panel">
      <pre>componentRestrictions: {country: "AU", postalCode: "2000"}</pre>
      <button id="submit">Geocode</button>
    </div>
    <div id="map"></div>

    <!-- Async script executes immediately and must be after any DOM elements used in callback. -->
    <script
      src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=&v=weekly"
      async
    ></script>
  </body>
</html>

All

<!DOCTYPE html>
<html>
  <head>
    <title>Geocoding Component Restriction</title>
    <script src="https://polyfill.io/v3/polyfill.min.js?features=default"></script>
    <style type="text/css">
      /* Always set the map height explicitly to define the size of the div
       * element that contains the map. */
      #map {
        height: 100%;
      }

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

      #floating-panel {
        position: absolute;
        top: 10px;
        left: 25%;
        z-index: 5;
        background-color: #fff;
        padding: 5px;
        border: 1px solid #999;
        text-align: center;
        font-family: "Roboto", "sans-serif";
        line-height: 30px;
        padding-left: 10px;
      }
    </style>
    <script>
      function initMap() {
        const geocoder = new google.maps.Geocoder();
        const map = new google.maps.Map(document.getElementById("map"), {
          zoom: 8,
          center: { lat: -33.865, lng: 151.209 },
        });
        document.getElementById("submit").addEventListener("click", () => {
          geocodeAddress(geocoder, map);
        });
      }

      function geocodeAddress(geocoder, map) {
        geocoder.geocode(
          {
            componentRestrictions: {
              country: "AU",
              postalCode: "2000",
            },
          },
          (results, status) => {
            if (status === "OK") {
              map.setCenter(results[0].geometry.location);
              new google.maps.Marker({
                map,
                position: results[0].geometry.location,
              });
            } else {
              window.alert(
                "Geocode was not successful for the following reason: " + status
              );
            }
          }
        );
      }
    </script>
  </head>
  <body>
    <div id="floating-panel">
      <pre>componentRestrictions: {country: "AU", postalCode: "2000"}</pre>
      <button id="submit">Geocode</button>
    </div>
    <div id="map"></div>

    <!-- Async script executes immediately and must be after any DOM elements used in callback. -->
    <script
      src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=&v=weekly"
      async
    ></script>
  </body>
</html>
function initMap() { const geocoder = new google.maps.Geocoder(); const map = new google.maps.Map(document.getElementById("map"), { zoom: 8, center: { lat: -33.865, lng: 151.209 }, }); document.getElementById("submit").addEventListener("click", () => { geocodeAddress(geocoder, map); }); } function geocodeAddress(geocoder, map) { geocoder.geocode( { componentRestrictions: { country: "AU", postalCode: "2000", }, }, (results, status) => { if (status === "OK") { map.setCenter(results[0].geometry.location); new google.maps.Marker({ map, position: results[0].geometry.location, }); } else { window.alert( "Geocode was not successful for the following reason: " + status ); } } ); }
/* Always set the map height explicitly to define the size of the div * element that contains the map. */ #map { height: 100%; } /* Optional: Makes the sample page fill the window. */ html, body { height: 100%; margin: 0; padding: 0; } #floating-panel { position: absolute; top: 10px; left: 25%; z-index: 5; background-color: #fff; padding: 5px; border: 1px solid #999; text-align: center; font-family: "Roboto", "sans-serif"; line-height: 30px; padding-left: 10px; }
<!DOCTYPE html> <html> <head> <title>Geocoding Component Restriction</title> <script src="https://polyfill.io/v3/polyfill.min.js?features=default"></script> <!-- jsFiddle will insert css and js --> </head> <body> <div id="floating-panel"> <pre>componentRestrictions: {country: "AU", postalCode: "2000"}</pre> <button id="submit">Geocode</button> </div> <div id="map"></div> <!-- Async script executes immediately and must be after any DOM elements used in callback. --> <script src="https://maps.googleapis.com/maps/api/js?key=AIzaSyBIwzALxUPNbatRBj3Xi1Uhp0fFzwWNBkE&callback=initMap&libraries=&v=weekly" async ></script> </body> </html>

Create a starter application from sample

A skeleton starter application using TypeScript, Webpack, and Babel can be generated from this sample using one of the methods below.

Run Locally

Node.js is required to run this sample locally. Follow these instructions to install Node.js and NPM.

npx @googlemaps/js-samples init geocoding-component-restriction DESTINATION_FOLDER

Run in Google Cloud Shell

Google Cloud Shell is an interactive shell environment for Google Cloud Platform that makes it easy for you to learn and experiment with GCP and manage your projects and resources from your web browser.

Run in Cloud Shell