API Reference

The ad object

The ad object holds information about your ads. You can create, retrieve, and update an ad, as well as list all ad objects.

Attributes

Id string

Unique identifier for the object referred to as the impact.com Ad Id.

Name string

Name of the ad.

Description string

Additional information about the ad available to partners.

CampaignId integer

Unique identifier for the program (or campaign) that the ad is associated with.

CampaignName string

Display name of the the program (or campaign) that the ad is associated with.

AdType enum

What kind of ad is provided.

View possible enum values
BANNERThe object represents a banner ad.
TEXT_LINKThe object represents a hyperlinked text ad.
COUPONThe object represents a coupon.

LandingPage string

Landing page's URL for the ad this attribute is contained in.

MobileFallbacks object

The SystemAppId values of the mobile app(s) set as mobile fallback(s) for this ad.

View child attributes

Android integer

The SystemAppId of the Android mobile app set as a mobile fallback.

IOS integer

The SystemAppId of your iOS mobile app set as a mobile fallback.

CustomAdServingUrl string

If bypassing impact.com ad hosting, this is the URL location of the ad's creative.

IabAdUnit enum

IAB's official unit type for the ad.

ThirdPartyServableAdCreativeHeight integer

The ad's creative height (in pixels).

ThirdPartyServableAdCreativeWidth integer

The ad's creative width (in pixels).

BannerAlternativeTag string

Alternative text that will be shown if the ad's creative cannot be displayed.

LinkText string

If the ad is a text link, this is the text that makes up the ad.

GetHtmlCodeType enum

How the ad is served.

View possible enum values
HTML_AND_IFRAMEPartners can serve this ad via HTML and IFrame.
IFRAME_ONLYPartners can only serve this ad via IFrame.

Labels string

Key terms to help partners find a particular ad in impact.com.

AllowDeepLinking boolean

Whether partners can override the ad's landing page.

Language enum

What language the ad is hosted in.

View possible enum values
AFRIKAANSAfrikaans
ARABICالعربية
BULGARIANбългарски
CHINESE中文(简体)
CHINESE_TRADITIONAL中文(繁體)
CZECHčeština
DANISHDansk
DUTCHNederlands
ENGLISHEnglish (United States)
ENGLISH_GBEnglish (United Kingdom)
ANGLISH_AUEnglish (Australia)
ENGLISH_CAEnglish (Canada)
ENGLISH_NZEnglish (New Zealand)
ENGLISH_ZAEnglish (South Africa)
ESTONIANeesti
FILIPINOFilipino
FINISHsuomi
FRENCHFrançais
FRENCH_CAFrançais (Canada)
GERMANDeutsch
HEBREWעברית
HINDIहिन्दी
INDONESIANBahasa Indonesia
ITALIANItaliano
JAPANESE日本語
KOREAN 한국어
LATVIANlatviešu
LITHUANIAN lietuvių kalba
MALAY Malay
MALTESEMalti
NORWEGIANNorsk
PORTUGUESEPortuguês
PORTUGUESE_BRPortuguês (Brasil)
POLISHPolski
RUSSIANРусский
SLOVENIAN slovenščina
SPANISHEspañol
SPANISH_MX Español (Mexico)
SWEDISH Svensk
THAIไทย
TURKISHTürkçe
VIETNAMESETiếng Việt

LimitedTimeStartDate datetime

When an ad will become available for use. See ISO 8601.

LimitedTimeEndDate datetime

When an end is no longer available for use. See ISO 8601.

RestrictedMediaPartners array

If the ad is restricted to certain partners, this will display the Partner Ids of the partners that can use the ad.

RestrictedMediaPartnerGroups array

If the ad is restricted to certain partner groups, this will display the names of the partner groups that can use the ad.

Season enum

If the ad has a seasonal promotional theme, this will show what season the ad is meant for.

Possible enum values
ANZAC_DAY
AUGUST_CIVIC_HOLIDAY
AUSTRALIA_DAY
BACK_TO_SCHOOL
BLACK_FRIDAY
BOXING_DAY
CANADA_DAY
CYBER_MONDAY
END_OF_FINANCIAL_YEAR
FAMILY_DAY
FATHERS_DAY
GOOD_FRIDAY
HALLOWEEN
HANUKKAH
INDEPENDANCE_DAY
LABOR_DAY
MEMORIAL_DAY
MOTHERS_DAY
NEW_YEAR
PRESIDENTS_DAY
QUEENS_BIRTHDAY
REMEMBRANCE_DAY
SPRING
ST_PATRICKS_DAY
SUMMER
THANKSGIVING
VALENTINES_DAY
VICTORIA_DAY
WAITANGI_DAY
WINTER
OTHER

Uri string

The URI that points directly to a specific ad.

