Tag Parameters

Last updated 21 days ago

List of parameters that you can add to the CoreMedia Tag to configure tracking in your website.

Parameter Type Default Description

bysideWebcare_webcare_id

String

Required - The Engagement Cloud ID that uniquely identifies a client in the CoreMedia Engagement Cloud. For example, 0123ABC45

bysideWebcare_lang

String

en

Required - Defines the language in which the tag renders content.
One of the following:

  • pt - Portuguese

  • br - Portuguese (Brazil)

  • cs - Czech

  • ct - Catalan

  • de - German

  • dk - Danish

  • en - English

  • es - Spanish

  • eu - Basque

  • fr - French

  • gl - Galician

  • hr - Croatian

  • hu - Hungarian

  • id - Indonesian

  • it - Italian

  • jp - Japanese

  • kr - Korean

  • nl - Dutch

  • pl - Polish

  • ro - Romanian

  • ru - Russian

  • se - Swedish

  • si - Slovenian

  • sr - Serbian

  • ua - Ukrainian

bysideWebcare_channel

String

default

Defines the requested channel. For example, chef-recipes-chat or chef-kitchen-accessories.
Setting parameter bysideWebcare_channel allows you to have more accurate analytics for each channel.

bysideWebcare_cookie_domain

String

null

Defines the cookie domain. For example, chef-kitchen.com.

bysideWebcare_cookie_lifetime

Integer (days)

730 (2 years)

Defines the cookie lifetime in number of days. For example, if you want to make the cookie valid for one year, set the value to 365.

If the visitor returns before the cookie expires, CoreMedia Engagement Cloud classifies the visitor as a returning visitor.
Otherwise, CoreMedia Engagement Cloud classifies the visitor as a new visitor.

bysideWebcare_cookie_expiration_reset

Boolean

true

If true, CoreMedia Engagement Cloud resets the count of the cookie expiration lifetime set in parameter bysideWebcare_cookie_lifetime every time a visitor loads the page.
If false, CoreMedia Engagement Cloud never resets the count of the cookie expiration lifetime set in parameter bysideWebcare_cookie_lifetime.

If the client server uses Intelligent Tracking Prevention and controls the cookie, set parameter bysideWebcare_cookie_expiration_reset to false.

bysideWebcare_default_timeout

Integer (seconds)

-1 (Disabled)

If set to a value greater than 0, defines the number of seconds that CoreMedia Engagement Cloud waits for a placeholder content to load. If the placeholder content doesn’t load in the specified period, CoreMedia Engagement Cloud loads the fallback content.

bysideWebcare_fid

String

Visitor unique identifier with, optional, additional information about the visitor that CoreMedia Engagement Cloud can use when performing visitor segmentation. CoreMedia Engagement Cloud uses parameter bysideWebcare_fid to uniquely track the visitor journey in the website. For example, chef.remy@chef-kitchen.com or chef.remy@chef-kitchen.com&location=braga.

You define the content of the bysideWebcare_fid. To improve security, CoreMedia recommends that you encrypt parameter bysideWebcare_fid.

bysideWebcare_privacy

Integer

1

Defines CoreMedia operation mode.
One of the following:

  • 0 - Mode OptIn.
    In mode OptIn, campaigns can have segmentation and analytics.

  • 1 - Mode OptOut.
    In mode OptOut, CoreMedia counts returning visitors to the website as new visitors and campaigns cannot have segmentation and analytics.

bysideWebcare_querystring

String (URL encoded format)

Defines additional information collected about the visitor. For example, if the website identifies the visitor with the following items:

  • customer="A 2ã"

  • customer_segment=3

Set up parameter bysideWebcare_querystring as follows:

bysideWebcare_querystring="A+2%c3%a3&customer_segment=3.

Use parameter bysideWebcare_querystring to enrich visitor information and tailor campaigns and visitor experience in real-time.

CoreMedia Engagement Cloud stores information extracted from parameter bysideWebcare_querystring to internal visitor fields.

bysideWebcare_use_websockets

Boolean

true

Defines if the website uses websockets or not.
One of the following:

  • true- The website is using websockets.

  • false - The website is not using websockets.

If the visitor browser doesn’t support websockets, CoreMedia Engagement Cloud uses fallback mechanisms like, for example, long-polling or polling XHR.

CoreMedia recommends the use of websockets. If parameter bysideWebcare_use_websockets is set to false, your website cannot have functionalities like co-browsing, file transfer, video call, video broadcast, and smart windows.

bysideWebcare_visitor_segments_ls_key

String

Defines the local storage where the website stores segments. CoreMedia Engagement Cloud uses segments in your local storage to synchronize visitors with segments and react to visitors according to the segments. For example, externalLSKey.

Copyright © 2024 CoreMedia GmbH, CoreMedia Corporation. All Rights Reserved.