The Acoustic Exchange Developer Hub

Welcome to the Acoustic Exchange developer hub. You'll find comprehensive guides and documentation to help you start working with Acoustic Exchange as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Event publisher samples

Offer Accepted

<?xml version="1.0" encoding="UTF-8"?>
<UBX_EVENT_MAPPING dataFileFormat="TSV" sourceEvent="offerAccepted">
   <UBX_EVENT sourceEvent="offerAccepted">
      <code>offerAccepted</code>
      <channel>Paid Media / AdTech</channel>
      <timestamp sourceIndex="1" sourceType="timestamp" sourceFormat="yyyy-MM-dd HH:m"></timestamp>
      <attributes>
         <attribute>
            <name>eventName</name>
            <value>Accepted Offer</value>
            <type>String</type>
         </attribute>
		 <attribute sourceIndex="3">
		    <name>AD_PUBLISHER</name>
			<type>String</type>
		 </attribute>
		 <attribute sourceIndex="4">
		    <name>ADVERTISER_ID</name>
			<type>String</type>
         </attribute>
		 <attribute sourceIndex="5">
		    <name>advertiserName</name>
			<type>String</type>
         </attribute>
		 <attribute sourceIndex="6">
		    <name>CATEGORY</name>
			<type>String</type>
		 </attribute>
		 <attribute sourceIndex="7">
		    <name>CLICK_URL</name>
			<type>String</type>
	     </attribute>
		 <attribute sourceIndex="8">
		    <name>CREATIVE_CODE</name>
			<type>String</type>
	     </attribute>
		 <attribute sourceIndex="9">
		 	<name>TOTAL_COST_CPM</name>
			<type>String</type>
		 </attribute>
		 <attribute sourceIndex="10">
		 	<name>TOTAL_SPENT_CPM</name>
			<type>String</type>
		 </attribute>
		 <attribute sourceIndex="11">
		 	<name>VENDOR_SOURCE</name>
			<type>String</type>
		 </attribute>
	 </attributes>
     <identifiers>
         <identifier sourceIndex="2">
         	<name>USER_EMAIL</name>
		 	<type>cookieID</type>
		 </identifier>
	</identifiers>
  </UBX_EVENT>
</UBX_EVENT_MAPPING>
DATETIME	USER_EMAIL	AD_PUBLISHER	ADVERTISER_ID	ADVERTISER_NAME	CATEGORY	CLICK_URL	CREATIVE_CODE	TOTAL_COST_CPM	TOTAL_SPENT_CPM	VENDOR_SOURCE
2019-05-22 10:25:15	[email protected]	Facebook	ID1	Uber	Travel	uber.com	ubercode	12900	10022	vendor source 1
2019-05-22 10:28:17	[email protected]	Instagram	ID2	Gucci	Fashion	gucci.com	guccicode	5435	3324	vendor source 2
2019-05-22 10:35:45	[email protected]	IBM	ID3	IBM COS	Cloud Storage	ibm.com	ibmcoscode	7790	5556	vendor source 3
2019-05-22 10:54:54	[email protected]	Google	ID4	Dell	Electronics	dell.com	dellcode	2334	1908	vendor source 4

Product View

<?xml version="1.0" encoding="UTF-8"?>
<UBX_EVENT_MAPPING dataFileFormat="UBXEventBatchJSON">
	<UBX_EVENT sourceEvent="ibmproductView">
        <code>ibmproductView</code>
        <channel>Web</channel>
        <attributes>
            <attribute sourceName="aa.productName">
                <name>productName</name>
                <type>String</type>
            </attribute>
            <attribute sourceName="aa.productId">
                <name>productId</name>
                <type>String</type>
            </attribute>
        </attributes>
        <identifiers>
            <identifier sourceName="aa.interactionid">
                <name>interactionId</name>
                <type>String</type>
            </identifier>
            <identifier sourceName="aa.email">
                <name>email</name>
                <type>String</type>
            </identifier>
        </identifiers>
    </UBX_EVENT>
</UBX_EVENT_MAPPING>
{"eventbatch":[{"identifiers":[{"name":"aa.email","value":"[email protected]"},{"name":"aa.interactionid","value":"00003690801155509439432330000003"}],"events":[{"code":"ibmproductView","timestamp":"2019-04-12T10:01:01-0400","channel":"Web","attributes":[{"name":"aa.productName","value":"Men's Jeans"},{"name":"aa.productId","value":"stg-4536-7668"}]}]}]}

Registration

