Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

Introduction

Adding Verve ad tags to your mobile application is quick and easy.

We support three kinds of integration:

...

The javascript Integration is the simplest form of integration that Verve supports.

The Verve ad tag is a simple call to a hosted javascript file. It looks like this:  Please see below for an example.

No Format
<script>
vrv = document.vrv || {};
vrv.b = 'sampletag';
vrv.p = 'ptnr';
vrv.c = '999';
vrv.lat = '<INSERT_LATITUDE_HERE>';
vrv.long = '<INSERT_LONGITUDE_HERE>';
vrv.ui = '<INSERT_ADVERTISER_IDENTIFIER>';
vrv.uis = '<INSERT_ADVERTISER_IDENTIFIER_SOURCE>';
vrv.appid = '<INSERT_APP_BUNDLE_ID>';
</script>
<script src="https://c.vrvm.com/pass/vrv/adtag/vervetag.js"></script>

Note

In the example above, the placeholders (text between the angle brackets, and the brackets themselves) should be replaced with actual values. If the tag includes these placeholders, the request may pass inaccurate/insufficient data

For normal client-side integration, simply insert your Verve Ad Tag ad tag where you want your ad to appear.

Required parameters

There These are three parameters that are required in every tagthe required parameters to be included in the Verve ad tag request.

Parameter

Name

Description

p

Portal keyword

Portal keyword. This is a Verve-assigned value identifying the distribution portal on which the advertisement is being displayed. In most cases, a mobile website accessed directly using the publisher's hostname is on the default portal (keyword: "def"). The portal will change if the site is accessed through a mobile carrier's "deck". Mobile client applications are typically segregated by platform (e.g., iPhone, BlackBerry, Windows Mobile, etc.) using portals.

b

Partner (publisher) keyword.

This is a Verve-assigned value identifying the publisher of the mobile content. Note that there's a one-to-one relationship between a mobile site and a publisher. For example, for the Daily Planet's mobile site, the partner keyword might be "dailyplanet".

c

Content Category

Content category ID. This is an integer which identifies the type of content available on the page for which an ad is requested. For example, a page of sports news will have one category ID, while a page of movie reviews will have another.

If you set the "category" variable to a value in our Ad Category Codes this provides us with metadata about the content type for the impression that allows us to serve higher value ad inventory. A list of acceptable category values can be found in the AdCel API.

Optional Parameters

If your application/platform captures accurate location or advertiser ids, passing this data on the request can greatly increase the monetization of your inventory. Simply insert the parameters you wish to pass in the request in your ad tag as show below. Your account manager will create a custom tag for your specific integration. For a list of additional available parameters, read more here: AdCel API.

Here are the most valued parameters:

...

See Appendix A for a complete list of categories and codes. 

Multiple c values can be passed on the querystring as c=value1&c=value2&c=value3

uiUser IdentifierUnique identifier for a user or advertiser ID, includes IDFA or Google ID. If a ui value is passed, the uis parameter should also be set. ui value is case sensitive. Unhashed IDFA (Apple ID) should be upper case. All other ui values, including hashed IDFA's, should be lower case.
uisUser Identifier SourceCode indicating the source or type of ID passed in the "ui" parameter. (Ignored when the "ui" parameter is not present.) By default, and in the absence of this parameter, the user identifier is assumed to be a randomly-generated ID. iOS IDs must be passed as uppercase and Android IDs in lower case. Refer to this section to understand the uis mapping: User Identifier Guidance.

...

Note

In the examples below, the placeholders (text between the angle brackets, and the brackets themselves) should be replaced with actual values. If the tag includes these placeholders, the request may pass inaccurate/insufficient data

No Format
<script>
vrv = document.vrv || {};
vrv.b = 'sampletag';
vrv.p = 'ptnr';
vrv.c = '999';
vrv.lat = '<INSERT_LATITUDE_HERE>';
vrv.long = '<INSERT_LONGITUDE_HERE>';
vrv.ui = '<INSERT_ADVERTISER_IDENTIFIER>';
vrv.uis = '<INSERT_ADVERTISER_IDENTIFIER_SOURCE>';
vrv.hwmdl = '<INSERT_HARDWARE_MODEL>';
</script>
<script src="https://c.vrvm.com/pass/vrv/adtag/vervetag.js"></script>
appidApp Bundle Id

Unique key that identifies the app (e.g. iOS Bundle ID or Android App ID or Package name). This is usually in the following format: com.example.myapp


In addition to the above, latitude and longitude location parameters are also required.  They can be passed in the ''ll" parameter or "lat" and "long" parameters.  

Parameter

Name

Description

llLat/LongLatitude and longitude of the user, encoded. The location of the user at the time of the advertising request. Availability of this parameter is, of course, platform- dependent and optional. It must be excluded if the user does not consent to provide location information in some manner. However, if location is available, it should be included. The parameter name is two lower-case Ls, and is encoded in a special format (described later in this document). The location's resolution does not have to be particularly precise, however a minimum target of 3km is recommended. Also, for a particular user session, it's sufficient to obtain the location only once. I.e., location does not need to be looked-up for every ad request during a session. Please pass the most accurate location known, which is generally GPS data pulled from the device.
latLatitudeLatitude location of the user making the ad request. Note the "ll" parameter is the preferred method in which to supply geolocation information. Please pass the most accurate location known, which is generally GPS data pulled from the device.
longLongitude

Longitude location of the user making the ad request. Please pass the most accurate location known, which is generally GPS data pulled from the device.

Optional Parameters

For a list of additional available parameters, read more here: AdCel API.

Testing and Certification

...

  1. Requires allowsInlineMediaPlayback to be set in app
  2. Use this test tag to be loaded in app:

No Format
<script>
vrv = document.vrv || {};
vrv.b = 'sampletag';
vrv.p = 'iphn';
vrv.c = '22';
</script>
<script src="https://c.vrvm.com/pass/vrv/adtag/vervetag.js"></script> 

...