Ingesting Address Data

Suggest Edits

Address Fields as Pixel Parameters

To send address data in the Rockerbox conversion pixel, pass the attributes as individual fields or as a a JSON object.

📘

Exact Field Names

You MUST use the exact field names. Most specifically, at least one of the fields must contain the text address, such as rb_address_1.

Specification as individual fields

{
	"required": [
		"rb_country",
		"rb_state",
		"rb_city",
		"rb_address_1",
        "rb_address_2",
		"rb_zip_code"
	],
	"properties": {
		"rb_country": {
			"type": "string"
			"format": "ISO-3166-2 Alpha 2 Code"
		},
		"rb_state": {
			"type": "string",
			"format": "ISO-3166-2 Subdivision Code"
		},
		"rb_city": {
			"type": "string"
		},
		"rb_address_1": {
			"type": "string"
		},
        "rb_address_2": {
			"type": "string"
		},
		"rb_zip_code": {
			"type": "string"
		}
	}
}

Example as individual fields

<script type="text/javascript"> 
(function(d,RB) {if (!window.RB) { window.RB=RB;RB.queue=RB.queue||[];RB.track=RB.track||function(){RB.queue.push(Array.prototype.slice.call(arguments))};RB.initialize=function(s){RB.source=s};var a = d.createElement("script"); a.type="text/javascript"; a.async=!0; a.src="https://getrockerbox.com/assets/wxyz.js"; f=d.getElementsByTagName("script")[0]; f.parentNode.insertBefore(a,f);} } )(document,window.RB || {}); 
RB.disablePushState=true; 
RB.initialize(CLIENT_AUTH_ID); 
RB.track("conv.purchase",{ 
  ...
  "rb_country": "US",
  "rb_state": "NY",
  "rb_city": "New York",
  "rb_address_1": "123 Example Street",
  "rb_address_2": "Apt 101"
  "rb_zip_code": "Example Zip Code"
  ...
}); 
</script>

Example as an address object

<script type="text/javascript"> 
(function(d,RB) {if (!window.RB) { window.RB=RB;RB.queue=RB.queue||[];RB.track=RB.track||function(){RB.queue.push(Array.prototype.slice.call(arguments))};RB.initialize=function(s){RB.source=s};var a = d.createElement("script"); a.type="text/javascript"; a.async=!0; a.src="https://getrockerbox.com/assets/wxyz.js"; f=d.getElementsByTagName("script")[0]; f.parentNode.insertBefore(a,f);} } )(document,window.RB || {}); 
RB.disablePushState=true; 
RB.initialize(CLIENT_AUTH_ID); 
RB.track("conv.purchase",{
  ...
{
  "rb_address": {
  	"rb_country": "US",
  	"rb_state": "NY",
  	"rb_city": "New York",
  	"rb_street_1": "123 Example Street",
  	"rb_street_2": "Apt 101",
  	"rb_zip_code": "Example Zip Code"
	}
}
  ...
}); 
</script>

🚧

JSON Objects must NOT be encoded as strings

The individual fields and field names should be strings, but the object itself should not be enclosed in quotes

Updated almost 3 years ago