<?xml version="1.0" encoding="UTF-8"?>
<UBX_EVENT_MAPPING dataFileFormat="CSV" sourceEvent="ibmregistration">
   <UBX_EVENT sourceEvent="ibmregistration">
       <code>ibmregistration</code>
       <channel>Web</channel>
       <timestamp sourceIndex="1" sourceType="timestamp" sourceFormat="yyyy-MM-dd HH:mm:ss"></timestamp>
       <attributes>
           <attribute>
               <name>eventName</name>
               <value>Registration</value>
               <type>String</type>
           </attribute>           
           <attribute sourceIndex="3">
               <name>USERAGENT_TYPE</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="4">
               <name>USERAGENT_FAMILY</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="5">
               <name>USERAGENT_DEVICETYPE</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="6">
               <name>USERAGENT_OS</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="7">
               <name>LANGUAGE</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="8">
               <name>GEO_CITY</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="9">
               <name>GEO_CITYCONF</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="10">
               <name>GEO_POSTAL</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="11">
               <name>GEO_POSTALCONF</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="12">
               <name>GEO_AREACODE</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="13">
               <name>GEO_REGION</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="14">
               <name>GEO_COUNTRY</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="15">
               <name>GEO_GMTOFFSET</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="16">
               <name>GEO_DMA</name>
               <type>String</type>
           </attribute>
		   <attribute sourceIndex="17">
               <name>QUERYSTRING</name>
               <type>String</type>
           </attribute>
       </attributes>
       <identifiers>
           <identifier sourceIndex="2">
               <name>USERID</name>
               <type>cookieID</type>
           </identifier>          
       </identifiers>
   </UBX_EVENT>
</UBX_EVENT_MAPPING>
DATETIME,USERID,USERAGENT_TYPE,USERAGENT_FAMILY,USERAGENT_DEVICETYPE,USERAGENT_OS,LANGUAGE,GEO_CITY,GEO_CITYCONF,GEO_POSTAL,GEO_POSTALCONF,GEO_AREACODE,GEO_REGION,GEO_COUNTRY,GEO_GMTOFFSET,GEO_DMA,QUERYSTRING
2019-05-21 11:09:24,452fa06fd0bf55f4777f2c2033525eb7,SM-J700T,Chrome Mobile,Smartphone,Android,English,los angeles,65,90009,35,310/424,CA,US,-25200,803,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:54,36d17521808c1452a7de76c5e38b2421,SM-G955U,Chrome Mobile,Smartphone,Android,Russian,los angeles,60,90044,30,323,CA,US,-25200,803,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:12,f2743713a4f97075e6ea55ad755d7f28,Browser,Chrome,Personal computer,Mac OS X,Spanish,ft worth,65,76137,30,817/682,TX,US,-18000,623,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:16,5712ee8ecee794715a7bd3e9c3cbed1a,Browser,Chrome,Personal computer,Windows,English,college station,70,77840,40,979,TX,US,-18000,625,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:19,362e5148306a6294ae92fc4f07ae16a4,SAMSUNG SM-G930A,Chrome Mobile,Smartphone,Android,German,san marcos,60,78666,30,512/737,TX,US,-18000,635,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:56,14e6e35bf5c47fd540d9041f6dac9732,iPhone,Mobile Safari,Smartphone,iOS,French,coral gables,65,33134,35,305/786,FL,US,-14400,528,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:10,cedb350ba0f334eeeba416156e03f196,iPhone,Mobile Safari,Smartphone,iOS,Russian,van nuys,95,91405,90,818,CA,US,-25200,803,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:14,85331dbfbb736a9ffc84fb3d99531d2f,SM-G930P,Chrome Mobile,Smartphone,Android,Ukrainian,jarrettsville,90,21084,90,410/443/667,MD,US,-14400,512,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0
2019-05-21 11:09:13,dc19b0b414773aa1aa5d2cd6e0236c0f,SAMSUNG SM-G890A,Chrome Mobile,Smartphone,Android,English,moreno valley,65,92555,35,951,CA,US,-25200,803,p=XXX&g=Y&cpid=123&plid=456&stid=789&crid=101112&j=0

Cart Add

<?xml version="1.0" encoding="UTF-8"?>
<UBX_EVENT_MAPPING dataFileFormat="UBXEventBatchJSON">
    <UBX_EVENT sourceEvent="cartAdd">
        <code>cartAdd</code>
        <channel>Web</channel>
        <attributes>
            <attribute sourceName="product.description">
                <name>productDesc</name>
                <type>String</type>
            </attribute>
            <attribute sourceName="product.id">
                <name>productId</name>
                <type>String</type>
            </attribute>
            <attribute sourceName="product.name">
                <name>productName</name>
                <type>String</type>
            </attribute>
            <attribute sourceName="product.quantity">
                <name>quantity</name>
                <type>String</type>
            </attribute>
            <attribute sourceName="product.price">
                <name>basePrice</name>
                <type>String</type>
            </attribute>
        </attributes>
        <identifiers>
            <identifier sourceName="visitorid">
                <name>x1VisitorId</name>
                <type>String</type>
            </identifier>
        </identifiers>
    </UBX_EVENT>
</UBX_EVENT_MAPPING>
{"eventbatch":[{"identifiers":[{"name":"visitorid","value":"[email protected]"}],"events":[{"code":"cartAdd","timestamp":"2019-04-11T11:01:04-0400","channel":"Web","attributes":[{"name":"product.description","value":"Computers"},{"name":"product.name","value":"Mac Book Air"},{"name":"product.quantity","value":"2"},{"name":"product.id","value":"apple-3542-99563"},{"name":"product.price","value":"945"}]}]}]}

Updated 6 months ago


Event publisher samples


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.