Create an ad

Creates a new ad in the impact.com system by setting the values of the parameters passed. Note that if you intend to have impact.com host your creative asset (e.g image or video), then you will need to send the request as a multipart/form-data instead of the more typical application/x-www-form-urlencoded Content-Type.

Only Banner, Coupon, and Text Link ads can be created via API. To create promo codes via API, use the create a promo code endpoint. You can also create ads via the impact.com web app.

Parameters


Name required

Display name of the ad.


CampaignId required

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


AdType required

What kind of ad is provided.

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

CustomAdServingUrl required if AdType: BANNER if not using AdCodeTemplate

If bypassing impact.com ad hosting, this is the URL location of the ad's creative. Either AdCodeTemplate or CustomAdServingUrl is required.


AdCodeTemplate required if AdType: BANNER if not using CustomAdServingUrl

Template to serve the ad code from a third-party server. Either AdCodeTemplate or CustomAdServingUrl is required.


CouponLinkName required if AdType: COUPON

Hyperlinked text of the ad. Can only be used if AdType: COUPON.


LinkText required if AdType: TEXT_LINK

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


Language required

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

Description optional

Additional information about the ad available to partners.


LandingPage optional

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


MobileFallbacks optional

Set up which Mobile App Event Type the system directs users to when it detects your app is not installed on the user's device. In the event the system detects the mobile device hitting the ad doesn’t have the particular app installed, it will fall back to the app’s download URL instead.


IabAdUnit optional

IAB's official unit type for the ad.


ThirdPartyServableAdCreativeHeight optional

The ad's creative height (in pixels).


ThirdPartyServableAdCreativeWidth optional

The ad's creative width (in pixels).


BannerAlternativeTag optional

Alternative text that will be shown if the ad's creative cannot be displayed. Can only be used if AdType: BANNER.


GetHtmlCodeType optional

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 optional

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


AllowDeepLinking optional

Whether partners can override the ad's landing page.


LimitedTimeStartDate optional

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


LimitedTimeEndDate optional

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


TargetMediaPartners optional

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


TargetMediaPartnerGroups optional

If the ad is restricted to certain partner groups, the ids of the partner groups that can use the ad.

More Parameters

Click to view...

Season optional

The seasonal promotional theme for the ad.

OTHER
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

CouponAllowCustomPromoCode boolean

Whether partners can request custom a custom promo code for the coupon. Can only be used if AdType: COUPON.


CustomisationCharge optional

How much partners need to pay to customize the ad.


MobileReady optional

Whether the ad is optimized for mobile devices.


PhoneTracking optional

Whether phone tracking is enabled on the ad.


PromoCodeTracking optional

Whether promo code tracking is enabled on the ad.


TopSeller optional

Whether the ad is for a top-selling item.


DealId optional

Unique identifier for for deal associated with the ad.

Returns


Returns the status of the request and the URI of the newly created ad. Returns an error if create parameters are invalid or if a required parameter is missing.

Example Request


curl 'https://api.impact.com/Advertisers/<AccountSID>/Ads' \
  -X POST \
  -u '<AccountSid>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'Name=My New API Ad' \
  -d 'CampaignId=1017' \
  -d 'AdType=TEXT_LINK' \
  -d 'MobileFallbacks.ANDROID=12345' \
  -d 'MobileFallbacks.IOS=67890' \
  -d 'Language=ENGLISH' \
  -d 'LinkText=Check out my new link.'

Example Response


{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Ads/600000"
}