Add SDK integration doc for inabox. #23272

lannka · 2019-07-10T23:47:42Z

/cc @zombifier (can't add you to reviewer for some reason).

jeffkaufman · 2019-07-11T15:03:30Z

ads/inabox/inabox-host.md

+# SDK integration for AMPHTML ad
+One goal of AMPHTML ad is for advertisers to create once and use every where.


"everywhere"

jeffkaufman · 2019-07-11T15:04:02Z

ads/inabox/inabox-host.md

+This term describes the situation that an AMPHTML ad is being served
+on an non-AMP page inside an iframe embed or in a WebView for native
+mobile apps. This is very different from how AMPHTML ad gets rendered


"how an AMPHTML ad"

jeffkaufman · 2019-07-11T15:04:18Z

ads/inabox/inabox-host.md

+on an non-AMP page inside an iframe embed or in a WebView for native
+mobile apps. This is very different from how AMPHTML ad gets rendered
+on an AMP page, as in which case, more sources sharing between the 


incomplete?

jeffkaufman · 2019-07-11T15:04:48Z

ads/inabox/inabox-host.md

+
+###### friendly iframe
+An iframe on the host page that has the same origin, so that it has


"An iframe with the same origin as the host page"

jeffkaufman · 2019-07-11T15:05:03Z

ads/inabox/inabox-host.md

+full access to the host page content.
+
+###### foreign iframe


cross-domain ?

jeffkaufman · 2019-07-11T18:38:07Z

ads/inabox/inabox-host.md

+
+In the 2nd step, if the ad is generated by a 3rd party, it's a good 
+ idea to run it through an AMP validator to make sure it is valid AMP.


In cases where the ad network is relying on AMPHTML being trustworthy, running the ad through the validator is more than a good idea!

jeffkaufman · 2019-07-11T18:39:17Z

ads/inabox/inabox-host.md

+`https://cdn.ampproject.org/rtv/{version}/amp4ads-host-v0.js`
+1. Before host script is loaded, ads tag is still responsible to queue 
+up all coming AMP messages into a global array.


coming -> arriving

jeffkaufman · 2019-07-11T18:39:29Z

ads/inabox/inabox-host.md

+corresponding host script: 
+`https://cdn.ampproject.org/rtv/{version}/amp4ads-host-v0.js`
+1. Before host script is loaded, ads tag is still responsible to queue 


to queue -> for queuing

ads/inabox/inabox-host.md

jeffkaufman · 2019-07-11T18:40:12Z

ads/inabox/inabox-host.md

+join us to serve and render AMPHTML ad in various environment, for 
+example regular web & native mobile apps.
+


Mention server-side rendering somewhere?

Hesitated to do so... given it's not really standardized at this moment. It makes quite lot assumption with AMP runtime. There is an on-going effort to open-source some SSR for regular AMP doc. But I don't think it's that ready yet, as nothing about amp4ads is covered.

I think it's worth mentioning that this is in progress, and that if you're looking at serving inabox you should get in touch with the project. Without SSR performance is pretty bad.

added a section for Server side rendering

lannka

comments addressed

ads/inabox/inabox-host.md

lannka · 2019-07-11T19:34:11Z

ads/inabox/inabox-host.md

+full access to the host page content.
+
+###### foreign iframe


lannka · 2019-07-11T19:34:14Z

ads/inabox/inabox-host.md

+
+###### friendly iframe
+An iframe on the host page that has the same origin, so that it has


ads/inabox/inabox-host.md

lannka · 2019-07-11T20:32:09Z

ads/inabox/inabox-host.md

+
+In the 2nd step, if the ad is generated by a 3rd party, it's a good 
+ idea to run it through an AMP validator to make sure it is valid AMP.


lannka · 2019-07-11T20:32:51Z

ads/inabox/inabox-host.md

+`https://cdn.ampproject.org/rtv/{version}/amp4ads-host-v0.js`
+1. Before host script is loaded, ads tag is still responsible to queue 
+up all coming AMP messages into a global array.


lannka · 2019-07-11T20:32:54Z

ads/inabox/inabox-host.md

+corresponding host script: 
+`https://cdn.ampproject.org/rtv/{version}/amp4ads-host-v0.js`
+1. Before host script is loaded, ads tag is still responsible to queue 


lannka · 2019-07-11T20:33:22Z

ads/inabox/inabox-host.md

+communicate to the host page via postMessage API.
+
+## Web SDK (ads tag) integration


how about JS SDK?

lannka · 2019-07-11T20:36:37Z

ads/inabox/inabox-host.md

+join us to serve and render AMPHTML ad in various environment, for 
+example regular web & native mobile apps.
+


Hesitated to do so... given it's not really standardized at this moment. It makes quite lot assumption with AMP runtime. There is an on-going effort to open-source some SSR for regular AMP doc. But I don't think it's that ready yet, as nothing about amp4ads is covered.

jeffkaufman · 2019-07-12T17:16:08Z

ads/inabox/inabox-host.md

+join us to serve and render AMPHTML ad in various environment, for 
+example regular web & native mobile apps.
+


I think it's worth mentioning that this is in progress, and that if you're looking at serving inabox you should get in touch with the project. Without SSR performance is pretty bad.

jeffkaufman · 2019-07-12T17:18:59Z

ads/inabox/inabox-host.md

+1. Add [Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP)
+ rules to the ad response to 1) only load JS files from trusted AMP 
+ CDN; 2) disallow iframe embed.


