AMP Conf 2019. April 17/18. Tokyo.
AMP
  • websites

amp-geo

Introduction

The amp-geo extension makes it possible to vary small sections of content based on an approximation of the users' country-level location, similar to the level of an ISO Country Code. The amp-geo component also provides a simple mechanism to group locations, making it easier to apply attributes to several geos at once.

Setup

Import the amp-geo component.

<script async custom-element="amp-geo" src="https://cdn.ampproject.org/v0/amp-geo-0.1.js"></script>

Basic usage

amp-geo components is configured via json and every page can only contain one amp-geo tag. We are showing different samples of amp-geo on this page and we will explain the json configuration for each sample.

<amp-geo layout="nodisplay">
  <script type="application/json">
    {
      "AmpBind": true,
      "ISOCountryGroups": {
        "soccer": ["au", "ca", "ie", "nz", "us", "za"],
        "football": ["unknown"],
        "eea": ["preset-eea"]
      }
    }
  </script>
</amp-geo>

amp-geo makes available a class amp-iso-country-XX where XX is an ISO Country Code.

In the following example, the component determines the ISO Country Code corresponding to the user's approximate location. If this is "ca" (Canada), the page displays a maple leaf flag, otherwise the American flag.

For testing, if you want to force the country to be Canada, you can append #amp-geo=ca to the URL like https://amp.dev/documentation/examples/components/amp-geo#amp-geo=ca and enable the dev-channel here.

Read more about debugging amp-geo on the official doc

<div class="flag"></div>

Country grouping

Here we are using the amp-geo grouping feature to define two different groups of ISO country codes: one for those who play soccer and one for those who play football.

Notice how we have a group containing 'unknown' in the amp-geo tag: if the country cannot be determined, the value is set to 'unknown'.

When using the grouping feature with amp-geo at least one group must contain 'unknown'. When using grouping, amp-geo makes available

a class amp-geo-group-XX where XX is the name of the group determined by amp-geo.

The game is called

<p>The game is called
  <span class="football"></span>
</p>

Integration with amp-bind

If the AMPBind key is present in the amp-geo json configuration, amp-geo inserts an amp-state tag containing the current ISOCountry and group information.

<div>
  <button on="tap:AMP.setState({ showLocation: true })">Where am I?</button>
  <p hidden
    [hidden]="!showLocation">ISOCountry Code:
    <span [text]="ampGeo.ISOCountry" />
  </p>
  <p hidden
    [hidden]="!showLocation">Matched Country Groups:
    <span [text]="ampGeo.ISOCountryGroups.join(', ')" />
  </p>
</div>

Preset country groups

GOOGLE AND THE AMP PROJECT ARE PROVIDING THIS INFORMATION AS A COURTESY BUT DO NOT GUARANTEE THE ACCURACY OR COMPLETENESS OF ANY INFORMATION CONTAINED HEREIN. THIS INFORMATION IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

amp-geo supports preset country lists for specific regions. For example, there is a preset for the European Economic Area (EEA) preset-eea which we assign to an ISOCountryGroup named eea:

   "ISOCountryGroups": {
      "eea": [ "preset-eea" ],
      ...
   }

In this sample, we show a different message to users inside and outside the EEA based on the presence of the amp-geo-group-eea class in the body tag using the following css rule:

   body.amp-geo-group-eea .message-non-eea,
   body:not(.amp-geo-group-eea) .message-eea {
     display: none;
   }

Which we then can use to show different messages to users in and outside the EEA:

You're in the EU.

You're outside the EU.

<div>
  <p class="message-eea">You're in the EU.</p>
  <p class="message-non-eea">You're outside the EU.</p>
</div>
Need further explanation?

If the explanations on this page don't cover all of your questions feel free to reach out to other AMP users to discuss your exact use case.

Go to Stack Overflow
An unexplained feature?

The AMP project strongly encourages your participation and contributions! We hope you'll become an ongoing participant in our open source community but we also welcome one-off contributions for the issues you're particularly passionate about.

Edit sample on GitHub