> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/brand-api-reference-v12/reference/ads/models.md).

# Models

## The Ad object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Ads","version":"v12"},"components":{"schemas":{"Ad":{"type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string"},"Description":{"type":"string"},"CampaignId":{"type":"string"},"CampaignName":{"type":"string"},"AdType":{"type":"string","enum":["BANNER","TEXT_LINK","COUPON"]},"LandingPage":{"type":"string","format":"uri"},"MobileFallbacks":{"type":"object","properties":{"Android":{"type":"string","description":"The SystemAppId of the Android mobile app."},"IOS":{"type":"string","description":"The SystemAppId of the iOS mobile app."}}},"DateCreated":{"type":"string","format":"date-time"},"DateLastUpdated":{"type":"string","format":"date-time"},"CustomAdServingUrl":{"type":"string","format":"uri"},"IabAdUnit":{"type":"string"},"ThirdPartyServableAdCreativeHeight":{"type":"string"},"ThirdPartyServableAdCreativeWidth":{"type":"string"},"BannerAlternativeTag":{"type":"string"},"LinkText":{"type":"string"},"CouponLinkName":{"type":"string"},"GetHtmlCodeType":{"type":"string","enum":["HTML_AND_IFRAME","IFRAME_ONLY"]},"Labels":{"type":"string","description":"Comma-separated key terms."},"AllowDeepLinking":{"type":"string"},"Language":{"type":"string","description":"The language of the ad creative. Possible values: `AFRIKAANS`, `ARABIC`, `BULGARIAN`, `CHINESE`, `CHINESE_TRADITIONAL`, `CZECH`, `DANISH`, `DUTCH`, `ENGLISH`, `ENGLISH_GB`, `ENGLISH_AU`, `ENGLISH_CA`, `ENGLISH_NZ`, `ENGLISH_ZA`, `ESTONIAN`, `FILIPINO`, `FINNISH`, `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`."},"LimitedTimeStartDate":{"type":"string","format":"date-time"},"LimitedTimeEndDate":{"type":"string","format":"date-time"},"RestrictedMediaPartners":{"type":"array","items":{"type":"string"}},"RestrictedMediaPartnerGroups":{"type":"array","items":{"type":"string"}},"Season":{"type":"string","description":"If the ad has a seasonal promotional theme, this is the season the ad targets. Possible 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":{"type":"string","format":"uri-reference"},"DealId":{"type":"string"},"DealName":{"type":"string"},"AdCodeTemplate":{"type":"string"},"CouponAllowCustomPromoCode":{"type":"string"},"CustomisationCharge":{"type":"string"},"MobileReady":{"type":"string"},"PhoneTracking":{"type":"string"},"PromoCodeTracking":{"type":"string"},"TopSeller":{"type":"string"},"DealDescription":{"type":"string"},"DealState":{"type":"string"},"DealType":{"type":"string"},"DealScope":{"type":"string"},"DealProducts":{"type":"array","items":{"type":"string"}},"DealCategories":{"type":"string"},"DiscountType":{"type":"string"},"DiscountAmount":{"type":"string"},"DiscountCurrency":{"type":"string"},"DiscountPercent":{"type":"string"},"DiscountMaximumPercent":{"type":"string"},"DiscountPercentRangeStart":{"type":"string"},"DiscountPercentRangeEnd":{"type":"string"},"Gift":{"type":"string"},"RebateAmount":{"type":"string"},"RebateCurrency":{"type":"string"},"DealDefaultPromoCode":{"type":"string"},"MinimumPurchaseAmount":{"type":"string"},"MinimumPurchaseAmountCurrency":{"type":"string"},"MaximumSavingsAmount":{"type":"string"},"MaximumSavingsCurrency":{"type":"string"},"BogoBuyQuantity":{"type":"string"},"BogoBuyScope":{"type":"string"},"BogoBuyName":{"type":"string"},"BogoBuyImageUrl":{"type":"string"},"BogoGetQuantity":{"type":"string"},"BogoGetScope":{"type":"string"},"BogoGetDiscountType":{"type":"string"},"BogoGetName":{"type":"string"},"BogoGetImageUrl":{"type":"string"},"BogoGetDiscountAmount":{"type":"string"},"BogoGetDiscountCurrency":{"type":"string"},"BogoGetDiscountPercent":{"type":"string"},"PurchaseLimitQuantity":{"type":"string"},"DealStartDate":{"type":"string","format":"date-time"},"DealEndDate":{"type":"string","format":"date-time"},"SynchAdsPromoCodes":{"type":"string"},"DealRestrictedMediaPartners":{"type":"array","items":{"type":"string"}},"DealRestrictedMediaPartnerGroups":{"type":"array","items":{"type":"string"}}}}}}}
```

## The AdCreateUpdate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Ads","version":"v12"},"components":{"schemas":{"AdCreateUpdate":{"type":"object","description":"Schema for creating and updating an Ad. Some fields are conditionally required based on AdType.","properties":{"Name":{"type":"string"},"CampaignId":{"type":"string"},"AdType":{"type":"string","enum":["BANNER","TEXT_LINK","COUPON"]},"Language":{"type":"string","description":"The language of the ad creative. Possible values: `AFRIKAANS`, `ARABIC`, `BULGARIAN`, `CHINESE`, `CHINESE_TRADITIONAL`, `CZECH`, `DANISH`, `DUTCH`, `ENGLISH`, `ENGLISH_GB`, `ENGLISH_AU`, `ENGLISH_CA`, `ENGLISH_NZ`, `ENGLISH_ZA`, `ESTONIAN`, `FILIPINO`, `FINNISH`, `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":{"type":"string"},"LandingPage":{"type":"string","format":"uri"},"CustomAdServingUrl":{"type":"string","format":"uri","description":"Required for BANNER if not using AdCodeTemplate or BannerCreativeFile."},"AdCodeTemplate":{"type":"string","description":"Required for BANNER if not using CustomAdServingUrl or BannerCreativeFile."},"BannerCreativeFile":{"type":"string","format":"binary","description":"Creative file for a BANNER ad. Use multipart/form-data."},"CouponLinkName":{"type":"string","description":"Required for COUPON ad type."},"CouponAllowCustomPromoCode":{"type":"boolean","description":"Whether the ad allows partners to use a custom promo code (instead of the default coupon code)."},"CustomisationCharge":{"type":"number","format":"decimal","description":"The charge applied when partners customise this ad."},"LinkText":{"type":"string","description":"Required for TEXT_LINK ad type."},"IabAdUnit":{"type":"string"},"ThirdPartyServableAdCreativeHeight":{"type":"string"},"ThirdPartyServableAdCreativeWidth":{"type":"string"},"BannerAlternativeTag":{"type":"string","description":"Only for BANNER ad type."},"GetHtmlCodeType":{"type":"string","enum":["HTML_AND_IFRAME","IFRAME_ONLY"]},"Labels":{"type":"string"},"AllowDeepLinking":{"type":"string"},"LimitedTimeStartDate":{"type":"string","format":"date-time"},"LimitedTimeEndDate":{"type":"string","format":"date-time"},"TargetMediaPartners":{"type":"array","items":{"type":"string"},"description":"Array of partner IDs to restrict the ad to."},"TargetMediaPartnerGroups":{"type":"array","items":{"type":"string"},"description":"Array of partner group IDs to restrict the ad to."},"MobileFallbacks":{"type":"object","properties":{"Android":{"type":"string"},"IOS":{"type":"string"}}},"Season":{"type":"string","description":"If the ad has a seasonal promotional theme, this is the season the ad targets. Possible 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`."},"MobileReady":{"type":"string"},"PhoneTracking":{"type":"string"},"PromoCodeTracking":{"type":"string"},"TopSeller":{"type":"string"},"DealId":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v12/reference/ads/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.