You can create a Banner, Coupon, or Text Link ad in the impact.com platform via API. Specify the ad's content and characteristics by setting the values of the parameters passed.

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

The kind of ad that's provided.

CustomAdServingUrl conditionally required

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

• Required if AdType: BANNERand not usingAdCodeTemplateorBannerCreativeFile.
• Either AdCodeTemplate or CustomAdServingUrl is required.

AdCodeTemplate conditionally required

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

• Required if AdType: BANNER and not using CustomAdServingUrl or BannerCreativeFile.
• Either AdCodeTemplate or CustomAdServingUrl is required.

BannerCreativeFile conditionally required

Allows you to add or change the banner ad's creative image.

• Required if AdType: BANNER and not using CustomAdServingUrl or AdCodeTemplate.
• Can only be used for AdType: BANNER.

Requirements:

• The creative file must be an image (jpg, jpeg, png, gif) with a maximum file size of 25MB.
• The input is a reference to the file in the user’s machine. Must use the --form prefix in a cURL call.

CouponLinkName conditionally required

Hyperlinked text of the ad.

• Required if AdType: COUPON.
• Can only be used if AdType: COUPON.

LinkText conditionally required

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

• Required if AdType: TEXT_LINK.

Language required

The language the ad is hosted in.

Description optional

Additional information about the ad available to partners.

LandingPage optional

The URL for the landing page.

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, this field should contain IDs of the partners who can use the ad.

• Submit the partner IDs in an array, e.g., [111111, 222222, 333333].

TargetMediaPartnerGroups optional

If the ad is restricted to certain partner groups, this field should contain the IDs of the partner groups that can use the ad.

• Submit the group IDs in an array, e.g., [123456, 654321, 121212].

More Parameters

Returns

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

curl 'https://api.impact.com/Advertisers/<AccountSID>/Ads' \
  -X POST \
  -H 'Accept: application/json' \ 
  -H 'Content-Type: multipart/form-data' \
  -H 'Authorization: Basic' \ 
  -F 'Name=My New API Ad' \
  -F 'CampaignId=1017' \
  -F 'AdType=BANNER' \
  -F 'Language=ENGLISH' \
  -F 'BannerCreativeFile=@"/Users/CarrieOakey/MyNewCreative.png"'

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