Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Product View

Method Objective

StatuscolourYellowtitle

Product View

Method Objective

Status
colourYellow
titlerequired
 The method gives the system an understanding of the product viewed by the user.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
pcsdk.track("view", params);

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the current product.stockbooleanoptionallyAvailability of the current product for purchase.
recommended_bystringrequired in some cases

If used, the value must be one of:

  • "dynamic" - if the product is viewed from the recommendation block
  • "instant_search" - if the product is viewed from the Instant Search widget
  • "fillfull_search" - if the product is viewed from the search results page

See examples below.

recommended_codestringrequired in some cases

If used, the value must be one of:

  • unique code of recommendation block, if "recommended_by" value is "dynamic". The code is available in the PersonaClick account in the "data-recommender-code" attribute of each block.
  • search query string if "recommended_by" value is "instant_search" or "full_search"

See examples below.

Examples of use

Code Block
languagejs
themeFadeToGrey
pcsdk.track("view", {
	id: "100500",
	stock: true,
	recommended_by: "dynamic",
    recommended_code: "c6d2fe5fdca0c8e51d10b07523bc07"
});

Code Block
languagejs
themeFadeToGrey
pcsdk.track("view", {
	id: "146",
	stockrecommended_by: false,
	recommended_by: "instant_search",
    recommended_code: "mobile pho"
});

Code Block
languagejs
themeFadeToGrey
pcsdk.track("view", {
	id: "100500",
	stock: true,
	recommended_by: "full_search",
    recommended_code: "mobile phone 5G"
});



Category View

Method Objective

Status
colourYellow
titlerequired
 The method gives the system an understanding of the category viewed by the user.

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
languagejs
themeFadeToGrey
pcsdk.track("category", id);

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe ID of the current category.

Example of use

Code Block
languagejs
themeFadeToGrey
pcsdk.track("category", "146");



Adding a product to the cart

Method Objective

Status
colourYellow
titlerequired
 The method gives the system an understanding of the product added to the cart by the user.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
pcsdk.track("cart", params);

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

stock

