Skip to content

📣 JavaScript Client for AMP - Advertising Management Platform

License

Notifications You must be signed in to change notification settings

68publishers/amp-client-js

Repository files navigation

JS Client JS Logo

AMP Client JS

📣 JS Client for Advertising Management Platform

Installation

The preferred installation method is using the package manager.

$ npm install @68publishers/amp-client
# or
$ yarn add @68publishers/amp-client

The client can also be imported from the CDN. Two versions are available:

  • https://unpkg.com/@68publishers/amp-client/dist/amp-client.min.js
  • https://unpkg.com/@68publishers/amp-client/dist/amp-client.standalone.min.js

The only difference is the first one is bundled with components template and merge from the lodash library and the standalone version not. If you are using the lodash on your website then use the standalone version of AMP client. In that case, lodash has to be imported as a first.

Prefer to use CDN links with a labeled version to prevent BC breaks e.g.:

<script src="https://unpkg.com/@68publishers/amp-client@1.7.0/dist/amp-client.min.js"></script>
<!-- OR if you are using lodash on your website -->
<script src="https://unpkg.com/@68publishers/amp-client@1.7.0/dist/amp-client.standalone.min.js"></script>

Versions compatibility matrix

Client Version AMP version API version Note
~1.0.0 1.0 - 2.7 1
~1.1.0 1.0 - 2.7 1 API supports only GET requests (cannot set the method: "POST" option)
~1.1.0 2.8 1
~1.2.0 2.8 - 2.10 1 Limited metrics functionality - banner_name, position_id, position_name, campaign_id and campaign_name fields are not sent.
~1.2.0 2.11 1 The option origin has no effect, as it is not handled by AMP.
~1.3.0 2.12 1
~1.4.0 2.12 1 Adds support for server-side rendered banners (68publishers/amp-client-php).
~1.4.0 2.13 1 Missing support for embed banners on the client's side. Banners marked as embed in AMP administration will be generated normally.
~1.5.0 >=2.13 1
~1.6.0 >=2.16 1

Integration

For integration instructions follow the Integration guide.

License

The package is distributed under the MIT License. See LICENSE for more information.

About

📣 JavaScript Client for AMP - Advertising Management Platform

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •