Piwik PRO Library for React

Dedicated Piwik PRO library that helps with implementing Piwik PRO Tag Manager and the Piwik PRO tracking client in React applications.

$3

#### NPM

To use this package in your project, run the following command.

``
npm install @piwikpro/react-piwik-pro
`

#### Basic setup

In your React Project, include the default PiwikPro in the highest level application module. ie index. To set up the Piwik PRO Tag Manager container in the app, the easiest way is to call the PiwikPro.initialize() method. PiwikPro.initialize() must be initialized using this function before any of the other tracking functions will record any data.

In the arguments, pass your app ID and your account URL as parameters (marked 'container-id' and 'container-url' in the example below).

`ts
import PiwikPro from '@piwikpro/react-piwik-pro';

PiwikPro.initialize('container-id', 'container-url');

ReactDOM.render(, document.getElementById('root'))
`

#### Setup with nonce

The nonce attribute is useful to allow-list specific elements, such as a particular inline script or style elements. It can help you to avoid using the CSP unsafe-inline directive, which would allow-list all inline scripts or styles.

If you want your nonce to be passed to the script, pass it as the third argument when calling the script initialization method.

`ts
import PiwikPro from '@piwikpro/react-piwik-pro';

PiwikPro.initialize('container-id', 'container-url', { nonce: 'nonce-string' });

ReactDOM.render(, document.getElementById('root'))
`

#### Custom Data Layer name

`ts
import PiwikPro from '@piwikpro/react-piwik-pro';

PiwikPro.initialize('container-id', 'container-url', { dataLayerName: 'my-data-layer' });

ReactDOM.render(, document.getElementById('root'))
`

$3

#### Send Custom Events

`ts
import { CustomEvent } from '@piwikpro/react-piwik-pro'

export class TestFormComponent {

onUserInputName() {
...
CustomEvent.trackEvent('user_register_form', 'enter_name', 'Name', 'Value');
}

onUserInputEmail() {
...
CustomEvent.trackEvent('user_register_form', 'enter_email', 'Email', 'Value');
}

onSubmit() {
...
CustomEvent.trackEvent('user_register_form', 'submit', 'Sent');
}
}

`

#### Send page views and virtual page views

`ts
import { PageViews } from '@piwikpro/react-piwik-pro';
...

const App = () => {

PageViews.trackPageView('optional title');

return ...;
}

export default App
`

#### Send an event with Data Layer

`ts
import { DataLayer } from '@piwikpro/react-piwik-pro';
...

const App = () => {

DataLayer.push({ event: 'test-event' });

return ...;
}

