## Table of Contents [Introduction](openrtb-api#Introduction) - [Why RTB](openrtb-api#section--why-rtb-) - [Our technology](openrtb-api#section--our-technology-) [BID REQUEST Specifications](openrtb-api#bid-request-specifications) - [1. Bid Request Object](openrtb-api#section--1-bid-request-object-) - [2. Imp Object](openrtb-api#section--2-imp-object-) - [3. App Object](openrtb-api#section--3-app-object-) - [4. Device Object](openrtb-api#section--4-device-object-) - [5. Site Object](openrtb-api#section--5-site-object-) - [6. User Object](openrtb-api#section--7-user-object-) - [7. Regs Object](openrtb-api#section--8-regs-object-) [NATIVE AD: Technical Integration](openrtb-api#native-ad-technical-integration) - [1. About the Native Ad Format](openrtb-api#section--1-about-the-native-ad-format-) - [2. Endpoint for Native Request](openrtb-api#section--2-endpoint-for-native-request-) - [3. Native Request Details](openrtb-api#section--3-native-request-details-) - [4. Native Request Parameters](openrtb-api#section--4-native-request-parameters-) - [5. Sample Native Request Body](openrtb-api#section--5-sample-native-request-body-) - [6. Sample Native Response](openrtb-api#section--6-sample-native-response-) [BANNER AD: Technical Integration](openrtb-api#banner-ad-technical-integration) - [1. About the Banner Ad Format](openrtb-api#section--1-about-the-banner-ad-format-) - [2. Endpoint for Banner Ad Request](openrtb-api#section--2-endpoint-for-banner-ad-request-) - [3. Banner Request Details](openrtb-api#section--3-banner-request-details-) - [4. Sample Banner Request Parameters](openrtb-api#section--4-sample-banner-request-parameters-) - [5. Sample Banner Request Body](openrtb-api#section--5-sample-banner-request-body-) - [6. Sample Banner Response](openrtb-api#section--6-sample-banner-response-) [VIDEO AD: Technical Integration](openrtb-api#video-ad-technical-integration) - [1. About the Video Ad Format](openrtb-api#section--1-about-the-video-ad-format-) - [2. Endpoint for Video Request](openrtb-api#section--2-endpoint-for-video-request-) - [3. Video Request Details](openrtb-api#section--3-video-request-details-) - [4. Sample Video Request Parameters](openrtb-api#section--4-sample-video-request-parameters-) - [5. Sample Video Request Body](openrtb-api#section--5-sample-video-request-body-) - [6. Sample Video Response](openrtb-api#section--6-sample-video-response-) - [7. Sample Device Response](<>) [SKAdNetwork](openrtb-api#skadnetwork) [Get Started](openrtb-api#get-started) ## Introduction ## **Why RTB?** Verve (formerly known as PubNative) introduces its RTB solution in order to deliver mobile ads at scale. By pushing this supply-side specification, we allow publishers to enrich their inventory and to deliver better experiences to their users. Our goal is to increase the programmatic delivery of ads by establishing a common framework on the buy-side, which will facilitate the exchange of diverse ad formats. ## **Our technology** Verve built its RTB platform in full respect of the “OpenRTB Native Ads API Specification Version 1.1” and “OpenRTB API Specification Version 2.3” defined by the IAB. ## BID REQUEST Specifications Our bid request parameters are based on [IAB's OpenRTB API Specifications version 2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf). ## **1. Bid Request Object** The top-level bid request contains a globally unique bid request or auction ID, together with a series of subordinate objects that provide detailed data to potential buyers. Among these are the Site and App objects, which describe the type of published media in which the impression(s) appear. You will find all of the recommended and required bid request parameters below. For definitions of the parameters, please check the _Object: BidRequest_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)) [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Definition", "h-3": "Status", "0-0": "**id**", "0-1": "**string**", "0-2": "Unique ID of the bid request, provided by the exchange.", "0-3": "**required**", "1-0": "**imp**", "1-1": "**object array**", "1-2": "Array of [Imp objects](openrtb-api#section--2-imp-object-) representing the impressions offered. At least 1 Imp object is required.", "1-3": "**required**", "2-0": "**app**", "2-1": "**object**", "2-2": "Details via an [App object](openrtb-api#section--3-app-object-) about the publisher’s app (i.e., non-browser applications). Only applicable and recommended for apps.", "2-3": "**required**", "3-0": "**device**", "3-1": "**object**", "3-2": "Details via a [Device object]\\(openrtb-api#section- -4-device-object-) about the user’s device to which the impression will be delivered.", "3-3": "**required**", "4-0": "site", "4-1": "object", "4-2": "Details via a [Site object](openrtb-api#section--5-site-object-) about the publisher’s website. Only applicable and recommended for websites.", "4-3": "recommended", "5-0": "user", "5-1": "object", "5-2": "Details via a [User object](openrtb-api#section--7-user-object-) about the human user of the device; the advertising audience.", "5-3": "recommended", "6-0": "test", "6-1": "integer; default 0", "6-2": "Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode.", "6-3": "recommended", "7-0": "at", "7-1": "integer, default 2", "7-2": "Auction type, where 1 = First Price, 2 = Second Price Plus. Exchange-specific auction types can be defined using values \ngreater than 500.", "7-3": "recommended", "8-0": "tmax", "8-1": "integer", "8-2": "Maximum time in milliseconds to submit a bid to avoid timeout. This value is commonly communicated offline", "8-3": "recommended", "9-0": "wseat", "9-1": "string array", "9-2": "Whitelist of buyer seats allowed to bid on this impression. Seat IDs must be communicated between bidders and the exchange a priori. Omission implies no seat restrictions.", "9-3": "recommended", "10-0": "allimps", "10-1": "integer; default 0", "10-2": "Flag to indicate if Exchange can verify that the impressions offered represent all of the impressions available in context (e.g., all on the web page, all video spots such as pre/mid/post roll) to support road-blocking. 0 = no or unknown, 1 = yes, the impressions offered represent all that are available.", "10-3": "recommended", "11-0": "cur", "11-1": "string array", "11-2": "Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes. Recommended only if the exchange accepts multiple currencies.", "11-3": "recommended", "12-0": "bcat", "12-1": "string array", "12-2": "Blocked advertiser categories using the IAB content categories.", "12-3": "recommended", "13-0": "badv", "13-1": "string array", "13-2": "Block list of advertisers by their domains (e.g., \"ford.com”).", "13-3": "recommended", "14-0": "regs", "14-1": "object", "14-2": "A [Regs object](openrtb-api#section--8-regs-object-) that specifies any industry, legal, or governmental regulations in force for this request.", "14-3": "recommended", "15-0": "", "15-1": "", "15-2": "", "15-3": "" }, "cols": 4, "rows": 16, "align": [ "left", "left", "left", "left" ] } [/block] ## **2. Imp Object** For definitions of the parameters, please check the _Object: Imp_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)) [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Definition", "h-3": "Status", "0-0": "**id**", "0-1": "**string**", "0-2": "A unique identifier for this impression within the context of the bid request (typically, starts with 1 and increments).", "0-3": "**required**", "1-0": "**banner**", "1-1": "**object**", "1-2": "A [Banner object](openrtb-api#section--4-sample-banner-request-parameters-); required if this impression is offered as a banner ad opportunity.", "1-3": "**required (If this impression is offered as a banner ad opportunity)**", "2-0": "**video**", "2-1": "**object**", "2-2": "A [Video object](openrtb-api#section--4-sample-video-request-parameters-); \nrequired if this impression is offered as a video ad opportunity.", "2-3": "**required (If this impression is offered as a video ad opportunity)**", "3-0": "**native**", "3-1": "**object**", "3-2": "A [Native object](openrtb-api#section--4-native-request-parameters-); required if this impression is offered as a native ad opportunity.", "3-3": "**required (If this impression is offered as a native ad opportunity)**", "4-0": "displaymanager", "4-1": "string", "4-2": "Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.", "4-3": "recommended", "5-0": "displaymanagerserv", "5-1": "string", "5-2": "Version of ad mediation partner, SDK technology, or player \nresponsible for rendering ad (typically video or mobile). Used \nby some ad servers to customize ad code by partner. \nRecommended for video and/or apps.", "5-3": "recommended", "6-0": "instl", "6-1": "integer", "6-2": "1 = the ad is interstitial or full screen, 0 = not interstitial.", "6-3": "recommended", "7-0": "tagid", "7-1": "string", "7-2": "Identifier for specific ad placement or ad tag that was used to initiate the auction. This can be useful for debugging of any issues, or for optimization by the buyer.", "7-3": "recommended", "8-0": "bidfloor", "8-1": "float; default 0", "8-2": "Minimum bid for this impression expressed in CPM.", "8-3": "recommended", "9-0": "bidfloorcur", "9-1": "string; default \"USD\"", "9-2": "Currency specified using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange.", "9-3": "recommended", "10-0": "secure", "10-1": "integer", "10-2": "Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. If omitted, the secure state is unknown, but non-secure HTTP support can be assumed.", "10-3": "recommended", "11-0": "iframebuster", "11-1": "string array", "11-2": "Array of exchange-specific names of supported iframe busters.", "11-3": "recommended", "12-0": "pmp", "12-1": "object", "12-2": "A Pmp object (Section 3.2.17) containing any private marketplace deals in effect for this impression.", "12-3": "recommended", "13-0": "ext", "13-1": "object", "13-2": "Placeholder for exchange-specific extensions to OpenRTB.", "13-3": "recommended", "14-0": "rwdd", "14-1": "integer; default 0", "14-2": "Indicates whether the user receives a reward for viewing the ad \nad, where 0 = no, 1 = yes.", "14-3": "recommended" }, "cols": 4, "rows": 15, "align": [ "left", "left", "left", "left" ] } [/block] ## **3. App Object** For definitions of the parameters, please check the _Object: App_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)) [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Definition", "h-3": "Status", "0-0": "**bundle**", "0-1": "**string**", "0-2": "Application bundle or package name (e.g., com.foo.mygame); \nintended to be a unique ID across exchanges.", "0-3": "**required**", "1-0": "id", "1-1": "string", "1-2": "Exchange-specific app ID.", "1-3": "recommended", "2-0": "name", "2-1": "string", "2-2": "App name (may be aliased at the publisher’s request).", "2-3": "recommended", "3-0": "domain", "3-1": "string", "3-2": "Domain of the app (e.g., “mygame.foo.com”).", "3-3": "recommended", "4-0": "storeurl", "4-1": "string", "4-2": "App store URL for an installed app; for QAG 1.5 compliance.", "4-3": "recommended", "5-0": "cat", "5-1": "string array", "5-2": "Array of IAB content categories of the app.", "5-3": "recommended", "6-0": "sectioncat", "6-1": "string array", "6-2": "Array of IAB content categories that describe the current section of the app.", "6-3": "recommended", "7-0": "pagecat", "7-1": "string array", "7-2": "Array of IAB content categories that describe the current page or view of the app.", "7-3": "recommended", "8-0": "ver", "8-1": "string", "8-2": "Application version.", "8-3": "recommended", "9-0": "privacypolicy", "9-1": "integer", "9-2": "Indicates if the app has a privacy policy, where 0 = no, 1 = yes.", "9-3": "recommended", "10-0": "paid", "10-1": "integer", "10-2": "0 = app is free, 1 = the app is a paid version.", "10-3": "recommended", "11-0": "publisher", "11-1": "object", "11-2": "Details about the Publisher of the app.", "11-3": "recommended", "12-0": "content", "12-1": "object", "12-2": "Details about the Content within the app.", "12-3": "recommended", "13-0": "keywords", "13-1": "string", "13-2": "Comma separated list of keywords about the app.", "13-3": "recommended", "14-0": "ext", "14-1": "object", "14-2": "Placeholder for exchange-specific extensions to OpenRTB.", "14-3": "recommended" }, "cols": 4, "rows": 15, "align": [ "left", "left", "left", "left" ] } [/block] ## **4. Device Object** For definitions of the parameters, please check the _Object: Device_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)) | Parameter | Type | Definition | Status | | :------------- | :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------- | | **ua** | **string** | Browser user agent string. | **required** | | **os** | **string** | Device operating system (e.g., “iOS”). | **required** | | **ip** | **string** | IPv4 address closest to device. | **required** | | geo | object | Location of the device assumed to be the user’s current location defined by a [Geo object](openrtb-api#section--6-geo-object-). | recommended | | dnt | integer | Standard “Do Not Track” flag as set in the header by the browser, where 0 = tracking is unrestricted, 1 = do not track. | recommended | | lmt | integer | “Limit Ad Tracking” signal commercially endorsed (e.g., iOS, Android), where 0 = tracking is unrestricted, 1 = tracking must be limited per commercial guidelines. | recommended | | ipv6 | string | IP address closest to device as IPv6. | recommended | | devicetype | integer | The general type of device. | recommended | | make | string | Device make (e.g., “Apple”). | recommended | | model | string | Device model (e.g., “iPhone”). | recommended | | osv | string | Device operating system version (e.g., “3.1.2”). | recommended | | js | integer | Support for JavaScript, where 0 = no, 1 = yes. | recommended | | pxratio | float | The ratio of physical pixels to device independent pixels. | recommended | | connectiontype | integer | Network connection type. | recommended | | ifa | string | ID sanctioned for advertiser use in the clear (i.e., not hashed). | recommended | | didsha1 | string | Platform device ID (e.g., Android ID); hashed via SHA1. | recommended | | didmd5 | string | Platform device ID (e.g., Android ID); hashed via MD5. | recommended | | dpidm5 | string | Hardware device ID (e.g., IMEI); hashed via MD5. | recommended | | macsha1 | string | MAC address of the device; hashed via SHA1. | recommended | | macmd5 | string | MAC address of the device; hashed via MD5. | recommended | | ext | string | Placeholder for exchange-specific extensions to OpenRTB. | recommended | ## Device Ext Object [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "inputlanguage", "0-1": "string", "0-2": "A string array containing the languages setup on the user's device keyboard. (i.e. “en-US, en” )", "1-0": "diskspace", "1-1": "int", "1-2": "An integer value describing the available disk space on the device in megabytes, where i.e. \"18201\" = device has 18201 MB of available disk space.", "2-0": "totaldisk", "2-1": "int", "2-2": "An integer value describing the total disk space on the device in megabytes, where i.e. \"63989\" = 63989 MB of total disk space.", "3-0": "ringmute", "3-1": "int", "3-2": "(Android only) An integer value describing the device sound setting during time of ad request describing if sound is set to ring or mute, where \n\"0\" = mute and \n\"1\" = ring.", "4-0": "charging", "4-1": "int", "4-2": "An integer value describing if the device is connected to a charger, where: \n\"0\" = unplugged and \n\"1\" = plugged into power outlet", "5-0": "headset", "5-1": "bool", "5-2": "A boolean value indicating if the device is connected to a headset, where: \n\"1\" = device is connected to any headset and \n\"0\" = no headset is connected", "6-0": "batterylevel", "6-1": "int", "6-2": "An integer passed describing percent battery remaining on the user's device, segmented into buckets, where \n100-85% = 8 \n84-70% = 7 \n69-55% = 6 \n54-40% = 5 \n39-25% = 4 \n21-10% = 3 \n9-5% = 2 \n\\< 5% = 1", "7-0": "batterysaver", "7-1": "bool", "7-2": "A boolean value indicating if battery saver (\"Low Power Mode\" on iOS) has been enabled, where \n\"1\" = battery saver, \n\"0\" = not enabled", "8-0": "darkmode", "8-1": "bool", "8-2": "A boolean value indicating if dark mode is enabled on the device, where \n\"1\" = dark mode enabled, \n\"0\"= not enabled", "9-0": "airplane", "9-1": "bool", "9-2": "A boolean value indicating if airplane mode is enabled, where \"1\" = airplane mode enabled, \"0\" = not enabled", "10-0": "dnd", "10-1": "bool", "10-2": "Android only) A boolean value indicating if “do not disturb” setting is enabled, where \n\"1\" = do not disturb enabled, \n\"0\" = not enabled.", "11-0": "atts", "11-1": "int", "11-2": "(iOS 14 + only) An integer passed to represent the app's app tracking authorization status, where \n \n0 = not determined \n1 = restricted \n2 = denied \n3 = authorized", "12-0": "bluetooth", "12-1": "bool", "12-2": "A boolean value indicating if the device is connected to bluetooth where \n\"1\" = connected to bluetooth \n“0” = not connected to bluetooth" }, "cols": 3, "rows": 13, "align": [ "left", "left", "left" ] } [/block] ## Device Geo Object | Attribute | Type | Description | | :-------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | lat | Float | Latitude from -90.0 to +90.0, where negative is south | | long | Float | Longitude from -180.0 to +180.0, where negative is west | | type | Integer | Type - 1 - represents directly passed from device. 2 - Ip derived | | utcoffset | integer | Local time as the number +/- of minutes from UTC | | accuracy | Integer | Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device’s location services (i.e., type = 1). Note that this is the accuracy as reported from the device. Consult OS specific documentation (e.g., Android, iOS) for exact interpretation | | lastfix | Integer | The time accuracy of the location. The number of seconds since the location was retrieved. Format is in total number of seconds. | | ipservice | Integer | Enrichment provider | | metro | String | Zip code of the device | | zip | string | ZIP or postal code | | Country | String | Country code using ISO-3166-1-alpha-3 | | Region | String | Region code using ISO-3166-2; 2-letter state code if USA | | City | String | City using United Nations Code for Trade & Transport Locations. See Appendix A for a link to the codes | | ext.isp | String | Internet Service Provider name | | ext.org | Strin | Internet Service Provider name. | ```json Sample Geo Device Object "device": { "dnt": 2, "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_2 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B440 Safari/600.1.4", "ip": "8.8.8.8", "geo": { "lat": 0, "lon": 0, "country": "USA", "region": "CA", "city": "Mountain View", "zip": "94040", "type": 2, // 1- GPS, 2- IP address "utcoffset": 120, "accuracy": 400, "ipservice": 2, "ext": { "isp":"Google", "org":"Google" } }, "carrier": "Google", "language": "en", "make": "Apple", "model": "iphone", "os": "iOS", "osv": "8", "connectiontype": 2, // 0 -Unknown, 1- Ethernet, 2 - WIFI, 3 -Cellular Network – Unknown Generation "devicetype": 1, // 1 - Mobile/Tablet "ifa": "1E2DFA89-47FD-9941-DF1FC4E6484C", "ext": { "airplane": 0, "batterylevel": 8, // 100-85% = 8 , 84-70% = 7, 69-55% = 6, 54-40% = 5, 39-25% = 4, 21-10% = 3, 9-5% = 2, < 5% = 1 "batterysaver": 1, "bluetooth": 1, "charging": 0, "darkmode": 0, "dnd": 0, // 0- Do Not Disturb disabled, 1- Do Not Disturb enabled "headset": 0, //0- No headset connected, 1- Headset connected "inputLanguage": [ "en" ], "ringmute": 0, // 0- Mute, 1- Ring "diskspace": 1821, //MB of data "totaldisk": 128000 //MB of data } }, ``` ## **5. Site Object** For definitions of the parameters, please check the _Object: Site_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)) | Parameter | Type | Definition | Status | | :------------ | :----------- | :---------------------------------------------------------------------------------- | :---------- | | id | string | Exchange-specific site ID. | recommended | | name | string | Site name (may be aliased at the publisher’s request). | recommended | | domain | string | domain string Domain of the site (e.g., “mysite.foo.com”). | recommended | | cat | string array | Array of IAB content categories of the site. | recommended | | sectioncat | string array | Array of IAB content categories that describe the current section of the site. | recommended | | pagecat | string array | Array of IAB content categories that describe the current page or view of the site. | recommended | | page | string | URL of the page where the impression will be shown. | recommended | | ref | string | Referrer URL that caused navigation to the current page. | recommended | | search | string | Search string that caused navigation to the current page. | recommended | | mobile | integer | Mobile-optimized signal, where 0 = no, 1 = yes. | recommended | | privacypolicy | integer | Indicates if the site has a privacy policy, where 0 = no, 1 = yes. | recommended | | publisher | object | Details about the Publisher of the site. | recommended | | content | object | Details about the Content within the site. | recommended | | keywords | string | Comma separated list of keywords about the site. | recommended | | ext | object | Placeholder for exchange-specific extensions to OpenRTB. | recommended | ## **6. User Object** For definitions of the parameters, please check the _Object: User_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)) | Parameter | Type | Definition | Status | | :--------- | :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | | id | string | Exchange-specific ID for the user. At least one of id or buyerid is recommended. | recommended | | buyerid | string | Buyer-specific ID for the user as mapped by the exchange for the buyer. At least one of buyerid or id is recommended. | recommended | | yob | integer | Year of birth as a 4-digit integer. | recommended | | gender | string | Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown). | recommended | | keywords | string | Comma separated list of keywords, interests, or intent. | recommended | | customdata | string | Optional feature to pass bidder data that was set in the exchange’s cookie. The string must be in base85 cookie safe characters and be in any format. Proper JSON encoding must be used to include “escaped” quotation marks. | recommended | | geo | object | Location of the user’s home base defined by a [Geo object](openrtb-api#section--6-geo-object-). This is not necessarily their current location. | recommended | | data | object array | Additional user data. Each Data object represents a different data source. | recommended | | ext | object | Placeholder for exchange-specific extensions to OpenRTB. | recommended | ## **7. Regs Object** For definitions of the parameters, please check the _Object: Regs_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)) | Parameter | Type | Definition | Status | | :-------- | :------ | :--------------------------------------------------------------------------------------------------------------------- | :---------- | | coppa | integer | Flag indicating if this request is subject to the COPPA regulations established by the USA FTC, where 0 = no, 1 = yes. | recommended | | ext | object | Placeholder for exchange-specific extensions to OpenRTB. | recommended | ## NATIVE AD: Technical Integration ## **1. About the Native Ad Format** We support native ads using the following components. Please keep in mind that the components must be specified in the ad request. | Component | Description | Standard case | | :------------- | :--------------------------------------- | :----------------------- | | Main Image | Large image preview for the ad | Usually 1200x627px image | | Icon Image | Small icon for the ad | Usually 80x80px image | | Title | Headline or title for the ad | Text | | Text | Open text field describing the ad | Text | | Call to Action | Text field for the call to action button | Text | | Star Rating | For app installs, the app store rating | Rating on scale of 0~5 | ## **2. Endpoint for Native Request** ```http https://dsp.pubnative.net/bid/v1/request?apptoken=&zoneid= ``` - PubNative uses a latency-based load balancer-- the same endpoint works globally, regardless of location. - : can be obtained from PubNative publisher dashboard. Please consult with account manager for this. - : use default as 1 ## **3. Native Request Details** - Request Method should be POST - Ensure that the bid request body is sent along with the endpoint. - Set headers in the request to the following: ```text Header x-openrtb-version: 2.3 Content-Type:application/json Accept-Charset:utf-8 ``` ## **4. Native Request Parameters** If you are not sure what parameter and values to pass, please check the table below. For the definition of each parameter, please check the _Object: Native_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)). | Parameter | Type | Definition | Status | | :---------- | :------------ | :--------------------------------------------------------------------------------------------------------------------------- | :----------- | | **request** | **string** | Request payload complying with the Native Ad Specification. | **required** | | ver | string | Version of the Native Ad Specification to which request complies; highly recommended for efficient parsing. | recommended | | api | integer array | List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. | recommended | | battr | integer array | Blocked creative attributes. | recommended | | ext | object | Placeholder for exchange-specific extensions to OpenRTB. | recommended | ## **5. Sample Native Request Body** ```json App { "id": "30-54e260ae-7456-48de-809c-e983a32e940b", "tmax": 1500, "cur": [ "USD" ], "imp": [ { "id": "a672c7f1-f982-461e-8a6b-35de4acdf763", "instl": 0, "secure": 0, "native": { "request": "{\"native\":{\"ver\":\"1\",\"layout\":6,\"assets\":[{\"id\":0,\"required\":0,\"title\":{\"len\":100}},{\"id\":2,\"required\":1,\"img\":{\"type\":1,\"wmin\":50,\"hmin\":50}},{\"id\":3,\"required\":0,\"data\":{\"type\":2,\"len\":90}},{\"id\":4,\"required\":0,\"data\":{\"type\":3}},{\"id\":5,\" required\":0,\"data\":{\"type\":12,\"len\":15}},{\"id\":1,\"required\":0,\"img\":{\"type\":3,\"wmin\":300,\"hmin\":250}}]}}" }, "rwdd": 0, "bidfloor": 0.01 } ], "device": { "dnt": 2, "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_2 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B440 Safari/600.1.4", "ip": "8.8.8.8", "geo": { "lat": 0, "lon": 0, "country": "USA", "region": "CA", "city": "Mountain View", "zip": "94040", "type": 2 }, "carrier": "Google", "language": "en", "make": "Apple", "model": "iphone", "os": "iOS", "osv": "8", "connectiontype": 2, "devicetype": 1, "ifa": "1E2DFA89-47FD-9941-DF1FC4E6484C", "ext": { "airplane": 0, "batterylevel": 8, "batterysaver": 1, "bluetooth": 1, "charging": 0, "darkmode": 0, "dnd": 0, "headset": 0, "inputLanguage": [ "en" ], "ringmute": 0, "diskspace": 1821, "totaldisk": 128000 }, "at": 2, "bcat": [ "IAB24", "IAB25", "IAB26" ], "user": { "id": "098a1c70-94db-409d-8c8e-10983e689518" }, "app": { "id": "1008118", "name": "Test_Android", "bundle": "com.android.test", "cat": [ "IAB2-1", "IAB2-2" ], "storeurl": "https://play.google.com/store/apps/details?id=com.android.test", "keywords": "test, android", "privacypolicy": 1, "publisher": { "id": "pub12345", "name": "Publisher A" } } } ``` ```json Web { "id": "30-54e260ae-7456-48de-809c-e983a32e940b", "tmax": 1500, "cur": [ "USD" ], "imp": [ { "id": "a672c7f1-f982-461e-8a6b-35de4acdf763", "instl": 0, "secure": 0, "native": { "request": "{\"native\":{\"ver\":\"1\",\"layout\":6,\"assets\":[{\"id\":0,\"required\":0,\"title\":{\"len\":100}},{\"id\":2,\"required\":1,\"img\":{\"type\":1,\"wmin\":50,\"hmin\":50}},{\"id\":3,\"required\":0,\"data\":{\"type\":2,\"len\":90}},{\"id\":4,\"required\":0,\"data\":{\"type\":3}},{\"id\":5,\" required\":0,\"data\":{\"type\":12,\"len\":15}},{\"id\":1,\"required\":0,\"img\":{\"type\":3,\"wmin\":300,\"hmin\":250}}]}}" }, "bidfloor": 0.01 } ], "device": { "dnt": 0, "devicetype": 1, "geo": { "country": "USA", "type": 2, "lat": 37.751, "lon": -97.822 }, "connectiontype": 6, "language": "en", "model": "Nexus 5X", "make": "LGE", "carrier": "311-480", "didsha1": "e2660d7edf9f7ea18a301d5b913b5e633561d1e2", "ifa": "69144c0f-1fb5-4201-8951-5a64be39e134", "os": "android", "osv": "7.1.1", "ua": "Dalvik/2.1.0 (Linux; U; Android 7.1.1; Nexus 5X Build/N4F26O)", "ip": "174.204.16.28" }, "at": 2, "bcat": [ "IAB24", "IAB25", "IAB26" ], "user": { "id": "098a1c70-94db-409d-8c8e-10983e689518" }, "site": { "id": "1345135123", "name": "Site ABCD", "domain": "siteabcd.com", "cat": [ "IAB2-1", "IAB2-2" ], "page": "http://siteabcd.com/page.htm", "ref": "http://referringsite.com/referringpage.htm", "privacypolicy": 1, "publisher": { "id": "pub12345", "name": "Publisher A" } } } ``` ## **6. Sample Native Response** ```json { "id": "30-54e260ae-7456-48de-809c-e983a32e940b", "seatbid": [ { "bid": [ { "id": "dfa946e82b63472984f6454567279060", "impid": "a672c7f1-f982-461e-8a6b-35de4acdf763", "price": 0.01, "adid": "test_campaign", "nurl": "http://got.pubnative.net/dspv1/winnotice?ap=${AUCTION_PRICE}&t=yxXyP7cxSbGUWd_HEgzcLCYrzfUnnHkCWkOzV5sOK-RgUHk1_IUtayyP-HK20Q5TQ8jNM1QNB7nszMaJcbOSRfCBsQ", "adm": "{\"native\":{\"assets\":[{\"id\":4,\"data\":{\"label\":\"rating\",\"value\":\"4.50\"}},{\"id\":5,\"data\":{\"label\":\"cta\",\"value\":\"Test me\"}},{\"id\":1,\"img\":{\"url\":\"http://cdn.pubnative.net/assets/mock_main_image.jpg\",\"w\":300,\"h\":250}},{\"id\":0,\"title\":{\"text\":\"PubNative Content Info\"}},{\"id\":2,\"required\":1,\"img\":{\"url\":\"http://cdn.pubnative.net/assets/mock_icon.jpg\",\"w\":50,\"h\":50}},{\"id\":3,\"data\":{\"label\":\"description\",\"value\":\"Pubnative Test Ad\"}}],\"link\":{\"url\":\"http://got.pubnative.net/click/rtb?aid=1008118&t=cD2xSi4VtfNdWk0_gVrQCOhJxwdrTFZXe9VKQYhA2YUBcRZPEWsJOt4ilYasAKbyuKTruh_v4lJNr7zUc9W1u8gev2eaaMHdGgsuiwQtbFxbyoaAVNEUJFpx0E_Hdvmpx7qgxkQKKNekewZwJApED6F7NalLG4LLYI4Z031WOfRT7oi7Nfkun-7jdE1L03QppuY6aruKsdsG-aexh4lqFnFGZX0URfG_Ftai7ua6fkDnr8-yiXd-yMXhSQjtfmFbNLyQSMPX_azTpcIT1muZrmPvJ4_S_Q_gY8KUf5J1fidnfS1jN3LOeW84GxCBnpjnzSRurVoS-wSzygvkt4LU15JTWHTWVEaVEFxB1W-vK01UskrQn-1hImd8Gtp6gy39ISYlhWkbTePjQrbcp54AjT9HTR6B4NWviYbG9fEBmcDpubEnGiBIztOYa_hmOtw1mVxszCa4FgaC2M5jwltbx1iuByfcGVgIiQxAkltWvwDpLwIAMJ8CzOXOFSY5fI0dKnFygDHimM7vMr7DcGZODWWnb-c6F6kaGelfLH_eoSc2tVEnbVVpB3mvs6mOZIE9FUms6y2Epc5MQW5IJdOEntRZryYNQFUJImxKC9_BVAdx2_V_8-93kc9TZkWWoZRPhoxhIA\",\"clicktrackers\":[\"http://mock-dsp.pubnative.net/tracker/clk?app_id=1008118&beacon=1&p=${AUCTION_PRICE}\",\"http://mock-dsp.pubnative.net/tracker/clk?app_id=1008118&beacon=2&p=${AUCTION_PRICE}\"]},\"imptrackers\":[\"http://got.pubnative.net/rtb/beacon?t=WiNGlVZWd1t8gxUdC3ls2XgFJ4TyNoXEamlxzu91qGjifY8KgCZJeaxcUGO51h5Gt6VZyxh8nySQG1VXFoywXwII- -ILXJhWsfp_zx671xBw1ScTwvwM3gkLlTSqRKYZBYCmoPFyUGng&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=1x6SLfSJJvo7J7Dv0FppBNrTBsSacqRKY_cE53bY3FAsl1XeACKaIwQXqeDn4Z6etV6PKOOVw3jz0tUNbW_fnh8s9Ng7OaKRnZSNrwgVEQ3oNZNwEhC_sYHAxbh4ogxAhU_4ntr_JYF53CuegNVYDwE&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=nhiwXs2HODx6mYKtA13pGIUJ7fb7Oq7hy4cLUVmGeTBUIgMSkausUe9sdZu1d-F-BEH6LiS3yOBvNOGgD3T0FpPEU3ytfwdjXP3cVKMYJMP3kyYiFG7ON6ys0ff-jCXZ0tE3_1Sx0PeDscHotcwbkCs&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=SucIlpiKbu1CTkNjL6ED63xWY-PMR79WINYBQ1E2pUS5T-BtSMM5Y1kPtS4qfljeH536uGl5hsVgD9fHwpPRfAyih4GZCZCmtYwl2YcFKVX2ZbEj_2zjZJw6-nu71GyRTJwZ1HRtXwn9WpQ-RnRjf0I&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=29jxnKwqwMhz-57j9y1RlkWSVqk3y-E7LFDUPJl02TqvEVP5S6xovuVcFBC4GLvOPqLoA6AhwuX34s-w3u-s5_DGvA7rxCL6lO_h1Guu593pIrQAu6jWgb5O6jZpK-Ouf6BKHds0RLAxiP5DHymUa_U&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=6PsrSiuXp1Hly-BHjzlrz6DJOADMcw27k4JqhSbnHPVLKHCxhxUnnfKV6ZsJUlYk-qUYwsUHBGxDa6Q8FrE-wpd1sOuuuQyxpHJZ8McJa0h4i0koXkMp6zxfIv4peCr8fIlpnmkvLG_Dfzi8ZvCHeZc&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=ImmP3n_EwTQCjK0dyw-E_wrxlbMTwUXbupO2w_pWo1B5HGetFH11yxjaJx6DAehfPRl7X0iXa7Em4CGRi6IT43vVere1CVEsv-vWC3nqNk10495KYVxMeTqF7X66Cs-wh6uQr8bJ4ERAN57aV0PKhm4&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=uSIMS1wS-Of4KC8k6mjAzfm1x6Ug31M1HXABxPFm_ypuPPvIi6Y5khwb3z6O7OFd1Uu3HExuuxjrBYlnd6KLjg_WrO6-qnX0Nc2OIGKiQ4ka7xvZfvsbT-CN0hzAJ5UPBnfA_ImBLTWYXL4S0WFdVZ0&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=o1XOQYNBrKTI_aQvuHjBZnI8jCkr59T5SW6X1f9fl1eUx6JmcDBBniwyDNBUkdptKqmlvcRqF5oTZE2WrkgQIXKBvwyU-RnVO0HucN7dGU3QKAcoyOcZMJDIpoxSu79QSKCJLIWaAM94N1NqbxsEKHA&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=ibTKopug071TDzPZwSspeOdWqA6RU3NMjB2-jm8gdpjTJkFzh36c46e8jncCotz3NJG7ZmUQbiJKfKzC6eDxPKsjNQ_lvv_ius4FSgraE3PvTdeigRYYD5TzRemX0JxZjZkh2VkK3zyTi6kXAMmW7qg&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=fOzwTvtgf6exzog8i-6ZTKgeLRDMcT_wmWpadJmAaARQzFXvddjEv0do5Im6ZjcAb968ca89O9Re4a4Fin6c3-53azxNndQkceJJ_oxmOzMirNawyQn_2zAvcbrm2lc3FIQq0NHDr-SdQoSMmp_I00xt&p=${AUCTION_PRICE}\",\"http://got.pubnative.net/rtb/beacon?t=TRgZZa2qAjJyiYM0B9r4InX6Dpm9X0TlYJQueTy0v5OyYZ8KRzZzY12j1G3QaFsd7DrRZDBy3T8P9kD-wpzPQx5NWOtaNi8hJAlm4budhF1nJBJ8QAbTbSESCkuU7MkDeAQlr4uzbmNk9VSKO0MOLbsaUdIFyGS2k9QyfqFRc3DWfJN_HK2owtu_34l_B__LNlBnI5198IzcBGptCVZwkhR46PWY7SN1SjtaLUAR1Nb6yes4DuXu3nv9OmvNMYGk6LXdA4Tjne7Hkg3FD_-pyuMNyA4CU54JQiSWkW3vtJvIHzNPDuzzhUlwrvMVQB9etXQPKnIsRlIoehiZ03BPRo5pCWsL5aLCjworyAE4QWEJHGZAJT3Iycp5Mxdpar2aJdLzxTGY93gDZw9q6CUIf5911UP8cjpR7pvprsHkDUz-iJv91yZEdGffqeIZjA2w3fg-Z76enbtophEmlfcudpQTZXyflmbIaikdhQAm2GANstvqcjunbKrL17FQiQ7sXDsepLoqztJPqRNzVbKUFVA23SZjLzJ7F246uQ8ATU0Lzx1Es9eeXJ80VaCrMatScH-g09SrMf8xfPMpKnBrx2QgIcTPeU5Mm_2_zkDShLkcy8EzFDfZe8I3wZ34yRhFaz1pgPc_aAmgIXJ1wRSqv9HHgxuuyfskbx27VJ-gvD9CKlpplRuNERO48s-xFfUN20KlLpQEVtc2VchE57EYpcOXvrYwRxDq0PpoRYCJt2YkoPCx91P-aRy8TnSOO8RXQJTrhNkT_fWgCZL-e6nihvtkmN-S7rSERKgR4eS8fSLSLWwow8Dp-lMWcckDWoKH5Kdy5Ky5n59Pwggz_cGBKGyQCSzoPAY6tc_objgDNwT2JwwU1m06s6kotvVsn08Qp- -nRlp9u8qj7sg_J1LSjdPFxtSUXf11PvdpLycDM_84-30SV5kqBOjC28L9E4QYsXXWBB_pcrF6ybkW8HSIYiIcWnz-QiVMOUBnTVcdWq-FbHZd4RGswbCyG65mBXPL_EAJljSd3wl7psET-4KGcs-Pj68_oIcpYjD9XzoBGyQioKaz9wyXOsJiS-xbeuEQ-j195_6pPKm3_94j4ZkX80x-1cfrVEkpXCNfW_EXEX9hER3EuL87lvLW0Ii-Ycw3pa50SiOFM4Z3Ye9zzmiJ2mjILq_lAqL0KqcoUE3bzrjHc_ES_6oiPEdD1lgulkVB3iFZnLQhF4t6jUKFbaCcgYixtehps-YnZSs2YXbmZofRGlza0N5u5AW-UbOf-DPR-4luoR917RHk3YNVTdgqk1gCamgudqhI&p=${AUCTION_PRICE}\"]}}", "adomain": [ "pubnative.net" ], "iurl": "http://got.pubnative.net/rtb/beacon?t=HH1LxYlb8NXCLx_kb5fPzSWGJJtDDV48jm6AuR6VIXXCTI2qjB6u7XADoev1LTQSSRWm8YiNUhLPUD3x2pbTZN4VI1su0efy4HsZhf71njM-vtBTf_eNj_xQZamn0Z_vrV4yXk6syg2E&p=${AUCTION_PRICE}", "cid": "test_campaign", "crid": "test_creative", "attr": [ 4 ] } ] } ], "cur": "USD" } ``` ## BANNER AD: Technical Integration ## **1. About the Banner Ad Format** We currently support standard format ads (a.k.a "display") using any of the following ad sizes. Please note that ad sizes other than those listed here are not supported. Please keep in mind that these components must be specified in the ad request. - 160 x 600 - 250 x 250 - 300 x 50 - 300 x 250 - 300 x 600 - 320 x 50 - 320 x 100 - 320 x 480 - 480 x 320 - 728 x 90 - 768 x 1024 - 1024 x 768 ## **2. Endpoint for Banner Ad Request** ```http https://dsp.pubnative.net/bid/v1/request?apptoken=&zoneid= ``` - PubNative uses a latency-based load balancer-- the same endpoint works globally, regardless of location. - : can be obtained from PubNative publisher dashboard. Please consult with account manager for this. - : use default as 1 ## **3. Banner Request Details** - Request Method should be POST - Ensure that the bid request is in the body of the request - Set headers in the request to the following: ```text Header x-openrtb-version: 2.3 Content-Type:application/json Accept-Charset:utf-8 ``` ## **4. Sample Banner Request Parameters** If you are not sure what parameter and values to pass, please check the table below. For the definition of each parameter, please check the _Object: Banner_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)). [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Definition", "h-3": "Status", "0-0": "**w**", "0-1": "**integer**", "0-2": "Width of the impression in pixels. If neither wmin nor wmax are specified, this value is an exact width requirement. Otherwise it is a preferred width.", "0-3": "**required**", "1-0": "**h**", "1-1": "**integer**", "1-2": "Height of the impression in pixels. If neither hmin nor hmax are specified, this value is an exact height requirement. Otherwise it is a preferred height.", "1-3": "**required**", "2-0": "wmax", "2-1": "integer", "2-2": "Maximum width of the impression in pixels. If included along with a w value then w should be interpreted as a recommended or preferred width.", "2-3": "recommended", "3-0": "hmax", "3-1": "integer", "3-2": "Maximum height of the impression in pixels. If included along with an h value then h should be interpreted as a recommended or preferred height.", "3-3": "recommended", "4-0": "wmin", "4-1": "integer", "4-2": "Minimum width of the impression in pixels. If included along with a w value then w should be interpreted as a recommended or preferred width.", "4-3": "recommended", "5-0": "hmin", "5-1": "integer", "5-2": "Minimum height of the impression in pixels. If included along with an h value then h should be interpreted as a recommended or preferred height.", "5-3": "recommended", "6-0": "id", "6-1": "string", "6-2": "Unique identifier for this banner object. Recommended when \nBanner objects are used with a [Video object](openrtb-api#section--4-sample-video-request-parameters-) to \nrepresent an array of companion ads. Values usually start at 1 and increase with each object; should be unique within an impression.", "6-3": "recommended", "7-0": "btype", "7-1": "integer array", "7-2": "Blocked banner ad types.", "7-3": "recommended", "8-0": "battr", "8-1": "integer array", "8-2": "Blocked creative attributes.", "8-3": "recommended", "9-0": "pos", "9-1": "integer", "9-2": "Ad position on screen.", "9-3": "recommended", "10-0": "mimes", "10-1": "string array", "10-2": "Content MIME types supported. Popular MIME types may include “application/x-shockwave-flash”, “image/jpg”, and “image/gif”.", "10-3": "recommended", "11-0": "topframe", "11-1": "integer", "11-2": "Indicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes.", "11-3": "recommended", "12-0": "expdir", "12-1": "integer array", "12-2": "Directions in which the banner may expand.", "12-3": "recommended", "13-0": "api", "13-1": "integer array", "13-2": "List of supported API frameworks for this impression. Refer to List 5.6 in [IAB's v2.3 specifications](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf). If an API is not explicitly listed, it is assumed not to be supported.", "13-3": "recommended", "14-0": "ext", "14-1": "object", "14-2": "Placeholder for exchange-specific extensions to OpenRTB.", "14-3": "recommended" }, "cols": 4, "rows": 15, "align": [ "left", "left", "left", "left" ] } [/block] ## **5. Sample Banner Request Body** ```json App { "id": "92d6421e44a44dff9f05b29be0ca5bef", "imp": [ { "id": "94628ee5-fe99-436d-94b5-f3270ad06529", "banner": { "w": 300, "h": 250 }, "tagid": "1", "bidfloor": 0.01, "bidfloorcur": "USD", "secure": 1 } ], "app": { "id": "1008118", "name": "Test_Android", "bundle": "com.android.test", "cat": [ "IAB2-1", "IAB2-2" ], "storeurl": "https://play.google.com/store/apps/details?id=com.android.test", "keywords": "test, android", "privacypolicy": 1, "publisher": { "id": "pub12345", "name": "Publisher A" } }, "device": { "ua": "Dalvik/2.1.0 (Linux; U; Android 6.0; MotoG3 Build/MPI24.65-25)", "ip": "107.219.186.28", "geo": { "lat": 33.9775, "lon": -118.2133, "country": "USA", "region": "CA", "city": "los angeles", "zip": "90001", "type": 1 }, "carrier": "att internet services", "language": "en", "model": "Moto G3", "os": "Android", "osv": "6.0", "connectiontype": 2, "devicetype": 1, "ifa": "03F9F0E4-937D-4F85-9275-F530E0107B2F", "ext": { "airplane": 0, "batterylevel": 8, "batterysaver": 1, "bluetooth": 1, "charging": 0, "darkmode": 0, "dnd": 0, "headset": 0, "inputLanguage": [ "en" ], "ringmute": 0, "diskspace": 1821, "totaldisk": 128000 } }, "user": { "id": "50cf7979-18a7-51dd-9645-091009ad842f" }, "at": 2, "tmax": 1500, "allimps": 0, "cur": [ "USD" ], "bcat": [ "IAB24", "IAB25", "IAB26" ] } ``` ```json Web { "id": "92d6421e44a44dff9f05b29be0ca5bef", "imp": [ { "id": "94628ee5-fe99-436d-94b5-f3270ad06529", "banner": { "w": 300, "h": 250 }, "tagid": "1", "bidfloor": 0.01, "bidfloorcur": "USD" } ], "site": { "id": "1345135123", "name": "Site ABCD", "domain": "siteabcd.com.com", "cat": [ "IAB2-1", "IAB2-2" ], "page": "http://siteabcd.com/page.htm", "ref": "http://referringsite.com/referringpage.htm", "privacypolicy": 1, "publisher": { "id": "pub12345", "name": "Publisher A" } }, "device": { "ua": "Dalvik/2.1.0 (Linux; U; Android 6.0; MotoG3 Build/MPI24.65-25)", "ip": "107.219.186.28", "geo": { "lat": 33.9775, "lon": -118.2133, "country": "USA", "region": "CA", "city": "los angeles", "zip": "90001", "type": 1 }, "carrier": "att internet services", "language": "en", "model": "Moto G3", "os": "Android", "osv": "6.0", "connectiontype": 2, "devicetype": 1, "ifa": "03F9F0E4-937D-4F85-9275-F530E0107B2F" }, "user": { "id": "50cf7979-18a7-51dd-9645-091009ad842f" }, "at": 2, "tmax": 1500, "allimps": 0, "cur": [ "USD" ], "bcat": [ "IAB24", "IAB25", "IAB26" ] } ``` ## **6. Sample Banner Response** ```json { "id": "92d6421e44a44dff9f05b29be0ca5bef", "seatbid": [ { "bid": [ { "id": "9cafcb3224fb45839f509abcca974f5c", "impid": "94628ee5-fe99-436d-94b5-f3270ad06529", "price": 0.01, "adid": "test_campaign", "nurl": "https://got.pubnative.net/dspv1/winnotice?ap=${AUCTION_PRICE}&t=8m0OJBZ7871n3RGbrC6jz8mmgocK3okt1DBd_36kZURw8Vf56tf2wDF-Nd7e4i1XnxggaauMDjNEst1xmIrGW-JitQ", "adm": " $\"Advertisement\"$ ", "adomain": [ "pubnative.net" ], "iurl": "https://got.pubnative.net/rtb/beacon?t=q8JQ4OLM0au1mRj81xoNIg6cYepOvPKYSoF1PBC1Xhlxfdb7UqNeHKEqdz54MIM4-NJC6KbcbcQXYILR1H9mTAu07JwrdH7v0RFoxv9XKXpdwDAaRVaMFvQV5n_5uLmFR-6_-THn-ZOU&p=${AUCTION_PRICE}", "cid": "test_campaign", "crid": "test_creative", "attr": [ 4 ] } ] } ], "cur": "USD" } ``` ## VIDEO AD: Technical Integration ## **1. About the Video Ad Format** We currently support video ads, including but not limited to the following ad sizes. Please keep in mind that these components must be specified in the ad request. - 320 x 480 - 480 x 320 - 300 x 250 - 1024 x 768 - 768 x 1024 ## **2. Endpoint for Video Request** ```http https://dsp.pubnative.net/bid/v1/request?apptoken=&zoneid= ``` - PubNative uses a latency-based load balancer-- the same endpoint works globally, regardless of location. - : can be obtained from PubNative publisher dashboard. Please consult with account manager for this. - : use default as 1 ## **3. Standard Video Request Details** - Request Method should be POST - Ensure that the bid request is in the body of the request - Set headers in the request to the following: ```text Header x-openrtb-version: 2.3 Content-Type:application/json Accept-Charset:utf-8 ``` ## **4. Sample Video Request Parameters** If you are not sure what parameter and values to pass, please check the table below. For the definition of each parameter, please check the _Object: Video_ section in [OpenRTB Spec v2.3](https://www.iab.com/wp-content/uploads/2015/06/OpenRTB-API-Specification-Version-2-3.pdf)). [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Definition", "h-3": "Status", "0-0": "**w**", "0-1": "**integer**", "0-2": "Width of the video player in pixels.", "0-3": "**required**", "1-0": "**h**", "1-1": "**integer**", "1-2": "Height of the video player in pixels.", "1-3": "**required**", "2-0": "maxduration", "2-1": "integer", "2-2": "Maximum video ad duration in seconds", "2-3": "recommended", "3-0": "minduration", "3-1": "integer", "3-2": "Minimum video ad duration in seconds.", "3-3": "recommended", "4-0": "startdelay", "4-1": "integer", "4-2": "Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.", "4-3": "recommended", "5-0": "linearity", "5-1": "integer", "5-2": "Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.", "5-3": "recommended", "6-0": "sequence", "6-1": "integer", "6-2": "If multiple ad impressions are offered in the same bid request, \nthe sequence number will allow for the coordinated delivery \nof multiple creatives.", "6-3": "recommended", "7-0": "protocols", "7-1": "integer array", "7-2": "Array of supported video bid response protocols. At least one supported protocol must be specified in \neither the protocol or protocols attribute.", "7-3": "recommended", "8-0": "battr", "8-1": "integer array", "8-2": "Blocked creative attributes.", "8-3": "recommended", "9-0": "pos", "9-1": "integer", "9-2": "Ad position on screen.", "9-3": "recommended", "10-0": "mimes", "10-1": "string array", "10-2": "Content MIME types supported. Popular MIME types may include “video/x-ms-wmv” for Windows Media and \n“video/x-flv” for Flash Video.", "10-3": "recommended", "11-0": "maxextended", "11-1": "integer", "11-2": "Maximum extended video ad duration if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, \nthen the value represents the number of seconds of extended play supported beyond the maxduration value.", "11-3": "recommended", "12-0": "api", "12-1": "integer array", "12-2": "List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be \nsupported.", "12-3": "recommended", "13-0": "ext", "13-1": "object", "13-2": "Placeholder for exchange-specific extensions to OpenRTB.", "13-3": "recommended", "14-0": "minbitrate", "14-1": "integer", "14-2": "Minimum bit rate in Kbps. Exchange may set this dynamically or universally across their set of publishers.", "14-3": "recommended", "15-0": "maxbitrate", "15-1": "integer", "15-2": "Maximum bit rate in Kbps. Exchange may set this dynamically or universally across their set of publishers.", "15-3": "recommended", "16-0": "boxingallowed", "16-1": "integer; default 1", "16-2": "Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes.", "16-3": "recommended", "17-0": "playbackmethod", "17-1": "integer array", "17-2": "Allowed playback methods. If none specified, assume all are allowed.", "17-3": "recommended", "18-0": "delivery", "18-1": "integer array", "18-2": "Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported.", "18-3": "recommended", "19-0": "companionad", "19-1": "object array", "19-2": "Array of [Banner objects](openrtb-api#section--4-sample-banner-request-parameters-) if companion ads are available.", "19-3": "recommended", "20-0": "companiontype", "20-1": "integer array", "20-2": "Supported VAST companion ad types. \nRecommended if companion Banner objects are included via the companionad array.", "20-3": "recommended", "21-0": "integer", "21-1": "integer", "21-2": "Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.", "21-3": "recommended", "22-0": "skipmin", "22-1": "integer", "22-2": "Default 0 Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.", "22-3": "recommened", "23-0": "skipafter", "23-1": "integer", "23-2": "Default 0 Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.", "23-3": "recommended", "24-0": "plcmt", "24-1": "integer", "24-2": "Video placement type for the impression. 1 = instream, 2 = companion, 3 = Interstitial, 4 = standalone", "24-3": "recommended" }, "cols": 4, "rows": 25, "align": [ "left", "left", "left", "left" ] } [/block] > 📘 About Rewarded Video placements > > Due to the fact that there was no Rewarded Video parameter defined in oRTB versions prior to oRTB 2.6, we currently support the following RV parameter signals in a bid request. It is recommended to use any of them to signal us that your video request is for Rewarded Video (RV) placement. > > - Bidrequest.imp.video.ext.rewarded = 1 (integer) /true (boolean) > - Bidrequest.imp.video.ext.is_rewarded = 1 (integer) /true (boolean) > - Bidrequest.imp.video.ext.videotype = "rewarded" [string] > - Bidrequest.imp.video.ext.placementtype = "rewarded" [string] > - Bidrequest.imp.ext.is_rewarded_inventory = 1 (integer) /true (boolean) > - Bidrequest.ext.placementtype = "rewarded" [string] ## **5. Sample Video Request Body** ```json { "id": "5de66583-4534-4df8-a9ee-0feb2116bb5b", "imp": [ { "id": "0526d52d-c988-45db-b911-d128e6e47a29", "video": { "mimes": [ "video/mp4" ], "minduration": 5, "maxduration": 30, "protocols": [ 1, 2, 3, 4, 5, 6 ], "w": 320, "h": 568, "linearity": 1, "playbackmethod": [ 1, 2, 3, 4 ], "delivery": [ 1, 2 ], "api": [ 3, 5 ], "skip":1, "skipmin":10, "skipafter":10, "companiontype": [ 1, 2, 3 ] }, "displaymanager": "sampledisplaymanager", "displaymanagerver": "2.0.0", "instl": 1, "tagid": "35", "bidfloor": 0.01, "bidfloorcur": "USD", "rwdd": 0 } ], "app": { "id": "66755", "name": "Meloman bykov", "bundle": "1210207476", "storeurl": "https://itunes.apple.com/us/app/meloman-great-player/id1210207476?mt=8&uo=4", "cat": [ "IAB14", "IAB1-6" ], "ver": "1.0", "privacypolicy": 0, "paid": 0, "publisher": { "id": "1582", "name": "Ð Ð¾Ð¼Ð°Ð½" }, "ext": { "sdk": "2.0.0", "session_uptime": 30, "session_id": 9, "app_uptime": 501, "impressions_count": 3, "clicks_count": 0, "bcat": [], "badv": [], "packagename": "com.bykov.meloman" } }, "device": { "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_2 like Mac OS X) AppleWebKit/602.3.12 (KHTML, like Gecko) Mobile/14C89", "geo": { "lat": 58.5539, "lon": 50.0399, "type": 2, "country": "USA", "zip": "613043", "utcoffset": 180 }, "lmt": 0, "ip": "50.62.160.240", "devicetype": 4, "make": "Apple", "model": "x86_64", "os": "iOS", "osv": "10.2", "hwv": "x86_64", "h": 568, "w": 320, "ppi": 326, "pxratio": 2, "js": 1, "connectiontype": 2, "ifa": "0C231BF4-9256-4196-96CF-A1D12B5297CF", "ext": { "battery": -100, "rooted": "false", "airplane": 0, "batterylevel": 8, "batterysaver": 1, "bluetooth": 1, "charging": 0, "darkmode": 0, "dnd": 0, "headset": 0, "inputLanguage": [ "en" ], "ringmute": 0, "diskspace": 1821, "totaldisk": 128000 } }, "user": { "gender": "O", "geo": { "lat": 58.5539, "lon": 50.0399, "type": 2, "country": "USA", "zip": "613043", "utcoffset": 180 } }, "at": 2, "tmax": 1500, "allimps": 0, "cur": [ "USD" ], "bcat": [], "badv": [], "regs": { "coppa": 0 } } ``` ## **6. Sample Video Response** ```json { "id": "c8c055a5d10c11e7962ba0369fcef2b0", "seatbid": [ { "bid": [ { "id": "d8b8cc4b9e2943b2a415b33fe5ff5c98", "impid": "1", "price": 15.11, "adid": "10993", "nurl": "https://got.pubnative.net/dspv1/winnotice?ap=${AUCTION_PRICE}&t=9IFYOZB7A70cs4zY0a0dkqqNS1twbmXgVJQWB4cWWS3nWuNx4imL6qSyPY0REInW-V3Zx6L8P_oSnRmDToc7H1DpUObPGXqRSv_1Q7VMtvcWLm9MtKSlJvd4J7YxJxRiupVIVnxP", "adm": "PubNative Mobile VideoAdvanced Mobile MonetizationPubNative<img src="https://cdn.pubnative.net/widget/v3/assets/easysound_320x480.jpg">00:00:14", "adomain": [ "pubnativetestad.com" ], "cid": "10993", "crid": "4342184916255", "attr": [ 4 ] } ] } ], "cur": "USD" } ``` ## 7\. Sample Device Response ```json Sample Device Object "device": { "dnt": 2, "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_2 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B440 Safari/600.1.4", "ip": "8.8.8.8", "geo": { "lat": 0, "lon": 0, "country": "USA", "region": "CA", "city": "Mountain View", "zip": "94040", "type": 2 // 1- GPS, 2- IP address }, "carrier": "Google", "language": "en", "make": "Apple", "model": "iphone", "os": "iOS", "osv": "8", "connectiontype": 2, // 0 -Unknown, 1- Ethernet, 2 - WIFI, 3 -Cellular Network – Unknown Generation "devicetype": 1, // 1 - Mobile/Tablet "ifa": "1E2DFA89-47FD-9941-DF1FC4E6484C", "ext": { "airplane": 0, "batterylevel": 8, // 100-85% = 8 , 84-70% = 7, 69-55% = 6, 54-40% = 5, 39-25% = 4, 21-10% = 3, 9-5% = 2, < 5% = 1 "batterysaver": 1, "bluetooth": 1, "charging": 0, "darkmode": 0, "dnd": 0, // 0- Do Not Disturb disabled, 1- Do Not Disturb enabled "headset": 0, //0- No headset connected, 1- Headset connected "inputLanguage": [ "en" ], "ringmute": 0, // 0- Mute, 1- Ring "diskspace": 1821, //MB of data "totaldisk": 128000 //MB of data } }, ``` > 🚧 CHECKLIST BEFORE GOING LIVE > > 1. Are you using the of your account? > 2. Are you requesting the ad format you need? (NATIVE/STANDARD/VIDEO) > 3. Are you replacing {AUCTION_PRICE} in the bid response when serving the ad? ## SKAdNetwork # Register your Ad Network with Apple ([link](https://developer.apple.com/documentation/storekit/skadnetwork/registering_an_ad_network)) # Add support for processing parameters for Contextual App Targeting ([link](https://developers.verve.com/docs/contextual-app-targeting)) Find the parameters to send in your bid response on our [SKAdNewtwork documentation page](https://developers.verve.com/docs/ios14-and-skadnetwork#section-if-you-re-a-demand-partner-dsp-). ## Get Started To get started or to receive more information, contact us at [hello@verve.com](mailto:hello@verve.com) ## Version History | Version | Changes | | :------ | :--------------------------------- | | 1.0 | Onboarding Process | | 1.1 | Support for Standard Formats | | 1.2 | Update for sizes and spec details. |