More attributes

Click to view...

AdCodeTemplate string

Template to serve the ad code from a third-party server.

CouponLinkName string

Hyperlinked text of the ad. Is empty unless AdType: COUPON.

CouponAllowCustomPromoCode boolean

Whether partners can request custom a custom promo code for the coupon. Is empty unless AdType: COUPON.

CustomisationCharge decimal

How much partners need to pay to customize the ad.

MobileReady boolean

Whether the ad is optimized for mobile devices.

PhoneTracking boolean

Whether phone tracking is enabled on the ad.

PromoCodeTracking boolean

Whether promo code tracking is enabled on the ad.

TopSeller boolean

Whether the ad is for a top-selling item.

DealId integer

Unique identifier for for deal associated with the ad.

DealName string

Name of the deal associated with the ad.

DealDescription string

Additional information about the deal associated with the ad.

DealState enum

What state of use the ad's associated deal is in.

View possible enum values
ACTIVEDeal is currently active.
EXPIREDDeal is not currently active.
PENDINGDeal is currently waiting for approval.

DealType enum

How the deal is applied to the items in the ad.

View possible enum values
GENERAL_SALEDeal applies a general discount to the products identified in `DealScope`.
FREE_SHIPPINGDeal applies free shipping to the order.
GIFT_WITH_PURCHASEA gift will come with the order.
REBATEA rebate will be available to the customer upon purchase.
BOGODeal will apply a buy-one-get-one deal to the order.

DealScope enum

To what extent the ad's associated deal applies to the store.

View possible enum values
CATEGORYDeal applies to a category of products.
ENTIRE_STOREDeal applies to the entire store.
PRODUCTDeal only applies to a specific product or a specific group of products.

DealProducts array

If DealScope: PRODUCT, then an array of product info objects appears; the child attributes below will fill each object in the array.

View child attributes

ProductName string

Name of the product that the deal applies to.

ProductImageURL string

URL that leads to the product's image.

ProductBeforePriceAmount integer

Product's price prior to the deal applying.

ProductBeforePriceCurrency string

Product's currency code prior to the deal applying. See ISO 4217.

ProductAfterPriceAmount integer

Product's price after the deal applies.

ProductAfterPriceCurrency string

Product's price's currency code after the deal applies. See ISO 4217.

DealCategories string

If DealScope: CATEGORY, a comma-separated list of product categories the deal applies to will appear.

DiscountType enum

What type of discount will be applied when the deal is activated.

DiscountAmount decimal

If DiscountType: "FIXED", then the discount amount appears.

DiscountCurrency string

If DiscountType: "FIXED", then the currency code for DiscountAmount appears. See ISO 4217.

DiscountPercent percentage

If DiscountType: "PERCENT", then the discount percent appears.

DiscountMaximumPercent percentage

If DiscountType: "PERCENT_MAXIMUM", then the maximum discount percentage that a customer can get appears.

DiscountPercentRangeStart percentage

If DiscountType: "PERCENT_RANGE", then the lowest discount percentage a customer can get appears.

DiscountPercentRangeEnd percentage

If DiscountType: "PERCENT_RANGE", then the highest discount percentage a customer can get appears.

Gift string

If DealType: "GIFT_WITH_PURCHASE", then the name of the product to be gifted appears.

RebateAmount decimal

If DealType: "REBATE", then the rebate's amount appears.

RebateCurrency string

If DealType: "REBATE", then the currency code for RebateAmount appears. See ISO 4217.

DealDefaultPromoCode string

The original promo code for the associated deal.

MinimumPurchaseAmount decimal

Minimum amount a customer needs to spend before the associated deal is applied.

MinimumPurchaseAmountCurrency string

Currency code for the deal's MinimumPurchaseAmount. See ISO 4217.

MaximumSavingsAmount decimal

Maximum amount a customer can save when the associated deal is applied.

MaximumSavingsCurrency string

Currency code for the deal's MaximumSavingsAmount. See ISO 4217.

BogoBuyQuantity integer

If DealType: "BOGO", the amount of "buy" items needed for the deal to activate appears.

BogoBuyScope enum

If DealType: "BOGO", the scope of "buy" items appears.

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

BogoBuyName string

If DealType: "BOGO", the name of the "buy" item(s) appears.

BogoBuyImageUrl string

If DealType: "BOGO", the URL leading to the "buy" product's image will appear.

BogoGetQuantity integer

If DealType: "BOGO", the amount of "get" items that the customer can get a discount on will appear.

BogoGetScope enum

If DealType: "BOGO", the scope of "get" items appears.

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

BogoGetName string

If DealType: "BOGO", the name of the "get" item(s) appears.

BogoGetImageUrl string

If DealType: "BOGO", the URL leading to the "get" product's image will appear.

