Creative
A Creative is a single visual representation of an Ad. The Creative object contains all of the necessary information to render a single creative, as well as properties necessary for interacting with the ad when the creative is displayed.
| Property | Type | Description |
|---|---|---|
| creativeId | string | The unique identifier of this creative |
| shortPreMessage | string | A very short version of the PreMessage. Should only be used if necessary due to offer display element being very small |
| thankYouMessage | string | The thank you message of an offer to which might be displayed to the customer once they redeem the offer |
| headline | string | A small message intended to be used as a headline for the offer. May be null or undefined for some offers |
| images | map< string, AdImage> | A map of images to use for the ad. The keys of the maps will be the image name and the value will be an AdImage object. Reference below for a list of possible image names/keys. |
| impressionToken | string | The impression token is used when marking an ad as served, parked, or activated and contains additional metadata about the ad that is required for processing. The exact contents of the token are undefined, and the tokens should never be "cached" for use different sessions or locations. In the event that multiple creatives are available for an ad, consumers should only use the impression token for the creative that is currently displayed. |
| termsAndConditions | string | The Terms and Conditions (T&C's) of an ad. The for,at is typically a <br/> separated list of terms. Can be undefined for some ads. |
| marketingCopy | string | The marketing copy for an ad. Can be undefined for some ads. |
| rewardCopy | string | The reward copy for an ad, such as the amount of cash back and any minimum spend details. Can be undefined for some ads. |
| links | map< string, Link> | Links associated with an ad, if any. Reference below for a list of possible link keys. |
| beacons | Beacons | Callbacks to be made when the user interacts with the ad |
| preMessage | string | The pre-expansion message to be displayed when the offer is closed or minimized. |
| postMessage | string | The post-expansion message of an offer to be displayed after an offer is expanded. |
Image Keys
Below is a non-exhaustive list of possible image names/keys that can be found in a creative:
| Image Key | Description |
|---|---|
| logo | The small logo for an offer. All Ads will have a "logo" entry |
| heroImage | A large image intended to be displayed at the top of the details dialog or otherwise prominently to the user. Not all ads will have a "heroImage" entry |
Link Keys
Below is a non-exhaustive list of possible link keys that can be found in a creative:
| Link Key | Description |
|---|---|
| callToActionLink | A link to the merchant's site, typically with text such as "Shop Now" or "View our locations". Not all ads will have this link. |