export default App
`

$3

#### Namespaces

- ClientConfiguration
- ContentTracking
- CookieManagement
- CrossDomainTracking
- CustomDimensions
- CustomEvent
- DataLayer
- DownloadAndOutlink
- ErrorTracking
- GoalConversions
- Heartbeat
- Miscellaneous
- PageViews
- SiteSearch
- UserManagement
- eCommerce

#### Type Aliases

- Dimensions
- EcommerceOptions
- InitOptions
- Initialize
- PaymentInformation
- Product
- VisitorInfo

#### Variables

- default

$3

#### Dimensions

Ƭ Dimensions: Record\<\dimension$\{number}\, string\>

___

#### EcommerceOptions

Ƭ EcommerceOptions: Object

##### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| currencyCode? | string | Currency code in ISO 4217 format. If not provided, the currency set in app settings will be used instead. |

___

#### InitOptions

Ƭ InitOptions: Object

##### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| dataLayerName? | string | Defaults to 'dataLayer' |
| nonce? | string | - |

___

#### Initialize

Ƭ Initialize: (containerId: string, containerUrl: string, nonceOrOptions?: string \| InitOptions) => void

##### Type declaration

▸ (containerId, containerUrl, nonceOrOptions?): void

###### Parameters

| Name | Type |
| :------ | :------ |
| containerId | string |
| containerUrl | string |
| nonceOrOptions? | string \| InitOptions |

###### Returns

void

___

#### PaymentInformation

Ƭ PaymentInformation: Object

##### Type declaration

| Name | Type |
| :------ | :------ |
| discount? | number \| string |
| grandTotal | number \| string |
| orderId | string |
| shipping? | number \| string |
| subTotal? | number \| string |
| tax? | number \| string |

___

#### Product

Ƭ Product: Object

##### Type declaration

| Name | Type |
| :------ | :------ |
| brand? | string |
| category? | LimitedArrayFiveStrings |
| customDimensions? | Record\<number, string\> |
| name? | string |
| price? | number |
| quantity? | number |
| sku | string |
| variant? | string |

___

#### VisitorInfo

Ƭ VisitorInfo: [isNew: "0" \| "1", visitorId: string, firstVisitTS: number, previousVisitCount: string \| number, currentVisitTS: number, lastVisitTS: number \| "", lastEcommerceOrderTS: number \| ""]

$3

#### default

• default: Object

##### Type declaration

| Name | Type |
| :------ | :------ |
| getInitScript | (__namedParameters: \{ containerId: string ; containerUrl: string ; dataLayerName?: string ; nonceValue?: string }) => string |
| initialize | Initialize |

ClientConfiguration

$3


- getDomains
- setDomains


#### getDomains

▸ getDomains(): Promise\<string[]\>

Returns list of internal domains (set with "setDomains" function and used in outlink tracking).

##### Returns

Promise\<string[]\>

___

#### setDomains

▸ setDomains(domains): void

Allows to define a list of internal domains or mobile app URIs. Used in outlink tracking for determining whether a link is an outlink and in cross domain linking for determining which links should have visitor ID parameter injected.

##### Parameters

| Name | Type |
| :------ | :------ |
| domains | string[] |

##### Returns

void

ContentTracking

$3


- logAllContentBlocksOnPage
- trackAllContentImpressions
- trackContentImpression
- trackContentImpressionsWithinNode
- trackContentInteraction
- trackContentInteractionNode
- trackVisibleContentImpressions


#### logAllContentBlocksOnPage

▸ logAllContentBlocksOnPage(): void

Print all content blocks to the console for debugging purposes

##### Returns

void

___

#### trackAllContentImpressions

▸ trackAllContentImpressions(): void

Scans the entire DOM for content blocks and tracks impressions after all page
elements load. It does not send duplicates on repeated calls unless
trackPageView was called in between trackAllContentImpressions invocations

##### Returns

void

___

#### trackContentImpression

▸ trackContentImpression(contentName, contentPiece, contentTarget): void

##### Parameters

| Name | Type |
| :------ | :------ |
| contentName | string |
| contentPiece | string |
| contentTarget | string |

##### Returns

void

___

#### trackContentImpressionsWithinNode

▸ trackContentImpressionsWithinNode(domNode): void

##### Parameters

| Name | Type |
| :------ | :------ |
| domNode | Node |

##### Returns

void

___

#### trackContentInteraction

▸ trackContentInteraction(contentInteraction, contentName, contentPiece, contentTarget): void

Tracks manual content interaction event

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| contentInteraction | string | Type of interaction (e.g. "click") |
| contentName | string | Name of a content block |
| contentPiece | string | Name of the content that was displayed (e.g. link to an image) |
| contentTarget | string | Where the content leads to (e.g. URL of some external website) |

##### Returns

void

___

#### trackContentInteractionNode

▸ trackContentInteractionNode(domNode, contentInteraction?): void

Tracks interaction with a block in domNode. Can be called from code placed in onclick attribute

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| domNode | Node | Node marked as content block or containing content blocks. If content block can’t be found, nothing will tracked. |
| contentInteraction? | string | Name of interaction (e.g. "click") |

##### Returns

void

___

#### trackVisibleContentImpressions

▸ trackVisibleContentImpressions(checkOnScroll?, watchInterval?): void

Scans DOM for all visible content blocks and tracks impressions

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| checkOnScroll? | boolean | Whether to scan for visible content on scroll event |
| watchInterval? | number | Delay, in milliseconds, between scans for new visible content. Periodic checks can be disabled by passing 0 |

##### Returns

void

CookieManagement

$3


- deleteCookies
- disableCookies
- enableCookies
- getConfigVisitorCookieTimeout
- getCookieDomain
- getCookiePath
- getSessionCookieTimeout
- hasCookies
- setCookieDomain
- setCookieNamePrefix
- setCookiePath
- setReferralCookieTimeout
- setSecureCookie
- setSessionCookieTimeout
- setVisitorCookieTimeout
- setVisitorIdCookie


#### deleteCookies

▸ deleteCookies(): void

Deletes existing tracking cookies on the next page view

##### Returns

void

___

#### disableCookies

▸ disableCookies(): void

Disables all first party cookies. Existing cookies will be deleted in the next page view

##### Returns

void

___

#### enableCookies

▸ enableCookies(): void

Enables all first party cookies. Cookies will be created on the next tracking request

##### Returns

void

___

#### getConfigVisitorCookieTimeout

▸ getConfigVisitorCookieTimeout(): Promise\<number\>

Returns expiration time of visitor cookies (in milliseconds)

##### Returns

Promise\<number\>

___

#### getCookieDomain

▸ getCookieDomain(): Promise\<string\>

Returns domain of the analytics tracking cookies (set with setCookieDomain()).

##### Returns

Promise\<string\>

___

#### getCookiePath

▸ getCookiePath(): Promise\<string\>

Returns the analytics tracking cookies path

##### Returns

Promise\<string\>

___

#### getSessionCookieTimeout

▸ getSessionCookieTimeout(): Promise\<number\>

Returns expiration time of session cookies

##### Returns

Promise\<number\>

___

#### hasCookies

▸ hasCookies(): Promise\<boolean\>

Returns true if cookies are enabled in this browser

##### Returns

Promise\<boolean\>

___

#### setCookieDomain

▸ setCookieDomain(domain): void

Sets the domain for the analytics tracking cookies

##### Parameters

| Name | Type |
| :------ | :------ |
| domain | string |

##### Returns

void

___

#### setCookieNamePrefix

▸ setCookieNamePrefix(prefix): void

Sets the prefix for analytics tracking cookies. Default is "_pk_".

##### Parameters

| Name | Type |
| :------ | :------ |
| prefix | string |

##### Returns

void

___

#### setCookiePath

▸ setCookiePath(path): void

Sets the analytics tracking cookies path

##### Parameters

| Name | Type |
| :------ | :------ |
| path | string |

##### Returns

void

___

#### setReferralCookieTimeout

▸ setReferralCookieTimeout(seconds): void

Sets the expiration time of referral cookies

##### Parameters

| Name | Type |
| :------ | :------ |
| seconds | number |

##### Returns

void

___

#### setSecureCookie

▸ setSecureCookie(secure): void

Toggles the secure cookie flag on all first party cookies (if you are using HTTPS)

##### Parameters

| Name | Type |
| :------ | :------ |
| secure | boolean |

##### Returns

void

___

#### setSessionCookieTimeout

▸ setSessionCookieTimeout(seconds): void

Sets the expiration time of session cookies

##### Parameters

| Name | Type |
| :------ | :------ |
| seconds | number |

##### Returns

void

___

#### setVisitorCookieTimeout

▸ setVisitorCookieTimeout(seconds): void

Sets the expiration time of visitor cookies

##### Parameters

| Name | Type |
| :------ | :------ |
| seconds | number |

##### Returns

void

___

#### setVisitorIdCookie

▸ setVisitorIdCookie(): void

Sets cookie containing analytics ID in browser

##### Returns

void

CrossDomainTracking

$3

#### Type Aliases

- LinkDecorator
- VisitorIdGetter


- customCrossDomainLinkDecorator
- customCrossDomainLinkVisitorIdGetter
- disableCrossDomainLinking
- enableCrossDomainLinking
- getCrossDomainLinkingUrlParameter
- isCrossDomainLinkingEnabled
- setCrossDomainLinkingTimeout

$3

#### LinkDecorator

Ƭ LinkDecorator: (url: string, value: string, name: string) => string \| null

##### Type declaration

▸ (url, value, name): string \| null

###### Parameters

| Name | Type |
| :------ | :------ |
| url | string |
| value | string |
| name | string |

###### Returns

string \| null

___

#### VisitorIdGetter

Ƭ VisitorIdGetter: (url: string, name: string) => string

##### Type declaration

▸ (url, name): string

###### Parameters

| Name | Type |
| :------ | :------ |
| url | string |
| name | string |

###### Returns

string


#### customCrossDomainLinkDecorator

▸ customCrossDomainLinkDecorator(decorator): void

Sets custom cross domains URL decorator for injecting visitor ID into URLs. Used when cross domain linking is enabled.

##### Parameters

| Name | Type |
| :------ | :------ |
| decorator | LinkDecorator |

##### Returns

void

___

#### customCrossDomainLinkVisitorIdGetter

▸ customCrossDomainLinkVisitorIdGetter(getter): void

Sets custom cross domain URL parser for extracting visitor ID from URLs. Should extract data injected by URL decorator. The getter should return visitor ID extracted from page URL.

##### Parameters

| Name | Type |
| :------ | :------ |
| getter | VisitorIdGetter |

##### Returns

void

___

#### disableCrossDomainLinking

▸ disableCrossDomainLinking(): void

Disables cross domain linking.

##### Returns

void

___

#### enableCrossDomainLinking

▸ enableCrossDomainLinking(): void

Enables cross domain linking. Visitors across domains configured with "setDomains" function will be linked by passing visitor ID parameter in links.

##### Returns

void

___

#### getCrossDomainLinkingUrlParameter

▸ getCrossDomainLinkingUrlParameter(): Promise\<string\>

Returns the name of a cross domain URL parameter (query parameter by default) holding visitor ID. This is "pk_vid" by default.

##### Returns

Promise\<string\>

___

#### isCrossDomainLinkingEnabled

▸ isCrossDomainLinkingEnabled(): Promise\<boolean\>

Returns boolean telling whether cross domain linking is enabled.

##### Returns

Promise\<boolean\>

___

#### setCrossDomainLinkingTimeout

▸ setCrossDomainLinkingTimeout(timeout): void

Changes the time in which two visits across domains will be linked. The default timeout is 180 seconds (3 minutes).

##### Parameters

| Name | Type |
| :------ | :------ |
| timeout | number |

##### Returns

void

CustomDimensions

$3


- deleteCustomDimension
- getCustomDimensionValue
- setCustomDimensionValue


#### deleteCustomDimension

▸ deleteCustomDimension(customDimensionId): void

Removes a custom dimension with the specified ID.

##### Parameters

| Name | Type |
| :------ | :------ |
| customDimensionId | string \| number |

##### Returns

void

___

#### getCustomDimensionValue

▸ getCustomDimensionValue(customDimensionId): Promise\<string \| undefined\>

Returns the value of a custom dimension with the specified ID.

##### Parameters

| Name | Type |
| :------ | :------ |
| customDimensionId | string \| number |

##### Returns

Promise\<string \| undefined\>

___

#### setCustomDimensionValue

▸ setCustomDimensionValue(customDimensionId, customDimensionValue): void

Sets a custom dimension value to be used later.

##### Parameters

| Name | Type |
| :------ | :------ |
| customDimensionId | string \| number |
| customDimensionValue | string |

##### Returns

void

CustomEvent

$3


- trackEvent


#### trackEvent

▸ trackEvent(category, action, name?, value?, dimensions?): void

Tracks a custom event, e.g. when a visitor interacts with the page

##### Parameters

| Name | Type |
| :------ | :------ |
| category | string |
| action | string |
| name? | string |
| value? | number |
| dimensions? | Dimensions |

##### Returns

void

DataLayer

$3

#### Type Aliases

- DataLayerEntry


- push
- setDataLayerName

$3

#### DataLayerEntry

Ƭ DataLayerEntry: Record\<string, AnyData\>


#### push

▸ push(data): number

Adds entry to a data layer

##### Parameters

| Name | Type |
| :------ | :------ |
| data | DataLayerEntry |

##### Returns

number

___

#### setDataLayerName

▸ setDataLayerName(name): void

##### Parameters

| Name | Type |
| :------ | :------ |
| name | string |

##### Returns

void

DownloadAndOutlink

$3


- addDownloadExtensions
- enableLinkTracking
- getLinkTrackingTimer
- removeDownloadExtensions
- setDownloadClasses
- setDownloadExtensions
- setIgnoreClasses
- setLinkClasses
- setLinkTrackingTimer
- trackLink


#### addDownloadExtensions

▸ addDownloadExtensions(extensions): void

Adds new extensions to the download extensions list

##### Parameters

| Name | Type |
| :------ | :------ |
| extensions | string[] |

##### Returns

void

___

#### enableLinkTracking

▸ enableLinkTracking(trackAlsoMiddleAndRightClicks?): void

Enables automatic link tracking. If called with true, left, right and
middle clicks on links will be treated as opening a link. Opening a links to
an external site (different domain) creates an outlink event. Opening a link
to a downloadable file creates a download event

##### Parameters

| Name | Type |
| :------ | :------ |
| trackAlsoMiddleAndRightClicks? | boolean |

##### Returns

void

___

#### getLinkTrackingTimer

▸ getLinkTrackingTimer(): Promise\<number\>

Returns lock/wait time after a request set by setLinkTrackingTimer

##### Returns

Promise\<number\>

___

#### removeDownloadExtensions

▸ removeDownloadExtensions(extensions): void

Removes extensions from the download extensions list

##### Parameters

| Name | Type |
| :------ | :------ |
| extensions | string[] |

##### Returns

void

___

#### setDownloadClasses

▸ setDownloadClasses(classes): void

Sets a list of class names that indicate whether a list is a download and not an outlink

##### Parameters

| Name | Type |
| :------ | :------ |
| classes | string[] |

##### Returns

void

___

#### setDownloadExtensions

▸ setDownloadExtensions(extensions): void

Overwrites the list of file extensions indicating that a link is a download

##### Parameters

| Name | Type |
| :------ | :------ |
| extensions | string[] |

##### Returns

void

___

#### setIgnoreClasses

▸ setIgnoreClasses(classes): void

Set a list of class names that indicate a link should not be tracked

##### Parameters

| Name | Type |
| :------ | :------ |
| classes | string[] |

##### Returns

void

___

#### setLinkClasses

▸ setLinkClasses(classes): void

Sets a list of class names that indicate whether a link is an outlink and not download

##### Parameters

| Name | Type |
| :------ | :------ |
| classes | string[] |

##### Returns

void

___

#### setLinkTrackingTimer

▸ setLinkTrackingTimer(time): void

When a visitor produces an events and closes the page immediately afterwards,
e.g. when opening a link, the request might get cancelled. To avoid loosing
the last event this way, JavaScript Tracking Client will lock the page for a
fraction of a second (if wait time hasn’t passed), giving the request time to
reach the Collecting & Processing Pipeline

##### Parameters

| Name | Type |
| :------ | :------ |
| time | number |

##### Returns

void

___

#### trackLink

▸ trackLink(url, linkType, dimensions?, callback?): void

Manually tracks outlink or download event with provided values

##### Parameters

| Name | Type |
| :------ | :------ |
| url | string |
| linkType | string |
| dimensions? | Dimensions |
| callback? | () => void |

##### Returns

void

ErrorTracking

$3


- enableJSErrorTracking
- trackError


#### enableJSErrorTracking

▸ enableJSErrorTracking(unique?): void

Enables tracking of unhandled JavaScript errors.

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| unique? | boolean | track only unique errors |

##### Returns

void

___

#### trackError

▸ trackError(error): void

Attempts to send error tracking request using same format as native errors caught by enableJSErrorTracking().
Such error request will still follow rules set for tracker, so it will be sent only when JS error tracking is enabled
(enableJSErrorTracking function was called before this attempt). It will also respect rules for tracking only unique errors.

##### Parameters

| Name | Type |
| :------ | :------ |
| error | Error |

##### Returns

void

GoalConversions

$3


- trackGoal


#### trackGoal

▸ trackGoal(goalId, conversionValue, dimensions?, options?): void

Tracks manual goal conversion

##### Parameters

| Name | Type |
| :------ | :------ |
| goalId | string \| number |
| conversionValue | number |
| dimensions? | Dimensions |
| options? | EcommerceOptions |

##### Returns

void

Heartbeat

$3


- disableHeartBeatTimer
- enableHeartBeatTimer


#### disableHeartBeatTimer

▸ disableHeartBeatTimer(): void

Disables sending heartbeats if they were previously enabled by "enableHeartBeatTimer" function.

##### Returns

void

___

#### enableHeartBeatTimer

▸ enableHeartBeatTimer(delays?): void

When a visitor is not producing any events (e.g. because they are reading an article or watching a video), we don’t know if they are still on the page. This might skew page statistics, e.g. time on page value. Heartbeat timer allows us to determine how much time visitors spend on a page by sending heartbeats to the Tracker as long as the page is in focus.

##### Parameters

| Name | Type |
| :------ | :------ |
| delays? | number[] |

##### Returns

void

Miscellaneous

$3


- setTrackingSourceProvider


#### setTrackingSourceProvider

▸ setTrackingSourceProvider(provider, version): void

Adds metadata about used framework

##### Parameters

| Name | Type |
| :------ | :------ |
| provider | string |
| version | string |

##### Returns

void

PageViews

$3


- trackPageView


#### trackPageView

▸ trackPageView(customPageTitle?): void

Tracks a visit on the page that the function was run on

##### Parameters

| Name | Type |
| :------ | :------ |
| customPageTitle? | string |

##### Returns

void

SiteSearch

$3


- trackSiteSearch


#### trackSiteSearch

▸ trackSiteSearch(keyword, category?, searchCount?, dimensions?): void

Tracks search requests on a website

##### Parameters

| Name | Type |
| :------ | :------ |
| keyword | string |
| category? | string |
| searchCount? | number |
| dimensions? | Dimensions |

##### Returns

void

UserManagement

$3


- deanonymizeUser
- getUserId
- getVisitorId
- getVisitorInfo
- resetUserId
- setUserId
- setUserIsAnonymous


#### deanonymizeUser

▸ deanonymizeUser(): void

Disables anonymous tracking and sends deanonymization event to the Tracker. Recommended method for disabling anonymous tracking.

##### Returns

void

___

#### getUserId

▸ getUserId(): Promise\<string\>

The function that will return user ID

##### Returns

Promise\<string\>

___

#### getVisitorId

▸ getVisitorId(): Promise\<string\>

Returns 16-character hex ID of the visitor

##### Returns

Promise\<string\>

___

#### getVisitorInfo

▸ getVisitorInfo(): Promise\<VisitorInfo\>

Returns visitor information in an array

##### Returns

Promise\<VisitorInfo\>

___

#### resetUserId

▸ resetUserId(): void

Clears previously set userID, e.g. when visitor logs out

##### Returns

void

___

#### setUserId

▸ setUserId(userId): void

User ID is an additional parameter that allows you to aggregate data. When
set up, you will be able to search through sessions by this parameter, filter
reports through it or create Multi attribution reports using User ID

##### Parameters

| Name | Type |
| :------ | :------ |
| userId | string |

##### Returns

void

___

#### setUserIsAnonymous

▸ setUserIsAnonymous(isAnonymous): void

Enables or disables anonymous tracking (anonymous = without consent). The next emitted event will have anonymous mode set accordingly.

##### Parameters

| Name | Type |
| :------ | :------ |
| isAnonymous | boolean |

##### Returns

void

eCommerce

$3


- addEcommerceItem
- clearEcommerceCart
- ecommerceAddToCart
- ecommerceCartUpdate
- ecommerceOrder
- ecommerceProductDetailView
- ecommerceRemoveFromCart
- getEcommerceItems
- removeEcommerceItem
- setEcommerceView
- trackEcommerceCartUpdate
- trackEcommerceOrder


#### addEcommerceItem

▸ addEcommerceItem(productSKU, productName, productCategory, productPrice, productQuantity): void

##### Parameters

| Name | Type |
| :------ | :------ |
| productSKU | string |
| productName | string |
| productCategory | string \| string[] |
| productPrice | number |
| productQuantity | number |

##### Returns

void

Deprecated

Please use the ecommerceAddToCart instead.

___

#### clearEcommerceCart

▸ clearEcommerceCart(): void

##### Returns

void

Deprecated

___

#### ecommerceAddToCart

▸ ecommerceAddToCart(products, options?): void

Tracks action of adding products to a cart

##### Parameters

| Name | Type |
| :------ | :------ |
| products | Product[] |
| options? | EcommerceOptions |

##### Returns

void

___

#### ecommerceCartUpdate

▸ ecommerceCartUpdate(products, grandTotal, options?): void

Tracks current state of a cart

##### Parameters

| Name | Type |
| :------ | :------ |
| products | Product[] |
| grandTotal | string \| number |
| options? | EcommerceOptions |

##### Returns

void

___

#### ecommerceOrder

▸ ecommerceOrder(products, paymentInformation, options?): void

Tracks conversion, including products and payment details

##### Parameters

| Name | Type |
| :------ | :------ |
| products | Product[] |
| paymentInformation | PaymentInformation |
| options? | EcommerceOptions |

##### Returns

void

___

#### ecommerceProductDetailView

▸ ecommerceProductDetailView(products, options?): void

Tracks action of viewing product page

##### Parameters

| Name | Type |
| :------ | :------ |
| products | Product[] |
| options? | EcommerceOptions |

##### Returns

void

___

#### ecommerceRemoveFromCart

▸ ecommerceRemoveFromCart(products, options?): void

Tracks action of removing a products from a cart

##### Parameters

| Name | Type |
| :------ | :------ |
| products | Product[] |
| options? | EcommerceOptions |

##### Returns

void

___

#### getEcommerceItems

▸ getEcommerceItems(): Promise\<object\>

##### Returns

Promise\<object\>

Deprecated

___

#### removeEcommerceItem

▸ removeEcommerceItem(productSKU): void

##### Parameters

| Name | Type |
| :------ | :------ |
| productSKU | string |

##### Returns

void

Deprecated

Please use the ecommerceRemoveFromCart instead.

___

#### setEcommerceView

▸ setEcommerceView(productSKU, productName?, productCategory?, productPrice?): void

##### Parameters

| Name | Type |
| :------ | :------ |
| productSKU | string |
| productName? | string |
| productCategory? | string[] |
| productPrice? | string |

##### Returns

void

Deprecated

___

#### trackEcommerceCartUpdate

▸ trackEcommerceCartUpdate(cartAmount): void

##### Parameters

| Name | Type |
| :------ | :------ |
| cartAmount | number |

##### Returns

void

Deprecated

Please use the ecommerceCartUpdate instead.

___

#### trackEcommerceOrder

▸ trackEcommerceOrder(orderId, orderGrandTotal, orderSubTotal?, orderTax?, orderShipping?, orderDiscount?): void

##### Parameters

| Name | Type |
| :------ | :------ |
| orderId | string |
| orderGrandTotal | number |
| orderSubTotal? | number |
| orderTax? | number |
| orderShipping? | number |
| orderDiscount? | number |

##### Returns

void

Deprecated`

Please use the ecommerceOrder instead.