Passing Payload Values

adspostx is now momentscience! momentscience! 🎉 we have rebranded adspostx to momentscience all the latest documentation and updates can now be found at momentscience documentation https //docs momentscience com/ introduction in adspostx, you can pass various customer and order details to offers for different purposes this documentation is all about efficiently passing payload values within the adspostx ecosystem by doing so, you can improve personalization, targeting, reporting, and integration efficiency main uses for payloads offer unit personalization utilize passed payload values as macros to personalize offer messaging, making the user experience more personal for instance, employ {{firstname}} to customize the header of the sou, like 'john, your order is complete!' enhanced targeting with payload values, you can target offers more effectively, ensuring that the right content reaches the right audience customized reporting you can pass payload values to attribute your implementantions to generate reports to segragate performance and giving you deeper insights into your business performance supporting loyaltyboost offers payload values facilitate rewarding users for engaging with partners through loyaltyboost offers passing payload values reserved attributes in adspostx, certain attributes are reserved, meaning they already have predefined meanings attached to them while our system allows passing any ad hoc key value pairs in the payload, it's important to be aware of these reserved attributes to avoid unintended behavior these reserved attributes serve specific purposes within the adspostx ecosystem attribute description country restricts offers by geographical location, overriding locality sensed by ip address should be in the iso 3166 1 alpha 2 2 character country code format example if the user is from the united states, the country value should be us adpx fp used for unique user identification, frequency capping, and enables yield optimizations this identifier can be any unique string or hashed value that represents a unique user theme id applies theme styles defined in the adspostx dashboard ip the ip address of the end user to be passed through only used as a reserved attribute for the following implementation methods perkswall api docid p4e5bbrrzknwv5pe5qn moments api docid\ gxzilkh2zioffctbudr4c ua the user agent of the end user only used as a reserved attribute for the following implementation methods moments api docid\ gxzilkh2zioffctbudr4c perkswall api docid p4e5bbrrzknwv5pe5qn dev controls impression recording and deactivates geo filtering when it’s set to a value that evaluates to true tags accepts comma separated lists or javascript array objects only applies as a reserved attribute for passing payload values types for the following implementation methods js sdk (for websites) docid\ b5ymrgz8pydiw0q d1um7 moments api docid\ gxzilkh2zioffctbudr4c perkswall api docid p4e5bbrrzknwv5pe5qn zipcode enables targeting based on 5 digit zip codes if provided, it overrides the automatically identified zipcode from the incoming request’s ip age allows age targeting for personalized offers custom key value attributes you can also add any number of custom key value payload attributes to include additional details these attributes are passed back on conversion reports and can be used for analysis related to impressions and clicks custom key value payload attributes are also used by adspostx to help match relevant offers to your users for example, you can pass custom attributes like membershipid , source , and interests passing custom key value attributes membershipid "a45gre987343pkd", source "email", interests "gardening" recommended attributes attribute description email user email firstname user first name zipcode user zip code mobile user mobile number confirmationref can be used to associate a confirmation number with the adspostx request this reference can then be used in macros for personalizing adspostx units to better suit your needs country the user country payload should be in the iso 3166 1 alpha 2 2 character country code format example if the user is from the united states, the country value should be us adpx fp unique user identification that represents a unique user example usages for payload attributes identifying unique users to uniquely identify a user, adspostx uses various signals and inferred uniqueness however, you can provide your own identifier using the adpx fp attribute this identifier can be any unique string or hashed value it helps adspostx utilize this value to distinguish individual users, applying frequency caps and preventing repeated displays of offers when a user opts out example using js sdk window\ adpxuser = { // other payload attributes adpx fp "replace with your value" }; example using moments and perkswall api { // other payload attributes "adpx fp" "replace with your value" } direct offer links https //trk pubtailer com/sdk/offer click?o id=xxxx\&c id=xxx\&p id=xx\&user id=3a99022vv\&adpx fp=replace with your value perkswall direct offer links https //get perkswall com/offerwall?accountid=f0f16460 f739 4ec0 b220 b31745a78b3b\&o id=3923&\&adpx fp=replace with your value determining the source of your adspostx offers to better analyze the performance of your adspostx units and segment traffic, consider including a subid or placement attribute replace the value with any text you prefer to track impressions, clicks, and conversions to that attribute example using js sdk window\ adpxuser = { // other payload attributes subid "moments offer unit", placement "post transaction" }; example using moments and perkswall api { // other payload attributes "subid" "moments offer unit", "placement" "post transaction" } direct offer links https //trk pubtailer com/sdk/offer click?o id=xxxx\&c id=xxx\&p id=xx\&user id=3a99022vv\&subid=moments offer unit\&placement=post transaction perkswall direct offer links https //get perkswall com/offerwall?accountid=f0f16460 f739 4ec0 b220 b31745a78b3b\&o id=3923\&subid=moments offer unit\&placement=post transaction passing contextual information along with using custom key value attributes, you can use the tags attribute to provide additional context for more relevant and personalized offers the tags attribute can have a value passed in as a comma separated list of values or as a javascript array of strings the tags attribute only applies to the following types of implementations js sdk (for websites) docid\ iiccjfbeko pttakokgbr moments api docid\ gxzilkh2zioffctbudr4c perkswall api docid p4e5bbrrzknwv5pe5qn example using js sdk window\ adpxuser = { // other payload attributes tags "top category, sub category", // or tags \[ 'category one', 'category two' ], }; example using moments and perkswall api { // other payload attributes "tags" "top category, sub category", //or "placement" \['category one','category two'] } supported methods for passing payload values moments api to pass a payload value using the moments api, include key value payload attributes within the api request body as a json object you have the flexibility to add any number of custom key value payload attributes to provide additional details for your payload perkswall api to pass a payload value using the perkswall api, include key value payload attributes within the api request body as a json object you have the flexibility to add any number of custom key value payload attributes to provide additional details for your payload moments js sdk payload values are specified within the properties of the window\ adpxuser object setting init attributes window\ adpxuser = { email 'user\@domain com', firstname 'john', zipcode '74839', theme id 'adspostx post transaction', country 'us', adpx fp 'df983hgjdl9023klasjd', placement 'post transaction', loyalty program id '23445665393' }; direct offer links to pass payload values into direct offer links, simply append any attribute value pair to the end of the url example of a direct offer link that includes two payload attributes user id and order id https //trk pubtailer com/sdk/offer click?o id=xxxx\&c id=xxx\&p id=xx \&user id=3a99022vv\&order id=402230000 t he same method to add payload values in direct offer links can be used on click url values returned in the offer catalog api docid\ lid2wroypvx0zpvdmhn4s response perkswall direct offer links to pass payload values into perkswall direct offer links, simply append any attribute value pair to the end of the url example of a perkswall direct offer link that includes two payload attributes user id and order id https //get perkswall com/offerwall?accountid=99e58babc94df55a\&offer count=9\&auto show=true\&show logo=true\&show header=true\&show shadow=false\&show image=true\&o id=3923 \&user id=3a99022vv\&order id=402230000