BYOD - Bring Your Own Data – Ad Quality

This feature, Allows publishers or unsupported Ad Networks the benefit to send Ads-data to Soomla, by that, eliminate the need of sharing API keys as well removing the dependency of Ad Network supporting.

S3 Bucket:

By using this type of integration, you'll have to set-up a process to uploaded the Ad Network files to a predefined folder on a daily basis.
We will take the data, process it, and display it in Soomla dashboard.

This feature meant to serve publishers who want to work with Soomla without sharing Credentials.

BYOD integration replaces the need of setting additional integrations - hence, there's no need to configure integration for those that already included in the uploaded files

Restrictions:

Currently, we will support only AWS s3 shared storage.

What’s needed to start?

AWS credentials (we need only read access):

SecretKey
AccessKey
Bucket Url

Folders Format:

You need to create a bucket with folders like:

s3://bucket/AppKey/day/Ad_network_name/

AppKey - Soomla app identifier
day needs to be in the format of YYYY-mm-dd
Ad_network_name must be in lowercase letters a-z

Example:

s3://games123-byod/abcd12234-ahsbd1234/2019-09-22/mopub/

Files format:

Format: CSV (Comma delimiter)
File Name: <YYYY-mm-dd>_<Ad_network_name>_<App_key>_Part<x/y>
Maximum single file size: 10GB
Headers: Exclude headers from file
File Columns :
- day - yyyy-mm-dd
- country - ISOxxx format 2 letters
- platform - string (lowercase letters)
- intg - string (lowercase letters)
- ad_type - int (allowed ad types: <1-10>)
- *extra_fields - json
- imp - int (impressions)
- clk - int (clicks)
- rev - float (revenue)
- vco - int (videoCompletions)
Important notes:
- Any special chars or control codes should be remove from file
  (caret notation - https://en.wikipedia.org/wiki/Caret_notation )
- In Extra_fields - Null values should be represented as empty strings

Example file:

2020-05-11,BD,ios,adcolony,3,{"acAppId":"app16556","acZoneId":"vzb3d2b503"},4,2,0.0,4
2020-05-11,PF,ios,adcolony,3,{"acAppId":"app16556","acZoneId":"vzb3d2b503"},2,0,0.0,2
2020-05-11,MK,ios,adcolony,3,{"acAppId":"app16556","acZoneId":"vz39ebba00"},32,14,0.096424,23
2020-05-11,"",ios,adcolony,3,{"acAppId":"app16556","acZoneId":"vz39ebba00"},21,10,0.065941,12
2020-05-11,CH,ios,adcolony,3,{"acAppId":"app16556","acZoneId":"vz39ebba00"},263,169,0.686163,189
2020-05-11,RU,ios,adcolony,3,{"acAppId":"app16556","acZoneId":"vzb3d2b503"},92,58,0.0,88
2020-05-11,JE,ios,admob,4,{"adUnit":"ca-app-pub-5797054612345660/2797039568"},0,0,0.0,0
2020-05-11,AO,ios,admob,4,{"adUnit":"ca-app-pub-5797054612345660/639424"},0,0,0.0,0
2020-05-11,IL,ios,admob,4,{"adUnit":"ca-app-pub-5797054612345660/848448"},2,0,0.044176,0
2020-05-11,CM,ios,admob,4,{"adUnit":"ca-app-pub-5797054612345660/964705"},2,0,6.9E-4,0
2020-05-11,MM,ios,admob,4,{"adUnit":"ca-app-pub-5797054612345660/964705"},83,1,0.045859,0
2020-05-11,GP,ios,facebook,4,{"placementId":"20993571417_37282140"},2,0,0.0116983,0
2020-05-11,IE,ios,facebook,4,{"placementId":"20993571417_34139701"},3,0,0.018,0
2020-05-11,AE,ios,facebook,4,{"placementId":"20993571417_34139701"},28,0,0.168,0
2020-05-11,BD,ios,facebook,4,{"placementId":"20993571417_37282140"},29,0,0.028010067,0
2020-05-11,BE,ios,facebook,4,{"placementId":"20993571417_34139690"},1,0,0.016,0

*extra_fields are additional fields that need to be included for a specific Ad Network. For example, if intg=mopub then your extra fields would look like this:

{"ad_unit":"abcdefg/12345678"}

BYOD through SDK:

To enable integration with Ad Networks that currently not supported by Soomla (Ad Network we support), you can simply ask your Ad Network to pass the data directly to Soomla by calling "Soomla SDK custom events"

For example:

For Android

Send AdMob interstitial events:

- To send an interstitial displayed event:

JSONObject jsonObject = new JSONObject();
try {
    jsonObject.put("adUnit", "PLACE_YOUR_ADMOB_AD_UNIT_HERE");
} catch (JSONException e) {
}

SoomlaTraceback.getInstance().onAdDisplayed("admob", 1, jsonObject);

- To send an interstitial was clicked event:

SoomlaTraceback.getInstance().onAdClicked("admob", 1, jsonObject);

- To send an interstitial video playback is completed event:

SoomlaTraceback.getInstance().onVideoCompleted("admob", 1, jsonObject);

- To send an interstitial closed event:

SoomlaTraceback.getInstance().onAdClosed("admob", 1, jsonObject);

For iOS

send AdMob interstitial events:

To send an interstitial displayed event:

NSDictionary *extraFields = @{@"adUnit" : @"PLACE_YOUR_ADMOB_AD_UNIT_HERE"}

[[SoomlaTraceback getInstance] onAdDisplayed:"admob" withAdType:1 andExtraFields:extraFields];

key legend for ad_types:

1 - Interstitial
3 - Video
4 - Rewarded video
5 - Native
6 - Banner
7 - Offer wall
10 - Rewarded
11 - Interactive

Extra fields:

*** In cases where extra fields are missing - please contact Soomla support team

AdMob

{
  "admob": {
    "extraFields": [
      "adUnit"
    ],
  }
}

Chartboost

{
  "chartboost": {
    "extraFields": [
      "cbAppId"
    ]
  }
}

AppLovin

{
  "applovin": {
    "extraFields": [
      "pn",
      "alAdSize",
      "alAdType",
      "alPlacement",
      "alZoneId"
    ]
  }
}

Facebook

{
  "facebook" : {
    "extraFields" : [
      "placementId"
    ]
  }
}

Unity Ads

{
  "unityads" : {
    "extraFields" : [
      "gameId",
      "zoneId"
    ]
  }
}

IronSource (Supersonic)

{
  "supersonic" : {
    "extraFields" : [
      "supAppKey",
      "placement",
      "supDSN"
    ]
  }
}

supDSN = instance + see more details in this link

Vungle

{
  "vungle" : {
    "extraFields" : [
      "vglAppId",
      "placementId"
    ]
  }
}

AdColony

{
  "adcolony" : {
    "extraFields" : [
      "acAppId",
      "acZoneId"
    ]
  }
}

Fyber

{
  "fyber" : {
    "extraFields" : [
      "fybAppId"
    ]
  }
}

MediaBrix

{
  "mediabrix" : {
    "extraFields" : [
      "mbZone"
    ]
  }
}

MoPub

{
  "mopub" : {
    "extraFields" : [
      "adUnit"
    ]
  }
}

TapJoy

{
  "tapjoy" : {
    "extraFields" : [
      "tjAppKey",
      "tjPlacement"
    ]
  }
}

Amazon Ads

{
  "amazonads" : {
    "extraFields" : [
      "amAppKey"
    ]
  }
}

LifeStreet

{
  "lifestreet" : {
    "extraFields" : [
      "lsTag"
    ]
  }
}

AdX

{
  "adx" : {
    "extraFields" : [
      "adUnit",
      "pn"
    ]
  }
}

Fuse

{
  "fuse" : {
    "extraFields" : [
      "fuseAppId"
    ]
  }
}

Millennial

{
  "millennial" : {
    "extraFields" : [
      "mmPlacementId",
      "mmSiteId"
    ]
  }
}

Dfp

{
  "dfp" : {
    "extraFields" : [
      "adUnit"
    ]
  }
}

Smaato

{
  "smaato" : {
    "extraFields" : [
      "smAdSpace"
    ]
  }
}

LeadBolt

{
  "leadbolt" : {
    "extraFields" : [
      "apiKey"
    ]
  }
}

InMobi

{
  "inmobi" : {
    "extraFields" : [
      "placementId"
    ]
  }
}

AerServ

{
  "aerserv" : {
    "extraFields" : [
      "asPlc"
    ]
  }
}

Inneractive

{
  "inneractive": {
    "extraFields" : [
      "iaAppId",
      "iaAdUnit"
    ]
  }
}

Ogury

{
  "ogury" : {
    "extraFields" : [
      "adUnit",
      "apikey"
   ]
  }
}

HyprMX

{
  "hyprmx" : {
    "extraFields" : [
      "hmxDist",
      "hmxPlcId"
    ] 
  }
}

Flurry

{
  "flurry" : {
    "extraFields" : [
      "flApiKey",
      "flAdSpace"
    ]
  }
}

OpenX

{
  "openx" : {
    "extraFields" : [
      "oxAdUnit"
    ]
  }
}

Heyzap

{
  "heyzap" : {
    "extraFields" : [
      "pn",
      "hzPubId",
      "hzTag"
    ]
  }
}

Mobfox

{
  "mobfox" : {
    "extraFields" : [
      "mfInvh"
    ]
  }
}

Yeahmobi

{
  "yeahmobi" : {
    "extraFields" : [
      "ymSlotId"
    ]
  }
}

Tiktok (ByteDance)

{
  "bytedance" : {
    "extraFields" : [
      "placement"
    ]
  }
}

Mintegral

{
  "mintegral" : {
     "extraFields" : [
       "mtgAdUnitId",
       "mtgAppId",
       "mtgPlcId"
   ] 
  }
}