If you look on a page with GPT you can see Google is currently using:

<meta http-equiv="Content-Security-Policy" content="script-src https://cdn.ampproject.org/;object-src 'none';child-src blob:;frame-src 'none'">

Why not recommend that here? If you're not careful, for example, you can break amp-bind by not allowing workers to be loaded from blobs.

See #21681 where I proposed AMP recommend this CSP.

jeffkaufman · 2019-07-12T17:19:11Z

ads/inabox/inabox-host.md

+ CDN; 2) disallow iframe embed.
+1. Validate the AMPHTML ad using an AMP validator. There is an open 
+source JS implementation for the validator. But for performance reason


jeffkaufman · 2019-07-12T17:19:53Z

ads/inabox/inabox-host.md

+###### Security assurance
+In case that the AMPHTML ad is generated by a 3rd party, to ensure it's
+secure to put it in a friendly iframe, the following 2 enforcements 


"enforcements" -> "restrictions" or "protections"

jeffkaufman · 2019-07-12T17:20:08Z

ads/inabox/inabox-host.md

+host script is to be loaded in that case to fulfill the requirements.
+
+Main work flow:


* Add SDK integration doc for inabox. * Update * address comments * Fix presumit check * Updates

Add SDK integration doc for inabox.

7a397bd

lannka requested a review from jeffkaufman July 10, 2019 23:47

googlebot added the cla: yes label Jul 10, 2019

Update

266a031

jeffkaufman suggested changes Jul 11, 2019

View reviewed changes

address comments

db87784

lannka commented Jul 11, 2019

View reviewed changes

Fix presumit check

7b7cd1e

jeffkaufman approved these changes Jul 12, 2019

View reviewed changes

Updates

8b7598d

lannka merged commit 480db01 into ampproject:master Jul 12, 2019

lannka mentioned this pull request Jul 22, 2019

wg-ads Status Update 2019-07-22 ampproject/wg-monetization#11

Closed

rindo pushed a commit to logly/amphtml that referenced this pull request Jul 24, 2019

Add SDK integration doc for inabox. (ampproject#23272)

21fa954

* Add SDK integration doc for inabox. * Update * address comments * Fix presumit check * Updates

lannka mentioned this pull request Jul 30, 2019

wg-ads Quarterly Status Update 2019-08 ampproject/wg-monetization#12

Closed

thekorn pushed a commit to edelight/amphtml that referenced this pull request Sep 11, 2019

Add SDK integration doc for inabox. (ampproject#23272)

97ca65c

* Add SDK integration doc for inabox. * Update * address comments * Fix presumit check * Updates

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SDK integration doc for inabox. #23272

Add SDK integration doc for inabox. #23272

lannka commented Jul 10, 2019

jeffkaufman Jul 11, 2019

jeffkaufman Jul 11, 2019

jeffkaufman Jul 11, 2019

jeffkaufman Jul 11, 2019

lannka Jul 11, 2019

jeffkaufman Jul 11, 2019

lannka Jul 11, 2019

jeffkaufman Jul 11, 2019

lannka Jul 11, 2019

jeffkaufman Jul 11, 2019

lannka Jul 11, 2019

jeffkaufman Jul 11, 2019

lannka Jul 11, 2019

jeffkaufman Jul 11, 2019

lannka Jul 11, 2019

jeffkaufman Jul 12, 2019

lannka Jul 12, 2019

lannka left a comment

lannka Jul 11, 2019

lannka Jul 11, 2019

lannka Jul 11, 2019

lannka Jul 11, 2019

lannka Jul 11, 2019

lannka Jul 11, 2019

lannka Jul 11, 2019

jeffkaufman Jul 12, 2019

jeffkaufman Jul 12, 2019

lannka Jul 12, 2019

jeffkaufman Jul 12, 2019

lannka Jul 12, 2019

jeffkaufman Jul 12, 2019

lannka Jul 12, 2019

jeffkaufman Jul 12, 2019

lannka Jul 12, 2019

		# SDK integration for AMPHTML ad
		One goal of AMPHTML ad is for advertisers to create once and use every where.


		###### friendly iframe
		An iframe on the host page that has the same origin, so that it has


		In the 2nd step, if the ad is generated by a 3rd party, it's a good
		idea to run it through an AMP validator to make sure it is valid AMP.

		join us to serve and render AMPHTML ad in various environment, for
		example regular web & native mobile apps.

		communicate to the host page via postMessage API.

		## Web SDK (ads tag) integration

		host script is to be loaded in that case to fulfill the requirements.

		Main work flow:

Add SDK integration doc for inabox. #23272

Add SDK integration doc for inabox. #23272

Conversation

lannka commented Jul 10, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lannka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment