Product Customization | Kevel Audience

An event that describes the action of customizing a product.

Here's an example of a Product Customization:

• JavaScript
• Swift
• Kotlin

pcdp("event", "track", {

"clientId": "kevel",

"siteId": "kevel.com",

"type": "productCustomization",

"customFields": {

"debug": "true",

"role": "superuser"

},

"product": {

"itemGroupId": "p125",

"name": "My product",

"brand": "Nike",

"category": "Men/Shirts/Short Sleeve Shirts",

"categoriesList": [

"Men",

"Shirts",

"Short Sleeve Shirts"

],

"secondaryCategory": "Men/Collections/Summer Essentials/Short Sleeve Shirts",

"secondaryCategoriesList": [

"Men",

"Collections",

"Summer Essentials",

"Short Sleeve Shirts"

],

"currency": "EUR",

"promotions": [

"WINTERSALE"

],

"adult": false,

"size": "S",

"sizeSystem": "EU",

"customFields": {

"color": "blue"

},

"id": "p125zc",

"price": 102.5,

"quantity": 1,

"discount": {

"value": 5,

"currency": "EUR"

},

"gender": "male",

"sku": "p125zc-5"

},

"productCustomizations": [

"set fabric to linen"

]

})

import Foundation

let event = """{

"clientId": "kevel",

"siteId": "kevel.com",

"type": "productCustomization",

"customFields": {

"debug": "true",

"role": "superuser"

},

"product": {

"itemGroupId": "p125",

"name": "My product",

"brand": "Nike",

"category": "Men/Shirts/Short Sleeve Shirts",

"categoriesList": [

"Men",

"Shirts",

"Short Sleeve Shirts"

],

"secondaryCategory": "Men/Collections/Summer Essentials/Short Sleeve Shirts",

"secondaryCategoriesList": [

"Men",

"Collections",

"Summer Essentials",

"Short Sleeve Shirts"

],

"currency": "EUR",

"promotions": [

"WINTERSALE"

],

"adult": false,

"size": "S",

"sizeSystem": "EU",

"customFields": {

"color": "blue"

},

"id": "p125zc",

"price": 102.5,

"quantity": 1,

"discount": {

"value": 5,

"currency": "EUR"

},

"gender": "male",

"sku": "p125zc-5"

},

"productCustomizations": [

"set fabric to linen"

]

}"""

let trackUrl = "https://tr.cdp.\(websiteDomain)/events"

var urlComponents = URLComponents(string: trackUrl)!

urlComponents.queryItems = [

URLQueryItem(name: "id_\(idType)", value: id),

URLQueryItem(name: "cookies", value: "false")

]

var request = URLRequest(url: urlComponents.url!)

request.httpMethod = "POST"

request.setValue("application/json", forHTTPHeaderField: "Content-Type")

request.setValue(userAgent, forHTTPHeaderField: "User-Agent")

request.httpBody = event.data(using: .utf8)!

URLSession.shared.dataTask(with: request).resume()

import androidx.core.net.toUri

import org.json.JSONObject

import java.net.URL

import javax.net.ssl.HttpsURLConnection