If used, the value must be one of:

  • "dynamic" - if the product is added to the cart from the recommendation block
  • "instant_search" - if the
    NameTypeRequirementDescription
    idnumber/stringrequiredThe ID of the product added to the cart.
    amountnumberoptionallyQuantity

    The total value of the amount of product added to the cart. Default: 1.

    Tip
    booleanoptionallyAvailability of the current product for purchase.recommended_bystringrequired in some cases

    For example:

    1. A user has added the current product to the cart in the amount of 3 pieces. The request should have the "amount" value of 3.
    2. Then the user decides to add 2 more pieces of the current product (bringing the total to 5). The second request should have the "amount" value of 5.


    recommended_bystringrequired in some cases

    If used, the value must be one of:

    • "dynamic" - if the product is added to the cart from the recommendation block
    • "instant_search" - if the product is added to the cart from the Instant Search widget
    • "fill_search" - if the product is added to the cart from the search results page

    See examples below.

    recommended_codestringrequired in some cases

    If used, the value must be one of:

    • unique code of recommendation block, if "recommended_by" value is "dynamic". The code is available in the PersonaClick account in the "data-recommender-code" attribute of each block.
    • search query string if "recommended_by" value is "instant_search" or "full_search"

    See examples below.

    Examples of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("cart", {
        id: "100500",
        amount: 3,
     
      stock: true,     recommended_by: "dynamic",
        recommended_code: "c6d2fe5fdca0c8e51d10b07523bc07"
    });

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("cart", {
        id: "100500",
        amount: 3,
        stock: true,
    	recommended	recommended_by: "instant_search",
        recommended_code: "mobile pho"
    });

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("cart", {
        id: "100500",
        amount: 3,
       
    stock: true,
    	recommended_by: "full_search",
        recommended_code: "mobile phone 5G"
    });



    Removing a product from the cart

    Method Objective

    Status
    colourYellow
    titlerequired
     The method gives the system an understanding of the product removed from the cart by the user.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("remove_from_cart", id);

    Request parameters

    NameTypeRequirementDescription
    idnumber/stringrequiredThe ID of the product removed from the cart.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("remove_from_cart", "100500");



    Update the current cart

    Method Objective

    The

    Status
    colourYellow
    titlerequired
     The method updates the whole cart on the system side.

    Tipnote

    Use this method This method is required for use on the cart page when the user , for example, does certain actions there: when the user visits the page, changes the quantity of a product in the cart or completely purges , removes a product from the cart, or clears the cart . Also, this completely.


    Tip

    This method can be used on the product page as an alternative to the "Add to cart" and "Remove from cart" methods if you have access to the entire cart when these events occur for a specific producton the product page.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("cart", params);

    NameTypeRequirementDescription
    paramsObject arrayrequiredObject array with request parameters.

    Request parameters

    Each object in the array can contain the following properties.

    NameTypeRequirementDescription
    idnumber/stringrequiredThe ID of the product in the cart.
    amountnumberoptionallyQuantity of the product.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("cart", [
        {
            id: "100500",
            amount: 3
        },
        {
            id: "146",
            amount: 1
        }
    ]);



    Successful checkout

    Method Objective

    Status
    colourYellow
    titlerequired
     The method gives the system information about the successful checkout, its products, and other information related to the checkout.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("purchase", params);

    NameTypeRequirementDescription
    paramsObjectrequiredObject with request parameters.

    Request parameters

    number/string
    NameTypeRequirementDescription
    productsarrayrequiredAn array of purchased products. See the table below for details.order
    customobjectoptionallyInternal 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_pricenumberoptionallyThe final order value, including all discounts. If Custom properties of the order. The properties should be pre-created: Account > Settings > Order properties

    The following data types are supported:
    - string
    - integer
    - date (YYYY-MM-DD)

    See example below.
    ordernumber/stringoptionally

    Internal store Order ID. If not specified, the system will

    calculate the order value based on prices from the product feed.
    order_cashnumberoptionallyThe amount of money the user spent to pay for the order.
    order_bonusesnumberoptionallyThe number of bonuses the user spent to pay for the order.
    order_deliverynumberoptionallyShipping cost.
    order_discountnumberoptionallyDiscount amount.
    promocodestringoptionallyPromo code that was used.
    delivery_typestringoptionallyShipping method. Available values:
    • self_pickup
    • delivery
    • pickup_point
    payment_typestringoptionallyPayment method. Any string value. For example: "cash", "card", "wire".

    Product properties:

    NameTypeRequirementDiscriptionidnumber/stringrequiredProduct ID.amountnumberrequiredProduct Quantity.pricenumberoptionally

    The unit price of the product. If not specified, the system will use the price from the product feed. 

    stockbooleanoptionallyProduct availability.customobjectoptionallyThis parameter can only contain the "fashion_size" property with a string or numeric value of the clothing size. See example below. Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("purchase", {

    create its internal ID. Synchronization of order statuses, in this case, won't be available.

    Note

    Please note that order IDs in UUID format aren't displayed in the dashboard. Instead of UUDI, "---" will be displayed. To avoid this, add any prefix to this.


    order_pricenumberoptionallyThe final order value, including all discounts. If not specified, the system will calculate the order value based on prices from the product feed.
    order_cashnumberoptionallyThe amount of money the user spent to pay for the order.
    order_bonusesnumberoptionallyThe number of bonuses the user spent to pay for the order.
    order_deliverynumberoptionallyShipping cost.
    order_discountnumberoptionallyDiscount amount (in money).
    promocodestringoptionally

    Promo code that was used.

    Tip

    If a promo code from the list uploaded to the account has been used, it'll be marked as used.


    delivery_typestringoptionallyDelivery Type, e.g. "courier", "self_pickup", "delivery", "pickup_point", etc.
    delivery_addressstringoptionallyDelivery address. Any text.
    payment_typestringoptionallyPayment method. Any string value. For example: "cash", "card", "wire".
    tax_freebooleanoptionallyIt sets whether the order was placed with Tax-Free or not.


    Product properties:

    NameTypeRequirementDiscription
    idnumber/stringrequiredProduct ID.
    amountnumberrequiredProduct Quantity.
    pricenumberoptionally

    The unit price of the product. If not specified, the system will use the price from the product feed. 


    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("purchase", {
        products: [
            {id: "37", price: 100, amount: 3, stock: true},
            {id: "187", price: 500, amount: 1, stock: false, custom: { fashion_size: "XL" }}}
        ],
        "custom": {
        ],     "order_comment": "N100500"Delivery after 15:00, 2nd floor, apt. 222",
      order_price: 750,     order_cash"boxes": 6502,
     
      order_bonuses: 100,     order"refund_deliverydate": 0,"2021-09-21"
        order_discount: 50,
        promocode: "BIRTHDAY",
        delivery_type: "delivery",
        payment_type: "cart"
    });
    Search Request
    },
        order: "N100500",
        order_price: 750,
        order_cash: 650,
        order_bonuses: 100,
        order_delivery: 0,
        order_discount: 50,
        promocode: "BIRTHDAY",
        delivery_type: "delivery",
        payment_type: "cart"
    });



    Search Request

    Method Objective

    The method gives the system an understanding of the user's search queries.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("search", search_query);

    Request parameters

    NameTypeRequirementDescription
    search_querystringrequiredSearch query phrase.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("search", "to be or not to be");



    Adding a product to the wishlist

    Method Objective

    The method gives the system an understanding of the user 's search querieshas added a product to the wishlist.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("searchwish", search_queryid);

    Request parameters

    NameTypeRequirementDescription
    search_queryidnumber/stringrequiredSearch query phraseThe ID of the product added to the wishlist.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("searchwish", "to be or not to be100500");
    Adding



    Removing a product

    to

    from the wishlist

    Method Objective

    The method gives the system an understanding the user has added removed a product to from the wishlist.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("remove_wish", id);

    Request parameters

    NameTypeRequirementDescription
    idnumber/stringrequiredThe ID of the product added to the wishlist.
    Example of use
    removed from the wishlist.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("remove_wish", "100500");



    Update the current wishlist

    Method Objective

    The method updates the whole wishlist on the system side.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.track("wish", "100500"ids);

    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


    NameTypeRequirementDescription
    idsArrayrequired

    Array with wish list product IDs. 

    Tip

    Use an empty array to clear the wishlist.


    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    // synchronizing a wishlist
    pcsdk.track("remove_wish", id);

    Request parameters

    NameTypeRequirementDescriptionidnumber/stringrequiredThe ID of the product removed from the wishlist.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    ["100500", "146"]);
    
    // clearing a wishlist
    pcsdk.track("remove_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
    languagejs
    themeFadeToGrey
    pcsdk.trackEvent(custom_event_key, params);

    NameTypeRequirementDescription
    custom_event_keystringrequiredUnique custom event key. Must be pre-created in the PersonaClick account: Settings > Custom events.
    paramsObjectrequiredObject with request parameters.

    Request parameters

    NameTypeRequirementDescription
    categorystringoptionallyA category is a name that you supply as a way to group some event's properties.
    labelstringoptionallyWith labels, you can provide additional information for events that you need.
    valuenumberoptionallyThe value property can be any integer and can be used to send a specific value in an event.

    Examples of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.trackEvent("my_event");


    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.trackEvent("my_event", {
    	category: "my_category",
    	label: "my_label",
    	value: 100500
    });


    Push Notification Received

    Method Objective

    The method gives the system an understanding that the user has received a push notification.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.notificationReceived(params);


    NameTypeRequirementDescription
    paramsObjectrequiredObject with request parameters.

    Request parameters

    NameTypeRequirementDescription
    typestringrequired

    Message Type. Values are available in the payload of a message:

    • for iOS in the "src.type" property
    • for Android in the "type" property

    See examples of payloads in the Payload Structure section.

    codestringrequired

    Message ID. Values are available in the payload of a message:

    • for iOS in the "src.id" property
    • for Android in the "id" property

    See examples of payloads in the Payload Structure section.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.notificationReceived({type: "bulk", code: "01dadf45c301599865b402602f9dcf8f"});


    Push Notification Clicked

    Method Objective

    The method gives the system an understanding that the user has clicked a push notification.

    Syntax and parameters

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.notificationClicked(params);


    NameTypeRequirementDescription
    paramsObjectrequiredObject with request parameters.

    Request parameters

    NameTypeRequirementDescription
    typestringrequired

    Message Type. Values are available in the payload of a message:

    • for iOS in the "src.type" property
    • for Android in the "type" property

    See examples of payloads in the Payload Structure section.

    codestringrequired

    Message ID. Values are available in the payload of a message:

    • for iOS in the "src.id" property
    • for Android in the "id" property

    See examples of payloads in the Payload Structure section.

    Example of use

    Code Block
    languagejs
    themeFadeToGrey
    pcsdk.notificationClicked({type: "chain", code: "5b40261dadf45c309902f9dcf8f10865"});



    Column

    Page Navigation

    Table of Contents
    maxLevel2

    minLevel

    indent

    2

    0px
    stylenone




    Related Pages

    dics

    Filter by label (Content by label)

    classpersonaclick-fixed-positionprintablefalse

    showLabelsfalse
    showSpacefalse
    sorttitle
    cqllabel = "tracking"