diff --git a/_data/sidebar.yml b/_data/sidebar.yml index d7e99973c8..cb1e97b2f5 100644 --- a/_data/sidebar.yml +++ b/_data/sidebar.yml @@ -1104,6 +1104,22 @@ sectionTitle: subgroup: 0 +- sbSecId: 3 + title: Setup Rewarded Video Line Items For MoPub + link: /prebid-mobile/adops-setup-rewarded-video-mopub.html + isHeader: 0 + isSectionHeader: 0 + sectionTitle: + subgroup: 0 + +- sbSecId: 3 + title: Setup Full Screen Video Line Items For MoPub + link: /prebid-mobile/adops-setup-full-screen-video-mopub.html + isHeader: 0 + isSectionHeader: 0 + sectionTitle: + subgroup: 0 + - sbSecId: 3 title: Setup Native Ads link: /prebid-mobile/adops-native-setup.html diff --git a/assets/images/ad-ops/mopub/full/mopub-lineitem-full-adunit.png b/assets/images/ad-ops/mopub/full/mopub-lineitem-full-adunit.png new file mode 100644 index 0000000000..45485964f3 Binary files /dev/null and b/assets/images/ad-ops/mopub/full/mopub-lineitem-full-adunit.png differ diff --git a/assets/images/ad-ops/mopub/full/mopub_lineitem_full_vasttag.png b/assets/images/ad-ops/mopub/full/mopub_lineitem_full_vasttag.png new file mode 100644 index 0000000000..ec952a815c Binary files /dev/null and b/assets/images/ad-ops/mopub/full/mopub_lineitem_full_vasttag.png differ diff --git a/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-advanced.png b/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-advanced.png new file mode 100644 index 0000000000..423d9e4eac Binary files /dev/null and b/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-advanced.png differ diff --git a/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-rewarded copy.png b/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-rewarded copy.png new file mode 100644 index 0000000000..5bf220d953 Binary files /dev/null and b/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-rewarded copy.png differ diff --git a/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-rewarded.png b/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-rewarded.png new file mode 100644 index 0000000000..dafdbd7081 Binary files /dev/null and b/assets/images/ad-ops/mopub/rewarded/mopub-lineitem-rewarded.png differ diff --git a/assets/images/ad-ops/mopub/rewarded/mopub_lineitem_vasttag.png b/assets/images/ad-ops/mopub/rewarded/mopub_lineitem_vasttag.png new file mode 100644 index 0000000000..cda6243ce5 Binary files /dev/null and b/assets/images/ad-ops/mopub/rewarded/mopub_lineitem_vasttag.png differ diff --git a/assets/images/ad-ops/mopub/rewarded/mopub_lineitem_vasttag2.png b/assets/images/ad-ops/mopub/rewarded/mopub_lineitem_vasttag2.png new file mode 100644 index 0000000000..b5eadf1500 Binary files /dev/null and b/assets/images/ad-ops/mopub/rewarded/mopub_lineitem_vasttag2.png differ diff --git a/guide.md b/guide.md index 35e8d5a788..0cf5e9e7da 100644 --- a/guide.md +++ b/guide.md @@ -16,39 +16,39 @@ Sept 7, 2019 ## Core Technologies -The Prebid website is developed using [Jekyll](https://jekyllrb.com/), a static site generator which uses the following technology to create and style HTML pages. +The Prebid website is developed using [Jekyll](https://jekyllrb.com/), a static site generator which uses the following technology to create and style HTML pages. -**Markdown**: The majority of the content is written in Markdown language. Jekyll transform this into raw HTML. +**Markdown**: The majority of the content is written in Markdown language. Jekyll transform this into raw HTML. Learn more about Markdown](https://www.markdownguide.org/) -**Bootstrap**: A CSS template for responsive site design. Bootstrap provides the base formatting for the site. +**Bootstrap**: A CSS template for responsive site design. Bootstrap provides the base formatting for the site. Learn more about [Bootstrap](https://getbootstrap.com/docs/4.1/getting-started/introduction/_) -**Liquid**: A language created by Shopify to enable dynamic HTML creation. +**Liquid**: A language created by Shopify to enable dynamic HTML creation. Learn more about [Liquid](https://help.shopify.com/en/themes/liquid/basics) -**Javascript**: A combination of Javascript libraries are utilized for the Prebid site to include [JQuery](https://jquery.com/) and [BootstrapJS](https://getbootstrap.com/docs/3.3/javascript/) as well as custom code. +**Javascript**: A combination of Javascript libraries are utilized for the Prebid site to include [JQuery](https://jquery.com/) and [BootstrapJS](https://getbootstrap.com/docs/3.3/javascript/) as well as custom code. -**CSS**: The site builds on the base Bootstrap template with custom CSS stored in the style.css file. +**CSS**: The site builds on the base Bootstrap template with custom CSS stored in the style.css file. *** ## Site Config -The _config.yml file (note underscore prefix) sets the base configuration for the site. Refer to [Jekyll](https://jekyllrb.com/docs/configuration/) documentation on which properties can be set in the _congig.yml file. +The _config.yml file (note underscore prefix) sets the base configuration for the site. Refer to [Jekyll](https://jekyllrb.com/docs/configuration/) documentation on which properties can be set in the _congig.yml file. *** ## Directory Structure -Jekyll requires adherence to a certain directory structure to generate the site. Directories prefixed with an underscore contain files used to construct the html files of the site. +Jekyll requires adherence to a certain directory structure to generate the site. Directories prefixed with an underscore contain files used to construct the html files of the site. ### File Construction -For the Prebid.org site the following directories are used: +For the Prebid.org site the following directories are used: **_data** Jekyll was originally designed specifically for creation of blogging websites and not for dynamic, data-driven sites. However, by including the _data directory we can mimic a database structure to create a more robust site. Files in this directory can be saved in either *json*, *yml* or *csv* format. For Prebid.org they have been saved in *yml*. @@ -67,32 +67,32 @@ The contents of these files are used throughout the Prebid.org site for dynamica **_layouts** -The layout directory contains HTML files that, in conjunction with CSS and JS files, format the layout of pages throughout the site. +The layout directory contains HTML files that, in conjunction with CSS and JS files, format the layout of pages throughout the site. **_includes** -The includes directory contains HTML files that can be included within files, such as a file for the header and footer. +The includes directory contains HTML files that can be included within files, such as a file for the header and footer. **_posts** -The posts directory contains the files that make up the content of the blog section of the site. Unlike the layouts and includes directories, the posts files are written in Markdown. A blog.html file in the layout directory provides the formatting for these Markdown files. +The posts directory contains the files that make up the content of the blog section of the site. Unlike the layouts and includes directories, the posts files are written in Markdown. A blog.html file in the layout directory provides the formatting for these Markdown files. -**_bidders** +**_bidders** -The bidders directory is not a standard part of Jekyll; it’s a special use directory specifically for the Prebid.org site. The files in this directory are used to construct the table of partners on the partners/partners.html page. +The bidders directory is not a standard part of Jekyll; it’s a special use directory specifically for the Prebid.org site. The files in this directory are used to construct the table of partners on the partners/partners.html page. **_sites** -The sites directory is created by Jekyll. It contains the live site generated from the collected files and data listed above, combined with the CSS, JS and image assets and the Markdown files for individual pages. +The sites directory is created by Jekyll. It contains the live site generated from the collected files and data listed above, combined with the CSS, JS and image assets and the Markdown files for individual pages. *** ## Assets -The assets directory contains the CSS, Javascript, images and other assets used to create the site. +The assets directory contains the CSS, Javascript, images and other assets used to create the site. -The base CSS file used is Bootstrap (version 3.7.1) Custom CSS and modifications to Bootstrap classes are contained in the style.css file. +The base CSS file used is Bootstrap (version 3.7.1) Custom CSS and modifications to Bootstrap classes are contained in the style.css file. The JS directory contains the Javascript files required for the Prebid.org site. It includes JQuery and Bootstrap javascript frameworks as well as other third party libraries and custom javascript written specifically for the Prebid site. For JQuery and Bootstrap both the expanded and minified versions of the javascript files are included but only the minified files are linked from the site header. @@ -104,34 +104,34 @@ The JS directory contains the Javascript files required for the Prebid.org site. This file contains custom CSS classes and modifications to Bootstrap classes. The file is broken up into the various sections relating to navigaton, homepage and content pages. *Navbar* -The navbar class is a Bootstrap class. It controls the formatting of the top level navigation. Portions of it have been modified specifically for Prebid formatting. +The navbar class is a Bootstrap class. It controls the formatting of the top level navigation. Portions of it have been modified specifically for Prebid formatting. *Dropdown* The dropdown class is a Boostrap class. It controls the formatting and functionality of the dropdown items of the top navigation. Portions of it have been modified specifically for Prebid formatting. *Sidebar* -The sidebar class is a Boostrap class. It controls the formatting and functionality of the dropdown items of the top navigation. Portions of it have been modified specifically for Prebid formatting. Additional custom classes have been created for specific formatting or functionality required by Prebid. +The sidebar class is a Boostrap class. It controls the formatting and functionality of the dropdown items of the top navigation. Portions of it have been modified specifically for Prebid formatting. Additional custom classes have been created for specific formatting or functionality required by Prebid. *Homepage* -The classes in the homepage secton are custom classes created to format the top portion of the Prebid website homepage. +The classes in the homepage secton are custom classes created to format the top portion of the Prebid website homepage. *Container* -A custom container class created for the Prebid website. +A custom container class created for the Prebid website. *Hover Effect* -A custom series of classes created to control the formatting functionalty of the icon buttons on the Prebid website homepage. +A custom series of classes created to control the formatting functionalty of the icon buttons on the Prebid website homepage. *Message* -A custom series of classes created to control the formatting of the message box on the Prebid website homepage. +A custom series of classes created to control the formatting of the message box on the Prebid website homepage. *Benfits* -A custom series of classes created to control the formatting of the Benefits section of the Prebid website homepage. +A custom series of classes created to control the formatting of the Benefits section of the Prebid website homepage. *Carousel* -The carousel class is a Bootstrap class. It controls the formatting and functionality of the carousel displayed on the homepage. Portions of it have been modified specifically for Prebid formatting. Additional custom classes have been created for specific formatting or functionality required by Prebid. +The carousel class is a Bootstrap class. It controls the formatting and functionality of the carousel displayed on the homepage. Portions of it have been modified specifically for Prebid formatting. Additional custom classes have been created for specific formatting or functionality required by Prebid. *Partners* -A custom series of classes created to control the formatting of the [partners](/partners/partners.html) page. +A custom series of classes created to control the formatting of the [partners](/partners/partners.html) page. *Blog* A custom series of classes created to control the formatting of the blog pages. @@ -146,8 +146,8 @@ A custom class created to control the formatting of the footer. The CSS file has multiple @media sections that handle the formatting of the website pages at specific screen widths. Those widths (in pixels) are: -| Width | Device | -| --- | --- | +| Width | Device | +| --- | --- | | 1300 | Small browsers | | 1024 | Large tablets e.g. iPadPro | | 768 | Regular tablets e.g. iPads | @@ -161,21 +161,21 @@ The CSS file has multiple @media sections that handle the formatting of the webs ## Data Models -The data files are stored in the __data directory. +The data files are stored in the __data directory. - + ### Partners There are three locations important for adding a new partner onto the [Partners Page](/partners/partners.html) @@ -346,7 +346,7 @@ The attributes in the Jekyll 'front matter' drive various behaviors and dynamic | userIds | no | comma-separated list of supported user id modules | For display. | | prebid_member | no | true or false, whether this company is a prebid.org member | For display. | -The bidderCode, aliasCode, and prevBiddercode parameters bear some description. +The bidderCode, aliasCode, and prevBiddercode parameters bear some description. Some adapters have a longer bidderCode and a shorter bidderCode -- their adapter supports both (with the `alias` feature) but there's only one documentation file and of course one PBJS adapter file. An relatively common scenario is when the company started off with a long bidderCode, but found it awkward to set up ad server targeting variables because GAM limits you to 20 chars, which is easy to exceed diff --git a/prebid-mobile/adops-line-item-setup-mopub.md b/prebid-mobile/adops-line-item-setup-mopub.md index b8923eb326..cd5d578c87 100644 --- a/prebid-mobile/adops-line-item-setup-mopub.md +++ b/prebid-mobile/adops-line-item-setup-mopub.md @@ -11,12 +11,12 @@ sidebarType: 3 -# Step by Step Line Item Setup for MoPub +# Step-by-Step Line Item Setup for MoPub * TOC {:toc } -This page describes step by step how to set up Prebid Mobile line items for MoPub to serve ads on app with the Prebid SDK. It is using the Universal Prebid Creative. +This page provides step-by-step instructions to set up Prebid Mobile line items for MoPub to serve ads on app with the Prebid SDK. It is using the Universal Prebid Creative. ## Step 1. Add a line item diff --git a/prebid-mobile/adops-setup-full-screen-video-mopub.md b/prebid-mobile/adops-setup-full-screen-video-mopub.md new file mode 100644 index 0000000000..429c0488d3 --- /dev/null +++ b/prebid-mobile/adops-setup-full-screen-video-mopub.md @@ -0,0 +1,57 @@ +--- +layout: page_v2 +title: Setup Rewarded Video for MoPub +description: Setup Full Screen Video for MoPub +pid: 1 +top_nav_section: prebid-mobile +nav_section: prebid-mobile-adops +sidebarType: 3 +--- + +# Step-by-Step Line Item Setup for Full-screen Video on MoPub + +* TOC +{:toc } + +This page provides step-by-step instructions to set up full-screen video line items on MoPub to be used with the Prebid Mobile SDK. + +## Step 1. Create full screen adUnit +Under New ad unit, select Fullscreen.   + +## Step 2. Add a line item +In the *Add a Line Item* section: +1. For the *Type and Priority* settings, select *Non-Guaranteed* as the type and set the priority to *12*. This ensures the line item will compete with all other demand. +2. Set the Rate to the price you want to target.  +For the Type and Priority settings, select Non-Guaranteed as the type and set the priority to 12   +3. In the *Advanced Targeting* section, set the target for *Keywords* to `hb_pb:0.50`  +In the Advanced Targeting section, set the target for Keywords to hb_pb:0.50   + +For each level of pricing granularity required, one line item/creative pairing will need to be set up. + +Line items must be set up to target custom keywords that include bid price information. The bid price keywords will contain how much the buyer bid on the impression. + +Prebid Mobile, by default, will send the highest bid price to MoPub using the keyword `hb_pb` but will also submit the key `hb_pb_BIDDERCODE` for each bidder. You can decide to create one set of line items for all bidders or one set of line items for each bidder. + +## Step 3. Add creatives to your line item +Full-screen video creatives must have a *VAST tag* with the *Format* set to *Fullscreen* that includes the code below: +``` + + + + MoPub + + + + + +``` +
+MoPub VAST tag code   + +The `hb_uuid` variable value is the cache id that will load the ad markup from the bid stored in Prebid Cache. Within each line item, for each ad unit size, there should be one creative with this content. + +The XML can be constructed by providing the VAST tag URL as: +`https://%%KEYWORD:hb_cache_host%%%%KEYWORD:hb_cache_path%%?uuid=%%KEYWORD:hb_uuid%%` + +## Step 4. Duplicate line items +Duplicate your line items according to your [price granularity](/prebid-mobile/adops-price-granularity.html) setting. diff --git a/prebid-mobile/adops-setup-rewarded-video-mopub.md b/prebid-mobile/adops-setup-rewarded-video-mopub.md new file mode 100644 index 0000000000..839a8593e7 --- /dev/null +++ b/prebid-mobile/adops-setup-rewarded-video-mopub.md @@ -0,0 +1,55 @@ +--- +layout: page_v2 +title: Setup Rewarded Video for MoPub +description: Setup Rewarded Video for MoPub +pid: 1 +top_nav_section: prebid-mobile +nav_section: prebid-mobile-adops +sidebarType: 3 +--- + +# Step-by-Step Line Item Setup for Rewarded Video on MoPub + +* TOC +{:toc } + +This page provides step-by-step instructions to set up rewarded-video line items on MoPub to be used with the Prebid Mobile SDK. + +## Step 1. Add a line item + + In the *Add a Line Item* section: + 1. For the *Type and Priority* settings, select *Non-Guaranteed* as the type and set the priority to *12*. This ensures the line item will compete with all other demand. + 2. Set the Rate to the price you want to target.  + For the Type and Priority settings, select Non-Guaranteed as the type and set the priority to 12   + 3. In the *Advanced Targeting* section, set the target for *Keywords* to `hb_pb:0.50`  + In the Advanced Targeting section, set the target for Keywords to hb_pb:0.50   + +For each level of pricing granularity required, one line item/creative pairing will need to be set up. + +Line items must be set up to target custom keywords that include bid price information. The bid price keywords will contain how much the buyer bid on the impression. + +Prebid Mobile, by default, will send the highest bid price to MoPub using the keyword `hb_pb` but will also submit the key `hb_pb_BIDDERCODE` for each bidder. You can decide to create one set of line items for all bidders or one set of line items for each bidder. + +## Step 2. Add creatives to your line item +Rewarded video creatives must have a *VAST tag* with the *Format* set to *Rewarded Video* that includes the code below: + +``` + + + + MoPub + + + + +``` + +
+MoPub VAST tag code   +The `hb_uuid` variable value is the cache id that will load the ad markup from the bid stored in Prebid Cache. Within each line item, for each ad unit size, there should be one creative with this content. + +The XML can be constructed by providing the VAST tag URL as: +`https://%%KEYWORD:hb_cache_host%%%%KEYWORD:hb_cache_path%%?uuid=%%KEYWORD:hb_uuid%%` + +## Step 3. Duplicate line items +Duplicate your line items according to your [price granularity](/prebid-mobile/adops-price-granularity.html) setting.