Skip to content

Commit bffaf38

Browse files
kaushik-patel-uskaushik-patel-us
committed
update ReadME file
1 parent a460b07 commit bffaf38

File tree

3 files changed

+37
-31
lines changed

3 files changed

+37
-31
lines changed

‎README.md‎

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ startSession()
102102

103103
### trackScreen()
104104

105-
The trackScreen method is used to track screen views within a React Native application. It will take `screen name`,`title` with the optional parameter `actionDimensions`.
105+
The trackScreen method is used to track screen views within a React Native application. It will take `screen name`,`title` with the optional parameter `dimension`.
106106

107107
#### Example
108108

@@ -133,7 +133,7 @@ trackScreen("HomeScreen","Navigate to home screen",{
133133

134134
### trackEvent()
135135

136-
The trackEvent method is used to track custom events within a React Native application. It will take `category`,`action`,`name` ,`value` with the optional parameter `actionDimensions`.
136+
The trackEvent method is used to track custom events within a React Native application. It will take `category`,`action`,`name` ,`value` with the optional parameter `dimension`.
137137

138138
#### Example
139139

@@ -206,7 +206,7 @@ size: 'L',
206206

207207
### trackOutlink()
208208

209-
The trackOutlink method is used to track clicks on outbound links within a React Native application. It will take only `url` with the optional parameter `actionDimensions`.
209+
The trackOutlink method is used to track clicks on outbound links within a React Native application. It will take only `url` with the optional parameter `dimension`.
210210

211211
#### Example
212212

@@ -238,7 +238,7 @@ trackOutlink("https://www.google.com/",{
238238

239239
### trackSearch()
240240

241-
The trackSearch method is used to track search keyword within a React Native application. It will take only `keyword` with the optional parameter `actionDimensions`.
241+
The trackSearch method is used to track search keyword within a React Native application. It will take only `keyword` with the optional parameter `dimension`.
242242

243243
#### Example
244244

@@ -268,7 +268,7 @@ trackImpression("Logicwind",{
268268

269269
### trackImpression()
270270

271-
The trackImpression method is used to track specific content or elements within a React Native application. It will take only `contentName` with the optional parameter `actionDimensions`.
271+
The trackImpression method is used to track specific content or elements within a React Native application. It will take only `contentName` with the optional parameter `dimension`.
272272

273273
#### Example
274274

@@ -299,7 +299,7 @@ trackImpression("Test Track Impression",{
299299

300300
### trackInteraction()
301301

302-
The trackInteraction method is used to track users engage with specific elements or perform actions within a React Native application. It will take `contentName` and `contentInteraction` with the optional parameter `actionDimensions`.
302+
The trackInteraction method is used to track users engage with specific elements or perform actions within a React Native application. It will take `contentName` and `contentInteraction` with the optional parameter `dimension`.
303303

304304
#### Example
305305

@@ -330,7 +330,7 @@ trackInteraction("Test Track interaction","test inetraction",{
330330

331331
### trackDownload()
332332

333-
The trackDownload method is used to track the download of files or resources within a React Native application. It will take `category`,`action` and `download-url` with the optional parameter `actionDimensions`.
333+
The trackDownload method is used to track the download of files or resources within a React Native application. It will take `category`,`action` and `download-url` with the optional parameter `dimension`.
334334

335335
#### Example
336336

@@ -476,7 +476,7 @@ trackMediaEvent({siteId:"siteid",mediaId:"unique id",mediaTitle:"video media pla
476476

477477
### trackCampaign()
478478

479-
Tracking campaigns usually involves recording information about user interactions that can be tied to specific marketing efforts, such as UTM parameters.It requires the parameters `title`,`campaignUrl` with the optional parameter `actionDimensions`
479+
Tracking campaigns usually involves recording information about user interactions that can be tied to specific marketing efforts, such as UTM parameters.It requires the parameters `title`,`campaignUrl` with the optional parameter `dimension`
480480

481481
- #### Default Campaign Tracking Values
482482
* Campaign (Required): mtm_campaign
@@ -560,16 +560,7 @@ trackCustomDimension({
560560

561561
```
562562

563-
Dimensions {
564-
"dimension":{
565-
"action":[
566-
{"id":String}
567-
],
568-
"visit":[
569-
{"id":String}
570-
]
571-
}
572-
}
563+
573564

574565
## Methods
575566

@@ -578,23 +569,38 @@ Dimensions {
578569
|--------------------------------------|-----------------------------------------------------------|:-------:|:---:|:----------:|:--------:|:--------:|
579570
| [createTracker](#createtracker) | uri: String, siteId: Number, token: String | ✅ | ✅ | ✅ | ✅ | ✅ |
580571
| [startSession](#startsession) | - | ✅ | ✅ | ✅ | ✅ | ✅ |
581-
| [trackScreen](#trackscreen) | screenName: String, title: String, dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
582-
| [trackEvent](#trackevent) | category:String, action:String, name:String, value:Number, dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
583-
| [trackOutlink](#trackoutlink) | url:String, dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
584-
| [trackSearch](#tracksearch) | keyword:String, dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
585-
| [trackImpression](#trackimpression) | contentName:String, dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
586-
| [trackInteraction](#trackinteraction)| contentName:String, contentInteraction:String, dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
572+
| [trackScreen](#trackscreen) | screenName: String, title: String, dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
573+
| [trackEvent](#trackevent) | category:String, action:String, name:String, value:Number, dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
574+
| [trackOutlink](#trackoutlink) | url:String, dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
575+
| [trackSearch](#tracksearch) | keyword:String, dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
576+
| [trackImpression](#trackimpression) | contentName:String, dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
577+
| [trackInteraction](#trackinteraction)| contentName:String, contentInteraction:String, dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
587578
| [trackDownload](#trackdownload) | category:String, action:String, url:String | ✅ | ✅ | ✅ | ✅ | ✅ |
588579
| [setUserId](#setuserid) | id:String | ✅ | ✅ | ✅ | ✅ | ✅ |
589580
| [setVisitorId](#setvisitorid) | visitorId:String | ✅ | ✅ | ✅ | ✅ | ✅ |
590581
| [trackDispatch](#trackdispatch) | - | ✅ | ✅ | ✅ | ✅ | ✅ |
591582
| [disableTracking](#disabletracking) | - | ✅ | ✅ | ✅ | ✅ | ✅ |
592583
| [enableTracking](#enabletracking) | - | ✅ | ✅ | ✅ | ✅ | ✅ |
593584
| [setLogger](#setlogger) | - | ✅ | ✅ | ✅ | ✅ | ✅ |
594-
| [trackMediaEvent](#trackmediaevent) | siteId: String, mediaId: String, mediaTitle: String, playerName: String, mediaType: String, mediaResource: String, mediaStatus: String,mediaLength?:String, mediaProgress?:String, mediaTTP?: String, mediaWidth?: String, mediaHeight?: String, mediaSE?: String, mediaFullScreen?:String, dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
595-
| [trackCampaign](#trackcampaign) | title: String, campaignUrl: String, dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
596-
| [trackCustomDimension](#trackcustomdimension) | dimensions:Dimensions | ✅ | ✅ | ✅ | ✅ | ✅ |
585+
| [trackMediaEvent](#trackmediaevent) | siteId: String, mediaId: String, mediaTitle: String, playerName: String, mediaType: String, mediaResource: String, mediaStatus: String,mediaLength?:String, mediaProgress?:String, mediaTTP?: String, mediaWidth?: String, mediaHeight?: String, mediaSE?: String, mediaFullScreen?:String, dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
586+
| [trackCampaign](#trackcampaign) | title: String, campaignUrl: String, dimensions:[{key:string,value:string}] | ✅ | ✅ | ✅ | ✅ | ✅ |
587+
| [trackCustomDimension](#trackcustomdimension) | dimensions:Dimension | ✅ | ✅ | ✅ | ✅ | ✅ |
588+
589+
## Dimension Object Property
597590

591+
```js
592+
Dimension : {
593+
"dimension":{
594+
"action":[
595+
{"id":String}
596+
],
597+
"visit":[
598+
{"id":String}
599+
]
600+
}
601+
}
602+
603+
```
598604

599605
<!-- ## Contributing
600606

‎example/src/App.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ export default function App() {
278278
style={styles.button}
279279
onPress={() => {
280280
trackMediaEvent({ siteId: "siteId", mediaId: Date.now.toString(), mediaTitle: "video media play track", playerName: "test 08", mediaType: MediaType.VIDEO, mediaResource: "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4", mediaStatus: "100", mediaLength: "100", mediaFullScreen: "1", mediaHeight: "720", mediaWidth: "1080", mediaProgress: "100",
281-
actionDimensions:{
281+
dimension:{
282282
"dimension":{
283283
"visit":[
284284
{"1":"visit dimension 1"},

‎src/index.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ export function trackCampaign(title:String,campaignUrl:String,actionDimensions?:
8989
}
9090

9191
export function trackMediaEvent(
92-
{siteId,mediaId,mediaTitle,playerName,mediaType,mediaResource,mediaStatus,mediaLength="",mediaProgress="",mediaTTP="",mediaWidth="",mediaHeight="",mediaSE="",mediaFullScreen="",actionDimensions}:{
92+
{siteId,mediaId,mediaTitle,playerName,mediaType,mediaResource,mediaStatus,mediaLength="",mediaProgress="",mediaTTP="",mediaWidth="",mediaHeight="",mediaSE="",mediaFullScreen="",dimension}:{
9393
siteId: String,
9494
mediaId: String,
9595
mediaTitle: String,
@@ -105,9 +105,9 @@ export function trackMediaEvent(
105105
mediaSE?: String,
106106
mediaFullScreen?:String,
107107
customVariable?:String,
108-
actionDimensions?: DimensionData
108+
dimension?: DimensionData
109109
}): Promise<number> {
110-
return ReactNativeMatomoTracker.trackMedia(siteId,mediaId,mediaTitle,playerName,mediaType,mediaResource,mediaStatus,mediaLength,mediaProgress,mediaTTP,mediaWidth,mediaHeight,mediaSE,mediaFullScreen,actionDimensions);
110+
return ReactNativeMatomoTracker.trackMedia(siteId,mediaId,mediaTitle,playerName,mediaType,mediaResource,mediaStatus,mediaLength,mediaProgress,mediaTTP,mediaWidth,mediaHeight,mediaSE,mediaFullScreen,dimension);
111111
}
112112

113113
export function trackCustomDimension(

0 commit comments

Comments
 (0)