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

Joining Analytics Sessions

Introduction

Linker is an amp-analytics feature to join user sessions from the AMP Cache domain to publisher origin domains. For complete documentation please see the components' reference.

If you would like to learn more aboout client ids in AMP, you may find a brief summary here, as well as Google Analytics specific information here.

To see this whole process in action, please follow this link.

Setup

Import the amp-analytics component in the header.

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

Using AMP Linker with your existing analytics provider

If your analytics provider is already supporting the Linker functionality, turning it on is a simple configuration change. Add the following to your exisisting amp-analytics configuration.

<div>
  <amp-analytics type="googleanalytics">
    <script type="application/json">
      {
        "linkers": {
          "enabled": true
        }
      }
    </script>
  </amp-analytics>
</div>

Using AMP Linker with custom analytics

If you wish to setup your own configuration, AMP linker supports that as well. In the following example a linker parameter with the name linker1 will be appended to outgoing links. The value of this parameter will include any key-value pairs in the ids configuration object. Specifically in this example, two entries will be passed along. A key-value pair with the key _a and the value returned by the CLIENT_ID macro, and a key of v with the value 123. You may include as many entries in the ids object as you wish.

<amp-analytics>
  <script type="application/json">
    {
      ... // existing amp-analytics configuration
      "linkers": {
        "linker1": {
          "ids": {
            "_a": "CLIENT_ID(_a)",
            "v": 123
          },
          "enabled": true
        }
      }
    }
  </script>
</amp-analytics>

Using AMP Linker with multiple linkers

You may also want to configure multiple linkers on one page. To do this you would add an entry to the linkers object for each linker. You may also enable all the linkers at once by moving the enabled: true entry one level below the linkers object.

<amp-analytics>
  <script type="application/json">
    {
      "linkers": {
        "enabled": true,
        "linker1": {
          "ids": {
            "_a": "CLIENT_ID(_a)",
          }
        },
        "linker2": {
          "ids": {
            "b": "CLIENT_ID(b)",
          }
        }
      }
    }
  </script>
</amp-analytics>

Destination Domains

Each linker will also accept an optional destinationDomains entry. You may use this to only add linker parameters to specific destinations. If this entry is omitted it will default to the source domain as well as the canonical domain. In the example below, only links to the example.com and ampproject.org domains would be decorated. These must be included as an array of domains.

<amp-analytics>
  <script type="application/json">
    {
      "linkers": {
        "enabled": true,
        "destinationDomains": ['example.com'],
        "linker1": {
          "ids": {
            "_foo": "CLIENT_ID(_foo)"
          }
        }
      }
  </script>
</amp-analytics>
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