val event = """{

"clientId": "kevel",

"siteId": "kevel.com",

"type": "productCustomization",

"customFields": {

"debug": "true",

"role": "superuser"

},

"product": {

"itemGroupId": "p125",

"name": "My product",

"brand": "Nike",

"category": "Men/Shirts/Short Sleeve Shirts",

"categoriesList": [

"Men",

"Shirts",

"Short Sleeve Shirts"

],

"secondaryCategory": "Men/Collections/Summer Essentials/Short Sleeve Shirts",

"secondaryCategoriesList": [

"Men",

"Collections",

"Summer Essentials",

"Short Sleeve Shirts"

],

"currency": "EUR",

"promotions": [

"WINTERSALE"

],

"adult": false,

"size": "S",

"sizeSystem": "EU",

"customFields": {

"color": "blue"

},

"id": "p125zc",

"price": 102.5,

"quantity": 1,

"discount": {

"value": 5,

"currency": "EUR"

},

"gender": "male",

"sku": "p125zc-5"

},

"productCustomizations": [

"set fabric to linen"

]

}"

val trackUri = "https://tr.cdp.$websiteDomain/events".toUri().buildUpon()

.appendQueryParameter("id_$idType", id)

.appendQueryParameter("cookies", "false")

// Network requests aren't allowed in main thread. Get adequate scope from context.

// See https://kotlinlang.org/docs/coroutines-guide.html for more info.

coroutineScope.launch(Dispatchers.IO) {

val conn = (URL(trackUri.toString()).openConnection() as HttpsURLConnection).apply {

requestMethod = "POST"

setRequestProperty("User-Agent", userAgent)

setRequestProperty("Content-Type", "application/json")

doOutput = true

}

conn.outputStream.use { os ->

os.write(event.toByteArray(Charsets.UTF_8))

}

try {

// Trigger the request

conn.responseCode

} finally {

conn.disconnect()

}

}

In more detail, the fields supported on every Product Customization are:

Facebook Conversion Tracking Details

A description of a tracking event to send to Facebook using Facebook Conversions API.

Product

The product being customized.

  "Men",
  "Shirts",
  "Short Sleeve Shirts"
]` | A hierarchically sorted list of the sub-categories that this product belongs to. The first item on this list should be the most general sub-category, while the last should be the most specific. Any item on this list should correspond to a sub-category of the item immediately preceding it. If 'category' is present and this field is left undefined, the default value of this field will be a best effort derivation of 'category'. Typically used to represent the **canonical category** of products. |

| secondaryCategory | | string | | "Men/Collections/Summer Essentials/Short Sleeve Shirts" | Secondary Product category. If possible, 'secondaryCategoriesList' should be filled instead of this field. | | secondaryCategoriesList | | array of string | | [...] | A hierarchically sorted list of the secondary sub-categories that this product belongs to. The first item on this list should be the most general sub-category, while the last should be the most specific. Any item on this list should correspond to a sub-category of the item immediately preceding it. If 'secondaryCategory' is present and this field is left undefined, the default value of this field will be a best effort derivation of 'secondaryCategory'. Typically used to represent the navigational category of products. | | currency | required | string | | "EUR" | The currency used in monetary values. Supported values: "PLN", "CAD", "HKD", "AUD", "SEK", "TRY", "BRL", "KRW", "CZK", "BGN", "ETH", "CLP", "GBP", "MXN", "THB", "ISK", "SGD", "CHF", "INR", "LTC", "CNY", "PHP", "RON", "BTC", "DKK", "XAU", "XAG", "JPY", "ARS", "HUF", "MYR", "USD", "RUB", "NZD", "IDR", "ILS", "NOK", "NAD", "EUR", "ZAR" and "HRK". | | promotions | | array of string | [] | [ "WINTERSALE" ] | Vouchers applied in the purchase or displayed together with the product. | | adult | | boolean | false | false | Whether the product includes adult content (alcohol, guns, gambling, sexually suggestive content...) and might not show up to some users. | | size | | string | | "S" | Product size. | | sizeSystem | | string | | "EU" | Country of the size system used by your product. | | customFields | | object of string | | {"color": "blue"} | Additional fields related to the product. The values within this object must all be strings. | | id | required | string | | "p125zc" | Product identifier. | | price | | number | 0 | 102.5 | The product's price. | | quantity | | number | 1 | 1 | Number of items purchased. | | discount | | Discount | | [...](https://docs.audience.kevel.com/collect/events/productCustomization#discount) | Discount applied to the product. | | gender | | string | | "male" | Gender for which the product is intended. | | sku | | string | | "p125zc-5" | Product SKU. |

Discount

Discount applied to the product. One of Percentage Discount, Price Discount or Value Discount.

Percentage Discount

A discount description where the percentage discounted is provided.

Price Discount

A discount description where the price after the discount is provided.

Value Discount

A discount description where the value of the discount is provided.