BogoGetDiscountType enum

If DealType="BOGO", the type of discount applied to "get" items appears.

View possible enum values
FREECustomer will receive the `get` item for free.
AMOUNTCustomer will receive a specific amount of money off of the `get` item's cost.
PERCENTCustomer will receive a percent off of the `get` item's cost.

BogoGetDiscountAmount decimal

If BogoGetDiscountType: "AMOUNT", the fixed discount amount taken off of the "get" item's price appears.

BogoGetDiscountCurrency string

If BogoGetDiscountType: "AMOUNT", the currency code for BogoGetDiscountAmount appears.

BogoGetDiscountPercent percentage

If BogoGetDiscountType: "PERCENT", the discount percentage taken off of the "get" item's price appears.

PurchaseLimitQuantity integer

If DealType: "BOGO", the amount of "buy" product that a customer can purchase at once appears. If 0, no purchase limit exists.

DealStartDate datetime

Date and time that the deal begins. See ISO 8601.

DealEndDate datetime

Date and time that the deal ends. See ISO 8601.

SynchAdsPromoCodes boolean

Has the value true if the deal aligns the state and date range of all ads and promo codes to the deal's. Has the value false if the deal does not have this.

DealRestrictedMediaPartners array

Array of partner names that have access to the deal.

DealRestrictedMediaPartnerGroups array

Array of partner groups that have access to the deal.

{
  "Id": "892081",
  "Name": "Summer Sale 2020 250x250",
  "Description": "Our best deals this summer creative.",
  "CampaignId": "1000",
  "CampaignName": "Acme Campaign",
  "AdType": "BANNER",
  "LandingPage": "http://www.test.com/6234652",
  "MobileFallbacks": {
    "ANDROID":  "12345",
    "IOS":  "67890"
  },  
  "CustomAdServingUrl": "",
  "AdCodeTemplate": "",
  "IabAdUnit": "CUSTOM",
  "ThirdPartyServableAdCreativeHeight": "250",
  "ThirdPartyServableAdCreativeWidth": "250",
  "BannerAlternativeTag": "summersale",
  "LinkText": "",
  "CouponLinkName": "",
  "CouponAllowCustomPromoCode": "",
  "GetHtmlCodeType": "HTML_AND_IFRAME",
  "CustomisationCharge": "0.00",
  "Labels": "sale,US",
  "AllowDeepLinking": "true",
  "MobileReady": "true",
  "PhoneTracking": "false",
  "PromoCodeTracking": "false",
  "Language": "ENGLISH",
  "LimitedTimeStartDate": "2020-09-16T17:01:28-07:00",
  "LimitedTimeEndDate": "",
  "RestrictedMediaPartners": [],
  "RestrictedMediaPartnerGroups": ["Content"],
  "Season": "SUMMER",
  "TopSeller": "true",
  "DealId": "85433",
  "DealName": "Summer Sale 2020",
  "DealDescription": "The end of summer sale with great discounts and the best items",
  "DealState": "PENDING",
  "DealType": "GENERAL_SALE",
  "DealScope": "CATEGORY",
  "DealProducts": [],
  "DealCategories": "Legos,Dolls",
  "DiscountType": "PERCENT",
  "DiscountAmount": "",
  "DiscountCurrency": "",
  "DiscountPercent": "10",
  "DiscountMaximumPercent": "",
  "DiscountPercentRangeStart": "",
  "DiscountPercentRangeEnd": "",
  "Gift": "",
  "RebateAmount": "",
  "RebateCurrency": "",
  "DealDefaultPromoCode": "SUMMERSALE20",
  "MinimumPurchaseAmount": "10.00",
  "MinimumPurchaseAmountCurrency": "USD",
  "MaximumSavingsAmount": "100.00",
  "MaximumSavingsCurrency": "USD",
  "BogoBuyQuantity": "0",
  "BogoBuyScope": "",
  "BogoBuyName": "",
  "BogoBuyImageUrl": "",
  "BogoGetQuantity": "0",
  "BogoGetScope": "",
  "BogoGetDiscountType": "",
  "BogoGetName": "",
  "BogoGetImageUrl": "",
  "BogoGetDiscountAmount": "",
  "BogoGetDiscountCurrency": "",
  "BogoGetDiscountPercent": "",
  "PurchaseLimitQuantity": "0",
  "DealStartDate": "2020-09-17T00:00:00-07:00",
  "DealEndDate": "2020-09-30T00:00:00-07:00",
  "SynchAdsPromoCodes": "false",
  "DealRestrictedMediaPartners": [],
  "DealRestrictedMediaPartnerGroups": ["Content"],
  "Uri": "/Advertisers/<AccountSID>/Ads/892081"
}