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
`BANNER`	The object represents an image ad.
`COUPON`	The object represents an ad that customers can redeem for a deal.
`TEXT_LINK`	The object represents a hyperlinked text ad.

`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
`AFRIKAANS`	Afrikaans
`ARABIC`	العربية
`BULGARIAN`	български
`CHINESE`	中文(简体)
`CHINESE_TRADITIONAL`	中文(繁體)
`CZECH`	čeština
`DANISH`	Dansk
`DUTCH`	Nederlands
`ENGLISH`	English (United States)
`ENGLISH_GB`	English (United Kingdom)
`ANGLISH_AU`	English (Australia)
`ENGLISH_CA`	English (Canada)
`ENGLISH_NZ`	English (New Zealand)
`ENGLISH_ZA`	English (South Africa)
`ESTONIAN`	eesti
`FILIPINO`	Filipino
`FINISH`	suomi
`FRENCH`	Français
`FRENCH_CA`	Français (Canada)
`GERMAN`	Deutsch
`HEBREW`	עברית
`HINDI`	हिन्दी
`INDONESIAN`	Bahasa Indonesia
`ITALIAN`	Italiano
`JAPANESE`	日本語
`KOREAN`	한국어
`LATVIAN`	latviešu
`LITHUANIAN`	lietuvių kalba
`MALAY`	Malay
`MALTESE`	Malti
`NORWEGIAN`	Norsk
`PORTUGUESE`	Português
`PORTUGUESE_BR`	Português (Brasil)
`POLISH`	Polski
`RUSSIAN`	Русский
`SLOVENIAN`	slovenščina
`SPANISH`	Español
`SPANISH_MX`	Español (Mexico)
`SWEDISH`	Svensk
`THAI`	ไทย
`TURKISH`	Türkçe
`VIETNAMESE`	Tiế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
`ACTIVE`	Deal is currently active.
`EXPIRED`	Deal is not currently active.
`PENDING`	Deal is currently waiting for approval.

`DealType` enum

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

View possible enum values
`GENERAL_SALE`	Deal applies a general discount to the products identified in `DealScope`.
`FREE_SHIPPING`	Deal applies free shipping to the order.
`GIFT_WITH_PURCHASE`	A gift will come with the order.
`REBATE`	A rebate will be available to the customer upon purchase.
`BOGO`	Deal 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
`CATEGORY`	Deal applies to a category of products.
`ENTIRE_STORE`	Deal applies to the entire store.
`PRODUCT`	Deal 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
`PRODUCT`	Deal only applies to a specific product or a specific group of products.
`CATEGORY`	Deal 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
`PRODUCT`	Deal only applies to a specific product or a specific group of products.
`CATEGORY`	Deal 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
`FREE`	Customer will receive the `get` item for free.
`AMOUNT`	Customer will receive a specific amount of money off of the `get` item's cost.
`PERCENT`	Customer 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"	
}

Attributes

Id string

Name string

Description string

CampaignId integer

CampaignName string

Type enum

TrackingLink string

LandingPageUrl string

AdvertiserId integer

AdvertiserName string

Code string

IFrameCode string

Width integer

Height integer

CreativeUrl string

Labels string

AllowDeepLinking boolean

MobileReady boolean

Language enum

StartDate datetime

EndDate datetime

Season enum

Uri string

More attributes

TopSeller boolean

SubjectLines string

FromAddresses string

UnsubscribeLink string

DealId integer

DealName string

DealDescription string

DealState enum

DealType enum

DealScope enum

DealProducts array

ProductName string

ProductImageURL string

ProductBeforePriceAmount integer

ProductBeforePriceCurrency string

ProductAfterPriceAmount integer

ProductAfterPriceCurrency string

DealCategories string

DiscountType enum

DiscountAmount decimal

DiscountCurrency string

DiscountPercent percentage

DiscountMaximumPercent percentage

DiscountPercentRangeStart percentage

DiscountPercentRangeEnd percentage

Gift string

RebateAmount decimal

RebateCurrency string

DealDefaultPromoCode string

MinimumPurchaseAmount decimal

MinimumPurchaseAmountCurrency string

MaximumSavingsAmount decimal

MaximumSavingsCurrency string

BogoBuyQuantity integer

BogoBuyScope enum

BogoBuyName string

BogoBuyImageUrl string

BogoGetQuantity integer

BogoGetScope enum

BogoGetName string

BogoGetImageUrl string

`BogoGetDiscountType enum

BogoGetDiscountAmount decimal

BogoGetDiscountCurrency string

BogoGetDiscountPercent percentage

PurchaseLimitQuantity integer

DealStartDate datetime

DealEndDate datetime