-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
amp-ad type=taboola #1515
amp-ad type=taboola #1515
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
/** | ||
* Copyright 2015 The AMP HTML Authors. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS-IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import {loadScript, validateDataExists, validateExactlyOne} from '../src/3p'; | ||
|
||
/** | ||
* @param {!Window} global | ||
* @param {!Object} data | ||
*/ | ||
export function taboola(global, data) { | ||
// do not copy the following attributes from the 'data' object | ||
// to _tablloa global object | ||
const blackList = ['height', 'initialWindowHeight', 'initialWindowWidth', | ||
'type', 'width', 'placement', 'mode']; | ||
|
||
// ensure we have vlid publisher, placement and mode | ||
// and exactly one page-type | ||
validateDataExists(data, ['publisher', 'placement', 'mode']); | ||
validateExactlyOne(data, ['article', 'video', 'photo', 'search', 'category', | ||
'homepage', 'others']); | ||
|
||
// setup default values for referrer and url | ||
const params = { | ||
referrer: data.referrer || global.context.referrer, | ||
url: data.url || global.context.canonicalUrl | ||
}; | ||
|
||
// copy none blacklisted attribute to the 'params' map | ||
Object.keys(data).forEach(k => { | ||
if (blackList.indexOf(k) === -1) { | ||
params[k] = data[k]; | ||
} | ||
}); | ||
|
||
// push the two object into the '_taboola' global | ||
(global._taboola = global._taboola || []).push([{ | ||
viewId: global.context.pageViewId, | ||
publisher: data.publisher, | ||
placement: data.placement, | ||
mode: data.mode, | ||
framework: 'amp', | ||
container: 'c' | ||
}, | ||
params]); | ||
|
||
// install observation on entering/leaving the view | ||
global.context.observeIntersection(function(changes) { | ||
changes.forEach(function(c) { | ||
if (c.intersectionRect.height) { | ||
global._taboola.push({ | ||
visible: true, | ||
rects: c, | ||
placement: data.placement | ||
}); | ||
} | ||
}); | ||
}); | ||
|
||
// load the taboola loader asynchronously | ||
loadScript(global, `https://cdn.taboola.com/libtrc/${encodeURIComponent(data.publisher)}/loader.js`); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
<!--- | ||
Copyright 2015 The AMP HTML Authors. All Rights Reserved. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS-IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
|
||
# Taboola | ||
|
||
## Example | ||
|
||
### Basic | ||
|
||
```html | ||
<amp-embed width=100 height=283 | ||
type=taboola | ||
layout=responsive | ||
heights="(min-width:1907px) 39%, (min-width:1200px) 46%, (min-width:780px) 64%, (min-width:480px) 98%, (min-width:460px) 167%, 196%" | ||
data-publisher="amp-demo" | ||
data-mode="thumbnails-a" | ||
data-placement="Ads Example" | ||
data-article="auto"> | ||
</amp-embed> | ||
``` | ||
|
||
## Configuration | ||
|
||
For semantics of configuration, please see ad network documentation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you point to a URL that explains what all these mean? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure, I will submit that in a separate PR once i get the documentation up. (I don't want this to delay this merge) |
||
|
||
Supported parameters: | ||
|
||
- data-publisher | ||
- data-placement | ||
- data-mode | ||
- data-article | ||
- data-video | ||
- data-photo | ||
- data-home | ||
- data-category | ||
- data-others | ||
- data-url | ||
- data-referrer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a mechanism to whitelist which embed types are allowed to use
amp-embed
. After rebasing add yourself toAMP_EMBED_ALLOWED
in this file.