Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TrafficStars ad network support #35836

Merged
merged 1 commit into from
Aug 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions 3p/vendors/trafficstars.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// src/polyfills.js must be the first import.
import '#3p/polyfills';

import {register} from '#3p/3p';
import {draw3p, init} from '#3p/integration-lib';

import {trafficstars} from '#ads/vendors/trafficstars';

init(window);
register('trafficstars', trafficstars);

window.draw3p = draw3p;
5 changes: 5 additions & 0 deletions ads/_config.js
Original file line number Diff line number Diff line change
Expand Up @@ -1236,6 +1236,11 @@ const adConfig = jsonConfiguration({
renderStartImplemented: true,
},

'trafficstars': {
prefetch: 'https://cdn.tsyndicate.com/sdk/v1/master.spot.js',
renderStartImplemented: true,
},

'triplelift': {},

'trugaze': {
Expand Down
83 changes: 83 additions & 0 deletions ads/vendors/trafficstars.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import {loadScript, validateData} from '#3p/3p';
import {parseJson} from '#core/types/object/json';

const requiredParams = ['spot'];
const optionsParams = [
'uploadLink',
'nativeSettings',
'wrapperStyles',
'iFrameStyles',
'queriesParams',
'onLoadResponseHook',
'onSpotRenderedHook',
'onLoadErrorHook',
];
const adContainerId = 'trafficstars_id';

/**
* @param {!Window} global
* @param {!Object} data
*/
export function trafficstars(global, data) {
// ensure we have valid widgetIds value
validateData(data, requiredParams, optionsParams);

const adContainer = global.document.getElementById('c');
const adNativeContainer = getAdContainer(global);
const initScript = getInitAdScript(global, data);

adContainer.appendChild(adNativeContainer);

// load the TrafficStars master spot JS file
loadScript(global, 'https://cdn.tsyndicate.com/sdk/v1/master.spot.js', () => {
global.document.body.appendChild(initScript);
});
}

/**
* @param {!Object} data
* @return {JsonObject}
*/
function getInitData(data) {
const initKeys = requiredParams.concat(optionsParams);
const initParams = {};

initKeys.forEach((key) => {
if (key in data) {
initParams[key] = data[key];
}
});

initParams['containerId'] = adContainerId;

return parseJson(initParams);
}

/**
* @param {!Window} global
* @return {?Node}
*/
function getAdContainer(global) {
const container = global.document.createElement('div');

container['id'] = adContainerId;

return container;
}

/**
* @param {!Window} global
* @param {!Object} data
* @return {?Node}
*/
function getInitAdScript(global, data) {
const scriptElement = global.document.createElement('script');
const initData = getInitData(data);
const initScript = global.document.createTextNode(
`TsMasterSpot(${JSON.stringify(initData)});`
);

scriptElement.appendChild(initScript);

return scriptElement;
}
42 changes: 42 additions & 0 deletions ads/vendors/trafficstars.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# TrafficStars

Serves ads from the [TrafficStars](https://www.trafficstars.com/).

## Example

```html
<amp-embed
width="640"
height="320"
type="trafficstars"
data-spot="{string}"
data-upload-link="{string}"
data-queries-params="{string[]}"
data-native-settings="{Object}"
data-wrapper-styles="{ElementCSSInlineStyle}"
data-iframe-styles="{ElementCSSInlineStyle}"
data-on-load-response-hook="{(data: TMasterSpotData) => void}"
data-on-spot-rendered-hook="{(element: HTMLElement) => void}"
data-on-load-error-hook="{() => void}"
>
</amp-embed>
```

## Configuration

For details on the configuration semantics, please contact the ad network or refer to their documentation.

### Required parameters

- `data-spot` - code spot

### Optional parameters

- `uploadLink` - link for ad request
- `queriesParams` - params for ad request
- `nativeSettings` - settings for native ad
- `wrapperStyles` - styles for native ad
- `iFrameStyles` - styles for banner ad
- `onLoadResponseHook` - hook after ad request success
- `onSpotRenderedHook` - hook after ad render success
- `onLoadErrorHook` - hook after ad request error
1 change: 1 addition & 0 deletions examples/amp-ad/ads.amp.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@
<option>temedya</option>
<option>torimochi</option>
<option>tracdelight</option>
<option>trafficstars</option>
<option>triplelift</option>
<option>trugaze</option>
<option>uas</option>
Expand Down
1 change: 1 addition & 0 deletions extensions/amp-ad/amp-ad.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,7 @@ See [amp-ad rules](validator-amp-ad.protoascii) in the AMP validator specificati
- [Teads](../../ads/vendors/teads.md)
- [torimochi](../../ads/vendors/torimochi.md)
- [Tracdelight](../../ads/vendors/tracdelight.md)
- [TrafficStars](../../ads/vendors/trafficstars.md)
- [TripleLift](../../ads/vendors/triplelift.md)
- [Trugaze](../../ads/vendors/trugaze.md)
- [UZOU](../../ads/vendors/uzou.md)
Expand Down