✨ Ssp params extended (ampproject#35957)

Co-authored-by: PetrBlaha <petr.blaha@firma.seznam.cz>
BroadBandyDev · Sep 9, 2021 · 2a3a995 · 2a3a995
1 parent eb6d869
commit 2a3a995
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 5 deletions.
diff --git a/ads/vendors/ssp.js b/ads/vendors/ssp.js
@@ -117,7 +117,7 @@ export function forceElementReflow(element) {
  */
 export function ssp(global, data) {
   // validate AMP input data- attributes
-  validateData(data, ['position'], ['site']);
+  validateData(data, ['position'], ['site', 'said']);
 
   let position = {id: -1};
 
@@ -169,6 +169,7 @@ export function ssp(global, data) {
 
         sssp.config({
           site: data.site || global.context.canonicalUrl,
+          said: data.said || null,
         });
 
         // propagate relevant data across all ad units

diff --git a/ads/vendors/ssp.md b/ads/vendors/ssp.md
@@ -27,6 +27,7 @@
   width="480"
   height="300"
   type="ssp"
+  data-said="abcd1234"
   data-position='{ "id": "id-2", "width": "480", "height": "300", "zoneId": "1234" }'
 >
 </amp-ad>
@@ -42,13 +43,19 @@ Required parameters:
 | height        | Height of AMP Ad (grey fixed border) | `200`                                                                 |
 | type          | Type of amp-ad                       | `ssp`                                                                 |
 | data-position | JSON stringified position object     | `{ "id": "id-1", "width": "480", "height": "300", "zoneId": "1234" }` |
+| data-said     | SAID identificator                   | `abcd1234`                                                            |
 
 ### `data-position`
 
 -   Object must have required keys `id`, `width`, `height`, `zoneId` (Watch out for uppercase "I" in "id").
 -   Every position MUST have unique `id`, if you duplicate some id, Ad may be used from another position.
 -   Attributes `width` and `height` are from AMP specification, and they will set fixed border around Ad.
--   Attributes `data-width` and `data-height` are used to fetch SSP Ads on the server (They can different).
+-   Attributes `data-width` and `data-height` are used to fetch SSP Ads on the server (They can be different).
+
+### `data-said`
+
+-   Optional
+-   String representing `said` identificator
 
 ## Contact
 

diff --git a/test/unit/ads/test-ssp.js b/test/unit/ads/test-ssp.js
@@ -26,6 +26,7 @@ describes.fakeWin('amp-ad-ssp', {}, (env) => {
     commonData = {
       width: '200',
       height: '200',
+      said: 'said1234',
       position:
         '{ "id": "id-1", "width": "200", "height": "200", "zoneId": "1234" }',
     };
@@ -74,11 +75,12 @@ describes.fakeWin('amp-ad-ssp', {}, (env) => {
       {
         width: '200',
         height: '200',
+        said: 'said1234',
         position:
           '{ "id": "id-1", "width": "200", "height": "200", "zoneId": "1234" }',
       },
       ['position'],
-      ['site']
+      ['site', 'said']
     );
   });
 
@@ -156,7 +158,10 @@ describes.fakeWin('amp-ad-ssp', {}, (env) => {
     ssp(win, commonData);
 
     expect(sssp.config).to.have.been.calledOnce;
-    expect(sssp.config).to.have.been.calledWith({site: 'https://test.com'});
+    expect(sssp.config).to.have.been.calledWith({
+      site: 'https://test.com',
+      said: 'said1234',
+    });
   });
 
   it('should call context.noContentAvailable() when position is invalid', () => {
@@ -238,7 +243,14 @@ describes.fakeWin('amp-ad-ssp', {}, (env) => {
 
     expect(sssp.getAds).to.have.been.calledOnce;
     expect(sssp.getAds).to.have.been.calledWith(
-      [{id: 'id-1', width: '200', height: '200', zoneId: '1234'}],
+      [
+        {
+          id: 'id-1',
+          width: '200',
+          height: '200',
+          zoneId: '1234',
+        },
+      ],
       {AMPcallback: sandbox.match.func}
     );
   });