From version < 6.3 >
edited by Developer
on 2020/01/02 14:28
To version < 16.1 >
edited by Developer
on 2020/01/03 09:15
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,7 +2,7 @@
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -= Overview =
5 += 1. Overview =
6 6  
7 7  The plugin is located at npmjs repositories [[(npm repositories)>>https://www.npmjs.com/package/react-native-mobigate]]
8 8  This plugin is built for:
... ... @@ -9,7 +9,7 @@
9 9  
10 10  * Mobigate SDK version 1.0.4
11 11  
12 -= Adding SDK to the project =
12 += 2. Adding SDK to the project =
13 13  
14 14  **First, install library from the repository with**
15 15  
... ... @@ -60,7 +60,7 @@
60 60  }
61 61  {{/code}}{{/showhide}}
62 62  
63 -= Api methods =
63 += 3. Api methods =
64 64  
65 65  To use any method from the plugin add import:
66 66  
... ... @@ -68,7 +68,7 @@
68 68  import Mobigate from 'react-native-mobigate'
69 69  {{/code}}
70 70  
71 -== SDK initialization ==
71 +== 3.1 SDK initialization ==
72 72  
73 73  You must initialize the library before running it. Use //init(apiKey, options, onSuccess, onError)// method for that:
74 74  
... ... @@ -87,7 +87,7 @@
87 87  | appIdentifier|String| | Application identifier
88 88  |appInstallationSource |String| | App installation source e.g., google-play, organic.
89 89  |email |String | | Set's user email.
90 -|customUserId |String | | Set custom User Agent.
90 +|customUserId |String | | You may use your custom userID for marking data. By default we are using device ID and emails for matching. Set it before starting the service using MobigateSDk.Builder method.
91 91  | enableUserFields|Json Array | | Enable custom fields in user data. By default MobienceSDK is gathering all identifiers, which it can read. You can choose one of these field: ["email", "imei", "imsi", "msisdn", "mac", "serial"] DODAĆ LINKA DO CONSTANTS.
92 92  | dataGatherPolicy| Json Object| | Enable custom data gater policy. By default MobienceSDK gather all data it can read and hide notification icon. Check below DataGatherPolicy options for more details.
93 93  | enableIdProfiles|Boolean |false | turns on / off the IDs profiles system.
... ... @@ -100,6 +100,7 @@
100 100  |notificationText|String| | if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text
101 101  {{/showhide}}
102 102  
103 +
103 103  When the library is already initialized run it. Use //startSDK(onSuccess, onError)// method for that:
104 104  
105 105  **Mobigate.startSDK(onSuccess, onError)**
... ... @@ -152,18 +152,84 @@
152 152  {{/code}}
153 153  {{/showhide}}
154 154  
155 -== Tracking in app events ==
156 +== 3.2 Tracking in app events ==
156 156  
157 -== Remaining methods ==
158 +In-App Events provide insight on what is happening in your app. It is recommended to take the time and define the events you would like to measure.
158 158  
160 +=== 3.2.1 Overview ===
159 159  
162 +An event consists of two fields that you (% style="display:none" %) (%%)can use to describe a user's interaction with your app content:
160 160  
164 +(% class="table-bordered table-hover" %)
165 +|(% style="background-color:powderblue; width:200px" %)**Field name**|(% style="background-color:powderblue; width:200px" %)**Type**|(% style="background-color:powderblue; width:200px" %)**Required**|(% style="background-color:powderblue; width:200px" %)**Description**
166 +|(% style="width:200px" %)Category|(% style="width:200px" %)String|(% style="width:200px" %)yes|(% style="width:200px" %)Event category
167 +|(% style="width:200px" %)Parameter|(% style="width:200px" %)String|(% style="width:200px" %)no|(% style="width:200px" %)Event parameter. 
168 +There can be more than one
161 161  
170 +You can use any event category or parameter string of your choice. However, react-native-mobigate plugin contains recommended event categories and parameters via String constants (see [[Event categories>>doc:||anchor="H3.2.3Eventcategories"]] and [[Event parameters>>doc:||anchor="H3.2.4Eventparameters"]]).
162 162  
172 +=== 3.2.2 Implementation ===
173 +
174 +Tracking in-app events is performed by two methods:
175 +
176 +**Mobigate.trackEvent(options)**
177 +
178 +{{showhide id="2" showmessage="Options" hidemessage="Options"}}
163 163  (% class="table-bordered table-hover" style="border-color:powderblue" %)
164 164  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
181 +|name|String | | Event category name.
182 +|parameters|Json array| | Array of parameters. Look below on example.
183 +{{/showhide}}
184 +
185 +{{showhide id="3" showmessage="Example" hidemessage="Example"}}
186 +{{code language="javascript"}}
187 + sendTrackEvent = () => {
188 + if (Platform.OS === 'android') {
189 + Mobigate.trackEvent({
190 + name: Mobigate.CATEGORY_PURCHASE,
191 + parameters: {
192 + [Mobigate.PARAMETER_CONTENT_ID]: 42313532,
193 + [Mobigate.PARAMETER_PRICE]: 43.23,
194 + [Mobigate.PARAMETER_QUANTITY]: 2,
195 + 'userCustomParameterName':'simpleName'
196 + },
197 + })
198 + }
199 + }
200 +{{/code}}
201 +{{/showhide}}
202 +
203 +
204 +**Mobigate.trackAppInstall(timestamp)**
205 +
206 +(% class="table-bordered table-hover" style="border-color:powderblue" %)
207 +|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
208 +|timestamp|double|Unix timestamp in milliseconds
209 +
210 +{{showhide id="3" showmessage="Example" hidemessage="Example"}}
211 +{{code language="javascript"}}
212 + sendTrackEvent = () => {
213 + if (Platform.OS === 'android') {
214 + Mobigate.trackAppInstall(1578042916000)
215 + }
216 + }
217 +{{/code}}
218 +{{/showhide}}
219 +
220 +=== 3.2.3 Event categories ===
221 +
222 +=== 3.2.4 Event parameters ===
223 +
224 +== 3.3 Remaining methods ==
225 +
226 +
227 +
228 +
229 +
230 +(% class="table-bordered table-hover" style="border-color:powderblue" %)
231 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
165 165  | | | |
166 166  
167 -= Constants =
234 += 4. Constants =
168 168  
169 -= Sample app =
236 += 5. Sample app =
Spicy Mobile
spicymobile.pl