Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Product View
Method Objective
| Status | ||||
|---|---|---|---|---|
|
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
Params view = new Params();
view
.put(new Params.Item(product_id))
.put(new Params.RecommendedBy(Params.RecommendedBy.TYPE.RECOMMENDATION, recommeder_code));
PersonaClick.track(Params.TrackEvent.VIEW, view); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| product_id | string | required | The ID of the current product |
| recommender_code | string | required is some cases | This property should have a unique code for the product recommendations block if the current product was opened from the recommendation block. The unique code is available in the PersonaClick account in the "data-recommender-code" attribute of each block. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
Params view = new Params();
view
.put(new Params.Item("100500"))
.put(new Params.RecommendedBy(Params.RecommendedBy.TYPE.RECOMMENDATION, "b934b6ba2eb6202b8922d6a3fb8b3271"));
PersonaClick.track(Params.TrackEvent.VIEW, view); |
Category View
Method Objective
| Status | ||||
|---|---|---|---|---|
|
| Warning |
|---|
The API will respond with an error for categories unknown to the system. The system only knows the categories from the product feed (XML) or the HTTP import of the category list. |
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.CATEGORY, (new Params()).put(Params.Parameter.CATEGORY_ID, category_id)); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| category_id | string | required | The ID of the current category. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.CATEGORY, (new Params()).put(Params.Parameter.CATEGORY_ID, "146")); |
Adding a product to the cart
Method Objective
| Status | ||||
|---|---|---|---|---|
|
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
Params cart = new Params(); cart .put(new Params.Item(product_id) .set(Params.Item.COLUMN.FASHION_SIZE, fashion_size) .set(Params.Item.COLUMN.AMOUNT, amount) ) .put(new Params.RecommendedBy(Params.RecommendedBy.TYPE.RECOMMENDATION, recommender_code)); PersonaClick.track(Params.TrackEvent.CART, cart); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| product_id | string | required | The ID of the product added to the cart |
| amount | string | optionally | Quantity of product. Default: 1. |
| fashion_size | string | optionally | The parameter allows specifying the size of the product related to the Apparel & Accessories niche. |
| recommender_code | string | required in some cases | This property should have a unique code for the product recommendations block if the current product was added to the cart from the recommendation block. The unique code is available in the PersonaClick account in the "data-recommender-code" attribute of each block. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
Params cart = new Params();
cart
.put(new Params.Item("100500")
.set(Params.Item.COLUMN.FASHION_SIZE, "M")
.set(Params.Item.COLUMN.AMOUNT, 2)
)
.put(new Params.RecommendedBy(Params.RecommendedBy.TYPE.RECOMMENDATION, "b934b6ba2eb6202b8922d6a3fb8b3271"));
PersonaClick.track(Params.TrackEvent.CART, cart); |
Removing a product from the cart
Method Objective
| Status | ||||
|---|---|---|---|---|
|
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.REMOVE_FROM_CART, product_id); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| product_id | string | required | The ID of the product removed from the cart |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.REMOVE_FROM_CART, "100500"); |
Successful checkout
Method Objective
| Status | ||||
|---|---|---|---|---|
|
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
Params purchase = new Params(); purchase .put(new Params.Item(product_id).set(Params.Item.COLUMN.AMOUNT, amount)) .put(Params.Parameter.ORDER_ID, order_id) .put(Params.Parameter.ORDER_PRICE, order_price); PersonaClick.track(Params.TrackEvent.PURCHASE, purchase); |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| product_id | string | required | Product ID. |
| amount | number | required | Product Quantity. |
| order_id | string | optionally | Internal store Order ID. If not specified, the system will create its internal ID. Synchronization of order statuses, in this case, won't be available. |
| order_price | number | optionally | The final order value, including all discounts. If not specified, the system will calculate the order value based on prices from the product feed. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
Params purchase = new Params();
purchase
.put(new Params.Item("37").set(Params.Item.COLUMN.AMOUNT, 3))
.put(new Params.Item("187").set(Params.Item.COLUMN.AMOUNT, 1))
.put(Params.Parameter.ORDER_ID, "N100500")
.put(Params.Parameter.ORDER_PRICE, 750);
PersonaClick.track(Params.TrackEvent.PURCHASE, purchase); |
Search Request
Method Objective
The method gives the system an understanding of the user's search queries.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.SEARCH, new Params().put(Params.Parameter.SEARCH_QUERY, search_query)); |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| search_query | string | required | Search query phrase. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.SEARCH, new Params().put(Params.Parameter.SEARCH_QUERY, "to be or not to be")); |
Adding a product to the wishlist
Method Objective
The method gives the system an understanding the user has added a product to the wishlist.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.WISH, product_id); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| product_id | string | required | The ID of the product added to the wishlist |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.WISH, "100500"); |
Removing a product from the wishlist
Method Objective
The method gives the system an understanding the user has removed a product from the wishlist.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.REMOVE_FROM_WISH, product_id); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| product_id | string | required | The ID of the product removed from the wishlist |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(Params.TrackEvent.REMOVE_FROM_WISH, "100500"); |
Custom event
Method Objective
The method gives the system an understanding that some user event has happened.
| Note |
|---|
Before you can use custom events, you must create them in the PersonaClick account: Settings > Custom events. |
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track(custom_event_key, category, label, value); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| custom_event_key | string | required | Unique custom event key. Must be pre-created in the PersonaClick account: Settings > Custom events. |
| category | string | optionally | A category is a name that you supply as a way to group some event's properties. |
| label | string | optionally | With labels, you can provide additional information for events that you need. |
| value | number | optionally | The value property can be any integer and can be used to send a specific value in an event. |
Examples of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track("my_event"); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.track("my_event", "my_category", "my_label", 100500); |
| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|