No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
lannka Merge pull request #4 from rudygalfi/patch-1
Clarify availability of AMP Client ID API
Latest commit 04ede36 Feb 6, 2018
Permalink
Failed to load latest commit information.
.gitignore Implementation. Sep 22, 2017
CONTRIBUTING.md init Sep 19, 2017
LICENSE init Sep 19, 2017
README.md Clarify availability of AMP Client ID API Feb 6, 2018
ampcid.extern.js fix types Oct 12, 2017
example.html Implementation. Sep 22, 2017
index.js nit Oct 23, 2017
package.json Implementation. Sep 22, 2017
test.js add test for no token Oct 24, 2017

README.md

NOTE: The library below is intended to be used in conjuction with the yet-to-be-released AMP Client ID API for custom integrations. Code and JavaScript libraries below aren't useful yet. If you want to use the AMP Client ID API in conjuction with Google Analytics, please consult the documentation for the AMP Client ID API in Google Analytics.

Google AMP Client ID Library

This Google AMP Client ID library provides a script that you can use to integrate the Google AMP Client ID API in your non-AMP pages for custom analytic systems (i.e., for in-house analytics tracking or for analytics vendors that are not preconfigured for use with the API. The Google AMP Client ID API provides you with the ability to consistently track users across AMP and non-AMP pages.

You can learn more about the API and how to customize your analytics systems in the Google AMP Client ID API documentation.

Usage

Choose one of the following options to integrate the Google AMP Client ID Library in your non-AMP pages:

Option 1: Use the compiled binary served on Google CDN (preferred)

  1. Add the following <script> tag in your HTML <head> section:

    <script async src="https://ampcid.google.com/client/v1.js"></script>
  2. In your JavaScript code, wait for the library load, then call the getScopedCid method:

    function ampCidApiOnload(callback) {
      (self.googleAmpCidApiOnload = self.googleAmpCidApiOnload || []).push(callback);
    }
    
    ampCidApiOnload(function(api) {
      api.getScopedCid('scope-abc', 'YOUR_API_KEY', function(err, cid) {
        if (err) {
          alert('Error: ' + err);
        } else {
          alert('Client ID:' + cid);
        }
      });
    });

Option 2: Copy the code into your own project

The recommended integration of the Google AMP Client ID library is to use binary that is served from CDN (option 1), which saves you from any future version updates. However, if you prefer not to load the extra binary, you can compile the code into your own project.

Specification

Methods

getScopedCid(scope, apiKey, callback): Returns the scoped client ID.

  • Parameters:
    • scope: The scope of the client ID, specified as a string. You can get different client IDs for the same user client by applying a different scope value. See Determine your AMP client ID scope for further information.
    • apiKey: The unique API key for the request, specified as a string. Apply for an API key via the Google AMP Client ID API in the Google API Console.
    • callback: A callback function that takes two parameters: function(err, cid).
      • err: An Error object if there is any error, otherwise null.
      • cid: The client ID string returned from the server.
  • Returns:
    • cid: A scoped client ID that can be one of the following:
      • A string starting with amp- followed by URL safe Base64 characters (for example, amp-UaFdEOQkTib3XGbPVGAJt0OQV8_1Hpmp8EsQOM5EySjmiK9UCs7yTCt219Fz2gER.
      • null, if the client ID was not found.
      • undefined, if an error occurred. An Error object is returned in this case.
      • '$OPT_OUT'. The client has opted out client ID tracking.

Cookie usage

The Google AMP Client ID library uses the AMP_TOKEN cookie to store information. This cookie serves two purposes:

  1. To persist a security token that is received from the API server, which can be used to exchange CID values next time.
  2. To act as a lock so that no concurrent requests are being sent.

Testing

To run tests on the Google AMP Client ID library, perform the following:

$ npm install
$ npm run test