- 4 Minutes to read
- Print
- DarkLight
advanced
- 4 Minutes to read
- Print
- DarkLight
Overview
Value | Notes | Data type | Default value | Required |
---|---|---|---|---|
secureCookie | When set to |
|
| - |
optOutName | Defines an alternative name for the Mapp Intelligence opt-out cookie. |
|
| - |
requestObfuscation | When set to |
|
| - |
forceOldEverId | When set to |
|
| - |
execCDB | Activates/deactivates the Cross Device Bridge. |
|
| - |
useCDBCache | Activates/deactivates the image cache for the Cross Device Bridge. |
|
| - |
sendViaSDK | Activates/deactivates the Web-to-App tracking functionality, e.g., when tracking web views in mobile applications. |
|
| - |
sendViaServer.activated | Activates/deactivates the pixel configuration to support server-to-server tracking. This can be used in connection with Mapp's server-to-server libraries. |
|
| - |
sendViaServer.serverDomain | Indicates the domain where the server-to-server library is hosted. If left empty, the pixel sends the requests to the Mapp Intelligence track server directly and not to the server-to-server library. |
| - | - |
sendViaServer.serverPath | Indicates the path where the server-to-server library is saved on your server. If left empty, the requests are sent directly to the Mapp Intelligence track server and not to the server-to-server library. |
| - | - |
sendViaServer.droppedRequests | Discard pixel requests:
Indicate the type of requests that have to be discarded by the pixel. It is possible to narrow the requests further if you indicate specific content IDs under "Discard specific requests". |
| - | - |
sendViaServer.blacklist | Indicates specific page requests that need to be discarded by the pixel. Please note:
|
| - | - |
useHashForDefaultPageName | Includes the URL hash in the default page name. |
|
| - |
useParamsForDefaultPageName | Includes specific URL parameter(s) in the default page name. |
|
| - |
requestQueue.activated | When set to true, the offline tracking queue functionality is activated. |
|
| - |
requestQueue.ttl | Specifies the maximum time a request can remain in the queue until it is deleted. |
|
| - |
requestQueue.resendInterval | Defines the millisecond interval between resending requests if an error occurred during send out or a request could not have been sent. |
|
| - |
requestQueue.size | Defines the maximum number of requests saved in the queue. |
|
| - |
requestQueue.retries | Specifies the maximum number of retries before the request is deleted or no more requests are sent for the entire session. -1 specifies an unlimited number of retries. |
|
| - |
requestQueue.retriesOption | Specifies the option of retries:
|
|
| - |
requestLimit.activated | Activates/deactivates the request limitation. The maximum number of permissible requests is limited to reduce the risk of sending many requests in error. This could be caused by an incorrect pixel implementation or by bot traffic. As soon as the standard limit of 1000 requests (pages and actions) every 30 minutes is exceeded, no further requests are sent by the pixel for the remaining time. |
|
| - |
requestLimit.amount | The maximum number of requests permitted to be sent in the specified time period. |
|
| - |
requestLimit.duration | Time interval in seconds for sending the maximum X number of requests. |
|
| - |
userIdentification.enableAnonymousFunction | Enable if you want to allow users to opt out of user-identifiable cookies and parameters when tracking. By default, this function will still track with user-identifiable cookies, but users can opt-out using the respective function. |
|
| - |
userIdentification.anonymousCookieName | An alternative name for the anonymous tracking cookie. If you do not provide a name, miCookieOptOut will be used. |
|
| - |
userIdentification.anonymousOptIn | Enable if you want to use anonymous tracking by default. Enabling this option will not set any user-identifiable cookie until the user actively agrees to its usage. |
|
| - |
userIdentification.suppressParameter | It can exclude additional parameters if the user sets the user-identifiable opt-out cookie. Please indicate the respective parameters in the array. |
|
| - |
userIdentification.temporarySessionId | In order to keep the session and the user during a single session, we offer the possibility to set a temporary session ID that keeps the session together but is not permanently stored on a device. |
|
| - |
userIdentification.saveTemporarySessionId | If you enable this option, the temporary session ID will be stored in the session storage, so you don't have to set it on every page |
|
| - |
Implementation Example
import { WebtrekkSmartPixelReact, WebtrekkAdvancedData } from "@webtrekk-smart-pixel/react";
import { WebtrekkSmartPixelReact, WebtrekkAdvancedData } from "@webtrekk-smart-pixel/next";
WebtrekkSmartPixelReact.advanced({
secureCookie: false,
optOutName: "webtrekkOptOut",
requestObfuscation: false,
forceOldEverId: false,
execCDB: true,
useCDBCache: false,
sendViaSDK: false,
sendViaServer: {
activated: false,
serverDomain: '',
serverPath: '',
droppedRequests: 0,
blacklist: [/.+/]
},
useHashForDefaultPageName: true,
useParamsForDefaultPageName: ['param1', 'param2'],
requestQueue: {
activated: false,
ttl: 5 * 60 * 1000,
resendInterval: 5 * 1000,
size: 100,
retries: -1,
retriesOption: 1
},
requestLimit: {
activated: false,
amount: 1000,
duration: 30 * 60
},
userIdentification: {
enableAnonymousFunction: false,
anonymousOptIn: 'miCookieOptOut',
anonymousCookieName: false,
suppressParameter: []
}
});
render()
{
return (
<div>
<WebtrekkAdvancedData
secureCookie={ false }
optOutName="webtrekkOptOut"
requestObfuscation={ false }
forceOldEverId={ false }
execCDB={ true }
useCDBCache={ false }
sendViaSDK: { false },
sendViaServer: { {
activated: false,
serverDomain: '',
serverPath: '',
droppedRequests: 0,
blacklist: [/.+/]
} },
useHashForDefaultPageName: { true },
useParamsForDefaultPageName: { ['param1', 'param2'] },
requestQueue={ {
activated: false,
ttl: 5 * 60 * 1000,
resendInterval: 5 * 1000,
size: 100,
retries: -1,
retriesOption: 1
} },
requestLimit: { {
activated: false,
amount: 1000,
duration: 30 * 60
} },
userIdentification: { {
enableAnonymousFunction: false,
anonymousOptIn: 'miCookieOptOut',
anonymousCookieName: false,
suppressParameter: []
} }
/>
</div>
);
}