Offer Anatomy

overview the moments api delivers offers provisioned to your account that you can display to your users this guide explains the structure of these offers and how to effectively use the response elements to build compelling offer displays offer display formats the moments api provides the flexibility to present offers in various formats based on your application's needs and design requirements two common display formats are single offer unit (sou) a single offer unit displays one offer at a time, allowing users to focus their attention on a specific opportunity presents a single offer with complete details includes navigation controls to browse through additional offers sequentially maximizes user focus on individual offers multi offer unit (mou) a multi offer unit shows multiple offers simultaneously, enabling users to compare options at a glance displays several offers side by side in a grid or carousel format allows quick comparison between different opportunities efficient use of screen real estate for multiple offers these are just examples of display units you are not limited to implementing them in a specific way feel free to design the display format that works best for your use case sample api response { "data" { "offers" \[ { "id" 4008, "title" "you unlocked momentscience for 90 days free!", "description" "momentscience lets you capture revenue across your user's moments delight your users with relevant offers at the right time get 3 months free!", "click url" "https //track momentscience com/sdk/offer click?o id=4008\&c id=1284\&p id=1501\&sess id=03a7c834ffce7ff88ff45f980577ea42a03ec904\&fp=string", "image" "https //adpx b cdn net/campaigns/1284/598d561b6afb86b76d3137545572a3a9 png", "terms and conditions" "\<ul>\n \<li>must be 18 or older \</li>\n \<li>cancel anytime, subject to terms \</li>\n \<li>terms apply \</li>\n\</ul>", "pixel" "https //track momentscience com/sdk/v2/impression/p png?o id=4008\&c id=1284\&p id=1501\&sess id=03a7c834ffce7ff88ff45f980577ea42a03ec904\&fp=string\&cbuster=%7bcbuster%7d", "cta yes" "try out momentscience!", "cta no" "no, thanks", "beacons" { "close" "https //track momentscience com/event/record/close?oid=4008\&cid=1284\&pid=1501\&sess id=03a7c834ffce7ff88ff45f980577ea42a03ec904\&fp=string", "no thanks click" "https //track momentscience com/event/record/no thanks click?oid=4008\&cid=1284\&pid=1501\&sess id=03a7c834ffce7ff88ff45f980577ea42a03ec904\&fp=string" }, "creatives" \[ { "id" 939, "url" "https //adpx b cdn net/campaigns/1284/598d561b6afb86b76d3137545572a3a9 png", "height" 1200, "width" 1200, "type" "png", "is primary" true, "aspect ratio" 1 } ], "short description" "capture revenue across your user's moments get 3 months free!", "short headline" "3 free months of momentscience!", "advertiser name" "momentscience" } ], "settings" { "offerwall url" "https //get perkswall com/offerwall?accountid=fbe15a0c6f803ef4\&offer count=3\&auto show=1\&show logo=1\&show header=1\&show shadow=0\&show image=1\&font family=open+sans\&session id=1d979e855122b01d5eac8622e3a7937609abefdc", "offerwall cta" "more offers" }, "count" 1, "privacy url" "https //www momentscience com/end user privacy policy" } } core offer components this section outlines key api parameters for constructing a multi offer unit (mou) and single offer unit (sou) a offers\[] image use for the url of the offer's main creative b offers\[] title use for the offer’s title or headline note use offers\[] short headline for smaller formats if space is limited c offers\[] description use for the offer’s description note use offers\[] short description for smaller formats if space is limited d offers\[] click url use for the url that the positive cta should route the user to set the button's text using offers\[] cta yes e offers\[] beacons no thanks click use for firing a get request when the negative cta is clicked this is typically paired with offers\[] cta no , which contains the button label f offers\[] beacons close this parameter provides a url that is triggered via a get request when the close button is clicked it is primarily intended for single offer units (sou) to track and report user interactions, specifically indicating which offer the offer unit was closed on g settings offerwall url this parameter specifies the perkswall url to which users are redirected after clicking on the perkswall button the button text can be retrieved from settings offerwall cta h offers\[] terms and conditions this parameter contains the offer's terms and conditions in html format, typically as an unordered list ( \<ul> ) render it as html to maintain formatting some offers may not include this field if empty, assume no specific terms apply offer display tracking pixel the offer display tracking pixel is critical in tracking when an offer is shown to the user, providing essential data for performance monitoring and analytics it is triggered every time the associated creative is rendered on the user’s screen parameter location data offers\[] pixel type url usage guidelines the pixel url should be fired as soon as the creative is visible to the user, representing that the offer was shown ensure the pixel fires only once per impression to avoid duplicate data send an http get request to the url in data offers\[] pixel this pixel helps ensure accurate measurement of offer impressions, which is vital for understanding user engagement, optimizing campaigns, and analyzing the effectiveness of the displayed offers creative selection guide the creatives array provides multiple image options for different display contexts selection criteria use the image where is primary true as your default option choose images based on their aspect ratio value square format ( aspect ratio = 1 ) ideal for tiles and balanced layouts portrait format ( aspect ratio < 1 ) better for mobile and vertical spaces landscape format ( aspect ratio > 1 ) suitable for banners and horizontal layouts image optimization optimize creative display by appending transformation parameters to image urls \# resize to specific width https //image url png?width=300 \# resize to specific height https //image url png?height=200 \# adjust aspect ratio https //image url png?aspect ratio=16 9 if you're running into any issues while going through the integration process, feel free to contact us at mailto\ help\@momentscience com