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.

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.

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.

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

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.

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.'

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