Contains the steps to implement IAS Open Measurement Display (OMID) for Web for VAST providers.
This document guides you through the steps to implement IAS Open Measurement Display (OMID) for Web for VAST providers.
1) Include script in <Extensions> node as shown:
<Extensions>
<Extension type="AdVerifications">
<AdVerifications>
<Verification vendor="ias">
<JavaScriptResource apiFramework="omid" browserOptional=”false”> <![CDATA[https://static.adsafeprotected.com/vans-adapter-omid-fw.js?advEntityId=123&pubEntityId=234&debug=true]]>
</JavascriptResource>
</Verification>
</AdVerifications>
</Extension>
</Extensions>
2) Don't include <VerificationParameters>
Include script directly as <AdVerifications>
Don’t include <VerificationParameters>
vendor attribute in node should always be "ias".
browserOptional attribute is always "false" for the web OMID script (VANS adapter), so IAS isn't loaded by mistake into DOMless environments where IAS isn't able to measure.
This is the URL in the CDATA in the <JavascriptResource> node.
Production | QA/Staging (Do NOT include in production tags) | |
CM | protocol://static.adsafeprotected.com/vans-adapter-omid-cm.js | protocol://static.test-adsafeprotected.com/vans-adapter-omid-cm.js |
FW | protocol://static.adsafeprotected.com/vans-adapter-omid-fw.js | protocol://static.test-adsafeprotected.com/vans-adapter-omid-fw.js |
Note: For QA/test tags, notice that "adsafeprotected.com" and "test-adsafeprotected.com" are different hostnames.
Note: After implementing the IAS OMID for web integration, give IAS a test server/test tags to add to IAS's regression testing.
All parameters to be passed to IAS for reporting should be passed to the OMID VANS adapter by appending it to the end of the adapter script as query parameters - including, but not limited to:
IDs like advEntityId/pubEntityId
Debug parameters for troubleshooting
Additional IDs
If these IDs are not appended correctly, clients will not receive reporting.
IAS recommends implementing this in as flexible a fashion as possible, especially given the need for CM macro support in FW.
For test/QA tags, automatically append debug=true to the adapter script if it is not provided already.
Implement some way for IAS to pass parameters to the adapter for testing - whether it's in the URL, or some cookie IAS can set.
Example of the IAS OMID script being included correctly:
https://vast.adsafeprotected.com/qa/vast/fwjsvid/st/123/456/skeleton.js?includeOmid=tru
e&originalVast=https://st1.adsafecontrol.com/video/vanillavast.xml.php?videolength=15
Example of the IAS OMID script being included correctly:
https://vast.adsafeprotected.com/qa/vast?anId=7&includeOmid=true&originalVast=https://st1.adsafecontrol.com/video/vanillavast.xml.php?videolength=15
Create an IAS case with details of your inquiry to receive help from our internal support team.