# Models

## The Ad object

```json
{"openapi":"3.1.0","info":{"title":"Partner Ads API","version":"16"},"components":{"schemas":{"Ad":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the ad (the impact.com Ad ID)."},"Name":{"type":"string","description":"Display name of the ad."},"Description":{"type":"string","description":"Additional information about the ad, visible to partners."},"CampaignId":{"type":"integer","description":"Unique identifier for the brand's program (campaign) that the ad is associated with."},"CampaignName":{"type":"string","description":"Display name of the brand's program (campaign) that the ad is associated with."},"Type":{"type":"string","enum":["BANNER","COUPON","TEXT_LINK"],"description":"The kind of ad."},"TrackingLink":{"type":"string","format":"uri","description":"The ad's impact.com tracking link, unique to your partner account."},"LandingPageUrl":{"type":"string","format":"uri","description":"The URL the tracking link redirects to (the brand's landing page)."},"AdvertiserId":{"type":"integer","description":"Unique identifier assigned by impact.com to the brand's advertiser account."},"AdvertiserName":{"type":"string","description":"Display name of the brand in impact.com."},"Code":{"type":"string","description":"The ad's HTML code with the tracking link embedded. Use the `/Code` endpoint to retrieve this with optional tracking parameters."},"IFrameCode":{"type":"string","description":"The ad's iframe code. Use the `/IFrameCode` endpoint to retrieve this with optional tracking parameters."},"Width":{"type":"integer","description":"For image ads, the width of the ad image in pixels."},"Height":{"type":"integer","description":"For image ads, the height of the ad image in pixels."},"CreativeUrl":{"type":"string","description":"Direct URL to the ad's creative asset (image, etc.)."},"Labels":{"type":"string","description":"Labels assigned to the ad by the brand."},"AllowDeepLinking":{"type":"boolean","description":"Whether the ad allows deep linking. If true, you can override the landing page URL via the landingPage parameter. If false, the landing page cannot be changed."},"MobileReady":{"type":"boolean","description":"Whether the ad is optimized for mobile devices."},"Language":{"type":"string","enum":["AFRIKAANS","ARABIC","BULGARIAN","CHINESE","CHINESE_TRADITIONAL","CZECH","DANISH","DUTCH","ENGLISH","ENGLISH_GB","ANGLISH_AU","ENGLISH_CA","ENGLISH_NZ","ENGLISH_ZA","ESTONIAN","FILIPINO","FINISH","FRENCH","FRENCH_CA","GERMAN","HEBREW","HINDI","INDONESIAN","ITALIAN","JAPANESE","KOREAN","LATVIAN","LITHUANIAN","MALAY","MALTESE","NORWEGIAN","PORTUGUESE","PORTUGUESE_BR","POLISH","RUSSIAN","SLOVENIAN","SPANISH","SPANISH_MX","SWEDISH","THAI","TURKISH","VIETNAMESE"],"description":"The language the ad is hosted in."},"StartDate":{"type":"string","format":"date-time","description":"The date and time the ad becomes active (ISO 8601). For ads without a start date, this is the date it was added to impact.com."},"EndDate":{"type":"string","format":"date-time","description":"The date and time the ad expires (ISO 8601). Empty if the ad has no end date."},"Season":{"type":"string","enum":["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"],"description":"The seasonal promotional theme of the ad, if applicable."},"TopSeller":{"type":"boolean","description":"Whether the ad promotes a top-selling item."},"SubjectLines":{"type":"string","description":"For email ads, the subject line of the email."},"FromAddresses":{"type":"string","description":"For email ads, the sender address of the email."},"UnsubscribeLink":{"type":"string","format":"uri","description":"For email ads, the unsubscribe link included in the email."},"DealId":{"type":"integer","description":"Unique identifier for the deal associated with the ad."},"DealName":{"type":"string","description":"Display name of the deal associated with the ad."},"DealDescription":{"type":"string","description":"Additional information about the deal associated with the ad."},"DealState":{"type":"string","enum":["ACTIVE","EXPIRED","PENDING"],"description":"The current state of the deal associated with the ad."},"DealType":{"type":"string","enum":["GENERAL_SALE","FREE_SHIPPING","GIFT_WITH_PURCHASE","REBATE","BOGO"],"description":"How the deal is applied to the items in the ad."},"DealScope":{"type":"string","enum":["CATEGORY","ENTIRE_STORE","PRODUCT"],"description":"The scope of the deal — whether it applies to a specific product, category, or the entire store."},"DealPublic":{"type":"boolean","description":"Whether the deal associated with the ad is publicly visible."},"DealProducts":{"type":"array","description":"If DealScope is PRODUCT, an array of product objects the deal applies to.","items":{"type":"object","properties":{"ProductName":{"type":"string","description":"Name of the product the deal applies to."},"ProductImageURL":{"type":"string","format":"uri","description":"URL to the product's image."},"ProductBeforePriceAmount":{"type":"integer","description":"Product price before the deal is applied."},"ProductBeforePriceCurrency":{"type":"string","description":"ISO 4217 currency code for the before-deal price."},"ProductAfterPriceAmount":{"type":"integer","description":"Product price after the deal is applied."},"ProductAfterPriceCurrency":{"type":"string","description":"ISO 4217 currency code for the after-deal price."}}}},"DealCategories":{"type":"string","description":"If DealScope is CATEGORY, a comma-separated list of product categories the deal applies to."},"DiscountType":{"type":"string","enum":["FIXED","PERCENT","PERCENT_MAXIMUM","PERCENT_RANGE"],"description":"The type of discount applied when the deal is activated."},"DiscountAmount":{"type":"number","format":"decimal","description":"If DiscountType is FIXED, the fixed discount amount."},"DiscountCurrency":{"type":"string","description":"If DiscountType is FIXED, the ISO 4217 currency code for DiscountAmount."},"DiscountPercent":{"type":"number","format":"float","description":"If DiscountType is PERCENT, the discount percentage."},"DiscountMaximumPercent":{"type":"number","format":"float","description":"If DiscountType is PERCENT_MAXIMUM, the maximum discount percentage a customer can receive."},"DiscountPercentRangeStart":{"type":"number","format":"float","description":"If DiscountType is PERCENT_RANGE, the lowest discount percentage a customer can receive."},"DiscountPercentRangeEnd":{"type":"number","format":"float","description":"If DiscountType is PERCENT_RANGE, the highest discount percentage a customer can receive."},"Gift":{"type":"string","description":"If DealType is GIFT_WITH_PURCHASE, the name of the product to be gifted."},"RebateAmount":{"type":"number","format":"decimal","description":"If DealType is REBATE, the rebate amount."},"RebateCurrency":{"type":"string","description":"If DealType is REBATE, the ISO 4217 currency code for RebateAmount."},"DealDefaultPromoCode":{"type":"string","description":"The default promo code for the associated deal."},"MinimumPurchaseAmount":{"type":"number","format":"decimal","description":"The minimum spend required before the deal is applied."},"MinimumPurchaseAmountCurrency":{"type":"string","description":"ISO 4217 currency code for MinimumPurchaseAmount."},"MaximumSavingsAmount":{"type":"number","format":"decimal","description":"The maximum amount a customer can save when the deal is applied."},"MaximumSavingsCurrency":{"type":"string","description":"ISO 4217 currency code for MaximumSavingsAmount."},"BogoBuyQuantity":{"type":"integer","description":"If DealType is BOGO, the number of 'buy' items required to activate the deal."},"BogoBuyScope":{"type":"string","enum":["PRODUCT","CATEGORY"],"description":"If DealType is BOGO, the scope of the 'buy' items."},"BogoBuyName":{"type":"string","description":"If DealType is BOGO, the name of the 'buy' item(s)."},"BogoBuyImageUrl":{"type":"string","format":"uri","description":"If DealType is BOGO, the URL to the 'buy' product's image."},"BogoGetQuantity":{"type":"integer","description":"If DealType is BOGO, the number of 'get' items the customer receives a discount on."},"BogoGetScope":{"type":"string","enum":["PRODUCT","CATEGORY"],"description":"If DealType is BOGO, the scope of the 'get' items."},"BogoGetDiscountType":{"type":"string","enum":["FREE","AMOUNT","PERCENT"],"description":"If DealType is BOGO, the type of discount applied to the 'get' items."},"BogoGetName":{"type":"string","description":"If DealType is BOGO, the name of the 'get' item(s)."},"BogoGetImageUrl":{"type":"string","format":"uri","description":"If DealType is BOGO, the URL to the 'get' product's image."},"BogoGetDiscountAmount":{"type":"number","format":"decimal","description":"If BogoGetDiscountType is AMOUNT, the fixed discount amount taken off the 'get' item's price."},"BogoGetDiscountCurrency":{"type":"string","description":"If BogoGetDiscountType is AMOUNT, the ISO 4217 currency code for BogoGetDiscountAmount."},"BogoGetDiscountPercent":{"type":"number","format":"float","description":"If BogoGetDiscountType is PERCENT, the discount percentage taken off the 'get' item's price."},"PurchaseLimitQuantity":{"type":"integer","description":"If DealType is BOGO, the maximum quantity of 'buy' items a customer can purchase at once. A value of 0 means no limit."},"DealStartDate":{"type":"string","format":"date-time","description":"The date and time the deal begins (ISO 8601)."},"DealEndDate":{"type":"string","format":"date-time","description":"The date and time the deal ends (ISO 8601)."},"DealDateCreated":{"type":"string","format":"date-time","description":"The date and time the deal was created (ISO 8601)."},"DealDateLastUpdated":{"type":"string","format":"date-time","description":"The date and time the deal was last updated (ISO 8601)."},"Uri":{"type":"string","description":"Unique reference to the ad object in the impact.com API."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/partner-api-reference/reference/ads/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.