@68publishers/amp-client
v1.9.0
Published
JS Client for 68publishers/amp
Readme
Installation
The preferred installation method is using the package manager.
$ npm install @68publishers/amp-client
# or
$ yarn add @68publishers/amp-clientThe client can also be imported from the CDN. Two versions are available:
https://unpkg.com/@68publishers/amp-client/dist/amp-client.min.jshttps://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/[email protected]/dist/amp-client.min.js"></script>
<!-- OR if you are using lodash on your website -->
<script src="https://unpkg.com/@68publishers/[email protected]/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 - 2.16 | 1 | |
| ~1.6.0 | 2.16 | 1 | |
| ~1.7.0 | 2.17 | 1 | |
| ~1.8.0 | 2.18 | 1/2 | |
| ~1.9.0 | >=2.19 | 1/2 | |
Integration
For integration instructions follow the Integration guide.
License
The package is distributed under the MIT License. See LICENSE for more information.
