✨ add ads: baidu (#19489)

* ✨ add ads: baidu * fix lint errors * delete preconnect delete preconnect, as it has the same domain with prefetch url * Update validator test: ads.out The new `ads.out` is regenerated by running `gulp validator --update-tests`. * Implelmentation of renderStart and noContentAvaliable API Following the guidance of this documentation, [ads README.md](https://github.com/ampproject/amphtml/blob/master/ads/README.md) * fix lint errors. * Adjust the timing of invoking renderStart * Add JS comment Add JS comment to explain why there is no good way to do `noContentAvailable` call. * Rearrage the code in alphabetical order 1. rearrage the code 2. regenerate ads.out * Modify a missing alphabetical order problem * Modify a missing alphabetical order problem
ampproject · Dec 7, 2018 · 384cf61 · 384cf61
1 parent df0fd54
commit 384cf61
Show file tree

Hide file tree

Showing 8 changed files with 121 additions and 0 deletions.
diff --git a/3p/integration.js b/3p/integration.js
@@ -112,6 +112,7 @@ import {amoad} from '../ads/amoad';
 import {appnexus} from '../ads/appnexus';
 import {appvador} from '../ads/appvador';
 import {atomx} from '../ads/atomx';
+import {baidu} from '../ads/baidu';
 import {bidtellect} from '../ads/bidtellect';
 import {brainy} from '../ads/brainy';
 import {bringhub} from '../ads/bringhub';
@@ -330,6 +331,7 @@ register('amoad', amoad);
 register('appnexus', appnexus);
 register('appvador', appvador);
 register('atomx', atomx);
+register('baidu', baidu);
 register('beopinion', beopinion);
 register('bidtellect', bidtellect);
 register('bodymovinanimation', bodymovinanimation);

diff --git a/ads/_config.js b/ads/_config.js
@@ -1073,4 +1073,9 @@ export const adConfig = {
     ],
   },
 
+  'baidu': {
+    prefetch: 'https://dup.baidustatic.com/js/dm.js',
+    renderStartImplemented: true,
+  },
+
 };
diff --git a/ads/baidu.js b/ads/baidu.js
@@ -0,0 +1,58 @@
+/**
+ * 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,
+  validateData,
+} from '../3p/3p';
+
+/**
+ * @param {!Window} global
+ * @param {!Object} data
+ */
+export function baidu(global, data) {
+  validateData(data, ['cproid']);
+
+  const id = '_' + Math.random().toString(36).slice(2);
+  const container = global.document.createElement('div');
+  container.id = id;
+  global.document.getElementById('c').appendChild(container);
+
+  global.slotbydup = global.slotbydup || [];
+  global.slotbydup.push({
+    id: data['cproid'],
+    container: id,
+    display: 'inlay-fix',
+    async: true,
+  });
+
+  global.addEventListener('message', () => {
+    global.context.renderStart();
+  });
+
+  loadScript(
+      global,
+      'https://dup.baidustatic.com/js/dm.js',
+      () => {},
+      () => {
+        // noContentAvailable should be called,
+        // if parent iframe receives no message.
+        // setTimeout can work, but it's not that reliable.
+        // So, only the faliure of JS loading is dealed with for now.
+        global.context.noContentAvailable();
+      }
+  );
+}
diff --git a/ads/baidu.md b/ads/baidu.md
@@ -0,0 +1,34 @@
+<!---
+Copyright 2016 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.
+-->
+
+# Baidu
+
+## Example
+
+```html
+<amp-ad width="300" height="250"
+    type="baidu"
+    data-cproid="{cproid}">
+</amp-ad>
+```
+
+## Configuration
+
+For additional detials and support, see [baidu ad union website](http://union.baidu.com/product/prod-cpro.html).
+
+### Required Parameters
+
+* `data-cproid` - baidu union ad id
diff --git a/examples/ads.amp.html b/examples/ads.amp.html
@@ -102,6 +102,7 @@
         <option>appnexus</option>
         <option>appvador</option>
         <option>atomx</option>
+        <option>baidu</option>
         <option>beopinion</option>
         <option>bidtellect</option>
         <option>brainy</option>
@@ -663,6 +664,12 @@ <h2>Atomx</h2>
       data-id="1234">
   </amp-ad>
 
+  <h2>Baidu</h2>
+  <amp-ad width="300" height="250"
+      type="baidu"
+      data-cproid="u2697398">
+  </amp-ad>
+
   <amp-ad width="300" height="1"
       type="beopinion"
       layout="responsive"

diff --git a/extensions/amp-ad/amp-ad.md b/extensions/amp-ad/amp-ad.md
@@ -231,6 +231,7 @@ See [amp-ad rules](https://github.com/ampproject/amphtml/blob/master/extensions/
 - [AppNexus](../../ads/appnexus.md)
 - [AppVador](../../ads/appvador.md)
 - [Atomx](../../ads/atomx.md)
+- [Baidu](../../ads/baidu.md)
 - [BeOpinion](../amp-beopinion/amp-beopinion.md)
 - [Bidtellect](../../ads/bidtellect.md)
 - [brainy](../../ads/brainy.md)

diff --git a/validator/testdata/feature_tests/ads.html b/validator/testdata/feature_tests/ads.html
@@ -108,6 +108,7 @@
         <option>amoad</option>
         <option>appnexus</option>
         <option>atomx</option>
+        <option>baidu</option>
         <option>bidtellect</option>
         <option>brainy</option>
         <option>bringhub</option>
@@ -451,6 +452,12 @@ <h2>Atomx</h2>
       data-id="1234">
   </amp-ad>
 
+  <h2>Baidu</h2>
+  <amp-ad width="300" height="250"
+      type="baidu"
+      data-cproid="u2697398">
+  </amp-ad>
+
   <h2 id="bidtellect">Bidtellect</h2>
   <amp-ad width=320 height=200
       type="bidtellect"

diff --git a/validator/testdata/feature_tests/ads.out b/validator/testdata/feature_tests/ads.out
@@ -109,6 +109,7 @@ PASS
 |          <option>amoad</option>
 |          <option>appnexus</option>
 |          <option>atomx</option>
+|          <option>baidu</option>
 |          <option>bidtellect</option>
 |          <option>brainy</option>
 |          <option>bringhub</option>
@@ -452,6 +453,12 @@ PASS
 |        data-id="1234">
 |    </amp-ad>
 |
+|    <h2>Baidu</h2>
+|    <amp-ad width="300" height="250"
+|        type="baidu"
+|        data-cproid="u2697398">
+|    </amp-ad>
+|
 |    <h2 id="bidtellect">Bidtellect</h2>
 |    <amp-ad width=320 height=200
 |        type="bidtellect"