Offer

idstringrequired

Example: 1234567894561234567

campaign_idinteger

Example: 1

namestringrequired

Example: Offer Name

store_idstringnullable

Example: com.adgem.app

tracking_typestringrequired

Possible values: [CPI, CPE, CPA, CPC, Market Research]

total_payout_usdfloatrequired

Example: 1

total_amountfloatrequired

Example: 5

start_datetimestringrequired

Example: 2024-01-01 00:00:00

completion_difficultyintegerrequired

Example: 1

is_multi_rewardbooleanrequired

Example: false

is_featured_campaignboolean

Example: false

campaign_verticalstring

Example: Content Discovery

updated_atstring

Example: 2024-01-01 00:00:00

creatives objectrequired

namestringrequired

Example: Offer Name

icon_urlstringrequired

Example: https://adgem.com/images/offerwall/offerwall_icon.png

descriptionstringrequired

Example: Offer Description

short_descriptionstringnullable

Example: Offer Short Description

instructionsstring[]required

Example: ["Offer Instruction 1","Offer Instruction 2"]

disclaimerstringnullable

Example: Offer Disclaimer

currency_namestringnullable

Example: Coin

currency_name_pluralstringnullable

Example: Coins

categoriesstring[]required

Possible values: [app, free, paid, survey, trial, user_info_request]

Example: ["app"]

sort_order_settingintegernullable

Example: 1

stickers object[]required

Array [

textstringnullable

Example: New

colorstringnullable

Example: #FF0000

]

hero_image_urlstringnullable

Example: https://adgem.com/images/offerwall/offerwall_hero.png

offer_ctastringnullable

Example: Click to earn now!

basic_requirements object[]required

Array [

descriptionstringrequired

Example: Must be a new user.

orderintegerrequired

Example: 1

]

offer_tipstringnullable

Example: Make in-app purchases to earn faster!

goals object[]required

Array [

idstring

Example: 118093008515239936

namestring

Example: Level 1

descriptionstring

Example: Complete Level 1

amountintegerrequired

Example: 1

payout_usdfloatrequired

Example: 1

orderintegernullable

Example: 1

non_linearboolean

Example: false

is_purchase_goalboolean

Example: false

is_attributionboolean

Example: false

maximum_completion_time_daysintegernullable

Example: 30

]

links objectrequired

click_urlstringrequired

Example: https://api.adgem.com/v1/click?all=1&appid=1&cid=100&playerid={playerid}

support_urlstringrequired

Example: https://adunits.adgem.com/support-single-offer?appid=1&playerid={playerid}&campaignid=100

interstitial_urlstring

Present when a click URL exists; derived from the click URL.

Example: https://api.adgem.com/offer-interstitial?all=1&appid=1&cid=100&playerid={playerid}

stats objectrequired

network_epcstringnullable

Example: 0.1

network_epistringnullable

Example: 0.1

geo_targeting objectrequired

countries object[]

Array [

namestringrequired

Example: United States

slugstringnullable

Example: united-states

iso_numericstringnullable

Example: 840

iso_alpha2stringnullable

Example: US

iso_alpha3stringnullable

Example: USA

geoname_idstringnullable

Example: 6252001

]

states object[]

Array [

namestringrequired

Example: California

slugstringnullable

Example: california

geoname_idstringnullable

Example: 5332921

]

cities object[]

Array [

namestringrequired

Example: Los Angeles

slugstringnullable

Example: los-angeles

geoname_idstringnullable

Example: 5368361

]

device_targetingstring[]required

Possible values: [iphone, ipad, android_phone, android_tablet]

Example: ["iphone","ipad"]

os_targeting object[]required

Array [

namestringrequired

Possible values: [android, ios, web]

minstring

Example: 4.0

maxstring

Example: 10.0

]

app_store_categoriesstring[]

Example: ["Casual","Action","Adventure"]

attribution_window_daysinteger

Example: 30

Offer

{
  "id": "1234567894561234567",
  "campaign_id": 1,
  "name": "Offer Name",
  "store_id": "com.adgem.app",
  "tracking_type": "CPI",
  "total_payout_usd": 1,
  "total_amount": 5,
  "start_datetime": "2024-01-01 00:00:00",
  "completion_difficulty": 1,
  "is_multi_reward": false,
  "is_featured_campaign": false,
  "campaign_vertical": "Content Discovery",
  "updated_at": "2024-01-01 00:00:00",
  "creatives": {
    "name": "Offer Name",
    "icon_url": "https://adgem.com/images/offerwall/offerwall_icon.png",
    "description": "Offer Description",
    "short_description": "Offer Short Description",
    "instructions": [
      "Offer Instruction 1",
      "Offer Instruction 2"
    ],
    "disclaimer": "Offer Disclaimer",
    "currency_name": "Coin",
    "currency_name_plural": "Coins",
    "categories": [
      "app"
    ],
    "sort_order_setting": 1,
    "stickers": [
      {
        "text": "New",
        "color": "#FF0000"
      }
    ],
    "hero_image_url": "https://adgem.com/images/offerwall/offerwall_hero.png",
    "offer_cta": "Click to earn now!",
    "basic_requirements": [
      {
        "description": "Must be a new user.",
        "order": 1
      }
    ],
    "offer_tip": "Make in-app purchases to earn faster!"
  },
  "goals": [
    {
      "id": "118093008515239936",
      "name": "Level 1",
      "description": "Complete Level 1",
      "amount": 1,
      "payout_usd": 1,
      "order": 1,
      "non_linear": false,
      "is_purchase_goal": false,
      "is_attribution": false,
      "maximum_completion_time_days": 30
    }
  ],
  "links": {
    "click_url": "https://api.adgem.com/v1/click?all=1&appid=1&cid=100&playerid={playerid}",
    "support_url": "https://adunits.adgem.com/support-single-offer?appid=1&playerid={playerid}&campaignid=100",
    "interstitial_url": "https://api.adgem.com/offer-interstitial?all=1&appid=1&cid=100&playerid={playerid}"
  },
  "stats": {
    "network_epc": "0.1",
    "network_epi": "0.1"
  },
  "geo_targeting": {
    "countries": [
      {
        "name": "United States",
        "slug": "united-states",
        "iso_numeric": "840",
        "iso_alpha2": "US",
        "iso_alpha3": "USA",
        "geoname_id": "6252001"
      }
    ],
    "states": [
      {
        "name": "California",
        "slug": "california",
        "geoname_id": "5332921"
      }
    ],
    "cities": [
      {
        "name": "Los Angeles",
        "slug": "los-angeles",
        "geoname_id": "5368361"
      }
    ]
  },
  "device_targeting": [
    "iphone",
    "ipad"
  ],
  "os_targeting": [
    {
      "name": "android",
      "min": "4.0",
      "max": "10.0"
    }
  ],
  "app_store_categories": [
    "Casual",
    "Action",
    "Adventure"
  ],
  "attribution_window_days": 30
}