The ad object

The ad object holds information about ads that have assigned to your account. You can retrieve ads, retrieve an ad's tracking code and/or link, as well as list all ads.

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 brand's program (or campaign) that the ad is associated with.


CampaignName string

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


Type enum

What kind of ad is provided.

View possible enum values
BANNERThe object represents a banner ad.
EMAILThe object represents an email ad.
PRINTThe object represents a physical print ad.
FLASHThe object represents an ad that uses Adobe Flash.
TEXTThe object represents a sponsored text ad.
TEXT_LINKThe object represents a hyperlinked text ad.
LONG_SPONSORED_TEXTThe object represents a long-form sponsored text ad.
CONTENTThe object represents an ad generated from an HTML file uploaded to impact.com.
VIDEOThe object represents an video ad uploaded to impact.com.
RADIOThe object represents a radio spot.
CALLThe object represents a call ad.
TVThe object represents a TV spot.
SOCIAL_MEDIA_POSTThe object represents a sponsored social media post.
UNKNOWNThe type of ad represented in the object is unknown.

TrackingLink string

The ad's impact.com tracking link.


LandingPageUrl string

The ad's landing page URL, which is where the user sent the tracking link redirect.


AdvertiserId integer

Unique identifier assigned by impact.com to the brand's advertiser account.


AdvertiserName string

Display name of the brand in impact.com.


Code string

The ad's HTML code.


IFrameCode string

The ad's iframe code.


Width integer

For image ads, the width of the ad image measured in pixels.


Height integer

For image ads, the height of the ad image measured in pixels.


CreativeUrl string

Direct URL to the ad's creative (image, etc.).


Labels string

Labels assigned to the ad from the brand.


AllowDeepLinking boolean

Whether or not the ad allows deep linking. If true, the ad can be customized to use a different landing page (such as directly to a product listing versus a storefront), if false the ad's landing page cannot be changed.


MobileReady boolean

Whether the ad is optimized for mobile devices.


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

StartDate datetime

For limited-time ads, this is the date and time in ISO 8601 format for when the ad starts. If the ad doesn't have an end date, this will be the date it was added to impact.com.


EndDate datetime

For limited-time ads, this is the date and time in ISO 8601 format for when the ad ends.


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

Unique uniform resource identifier for the ad object.

More attributes


View more attributes

TopSeller boolean

Whether the ad is for a top-selling item.


SubjectLines string

For email ads, the subject line of the email.


FromAddresses string

For email ads, the "from addresses" of the email.


UnsubscribeLink string

For email ads, the unsubscribe link of the email.


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.

{
  "Id": "123456",
  "Name": "Acme Inc. Ad",
  "Description": "",
  "CampaignId": "1234",
  "CampaignName": "Acme Partner Program",
  "Type": "BANNER",
  "TrackingLink": "https://example.com/c/1299679/515236/8800",
  "LandingPageUrl": "http://www.example.com",
  "AdvertiserId": "9876543",
  "AdvertiserName": "Acme Inc.",
  "Code": "<a href=\"https://example.com/c/1299679/515236/8800\" target=\"_top\" id=\"515236\"><img src=\"//a.impactradius-go.com/display-ad/8800-515236\" border=\"0\" alt=\"\" width=\"442\" height=\"114\"/></a><img height=\"0\" width=\"0\" src=\"https://example.com/i/1299679/515236/8800\" style=\"position:absolute;visibility:hidden;\" border=\"0\" />",
  "IFrameCode": "<iframe id=\"$iradid\" src=\"//a.impactradius-go.com/gen-ad-code/1299679/515236/8800/\" width=\"442\" height=\"114\" scrolling=\"no\" frameborder=\"0\" marginheight=\"0\" marginwidth=\"0\"></iframe>",
  "Width": "442",
  "Height": "114",
  "CreativeUrl": "//a.impactradius-go.com/display-ad/8800-515236",
  "Labels": "",
  "AllowDeepLinking": "false",
  "MobileReady": "false",
  "Language": "ENGLISH",
  "StartDate": "2018-09-12T08:30:49-04:00",
  "EndDate": "",
  "Season": "",
  "TopSeller": "false",
  "SubjectLines": "",
  "FromAddresses": "",
  "UnsubscribeLink": "",
  "DealId": "",
  "DealName": "",
  "DealDescription": "",
  "DealState": "",
  "DealType": "",
  "DealScope": "",
  "DealProducts": [],
  "DealCategories": "",
  "DiscountType": "",
  "DiscountAmount": "",
  "DiscountCurrency": "",
  "DiscountPercent": "",
  "DiscountMaximumPercent": "",
  "DiscountPercentRangeStart": "",
  "DiscountPercentRangeEnd": "",
  "Gift": "",
  "RebateAmount": "",
  "RebateCurrency": "",
  "DealDefaultPromoCode": "",
  "MinimumPurchaseAmount": "",
  "MinimumPurchaseAmountCurrency": "",
  "MaximumSavingsAmount": "",
  "MaximumSavingsCurrency": "",
  "BogoBuyQuantity": "",
  "BogoBuyScope": "",
  "BogoBuyName": "",
  "BogoBuyImageUrl": "",
  "BogoGetQuantity": "",
  "BogoGetScope": "",
  "BogoGetDiscountType": "",
  "BogoGetName": "",
  "BogoGetImageUrl": "",
  "BogoGetDiscountAmount": "",
  "BogoGetDiscountCurrency": "",
  "BogoGetDiscountPercent": "",
  "PurchaseLimitQuantity": "",
  "DealStartDate": "",
  "DealEndDate": "",
  "Uri": "/Mediapartners/<AccountSID>/Ads/123456"	
}