Changes for page React native integration

Last modified by Developer on 2020/01/03 12:47

From version < 5.5 >

edited by Developer
on 2020/01/02 13:40

To version < 17.1 >

edited by Developer
on 2020/01/03 09:45

< >

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -2,7 +2,7 @@
  {{toc/}}
  {{/box}}
--= Overview =
++= 1. Overview =
  The plugin is located at npmjs repositories [[(npm repositories)>>https://www.npmjs.com/package/react-native-mobigate]]
  This plugin is built for:
@@ -9,7 +9,7 @@
  * Mobigate SDK version 1.0.4
--= Adding SDK to the project =
++= 2. Adding SDK to the project =
  **First, install library from the repository with**
@@ -60,7 +60,7 @@
  }
  {{/code}}{{/showhide}}
--= Api methods =
++= 3. Api methods =
  To use any method from the plugin add import:
@@ -68,7 +68,7 @@
  import Mobigate from 'react-native-mobigate'
  {{/code}}
--== SDK initialization ==
++== 3.1 SDK initialization ==
  You must initialize the library before running it. Use //init(apiKey, options, onSuccess, onError)// method for that:
@@ -81,37 +81,327 @@
  |onSuccess|Function|returns callback object
  |onError|Function|returns callback object
--Options
--
++{{showhide id="2" showmessage="Options" hidemessage="Options"}}
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
  | appIdentifier|String| | Application identifier
  |appInstallationSource |String| | App installation source e.g., google-play, organic.
  |email |String | | Set's user email.
--|customUserId |String | | Set custom User Agent.
++|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.
  | 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.
  | 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.
  | enableIdProfiles|Boolean |false | turns on / off the IDs profiles system.
++{{/showhide}}
--DataGatherPolicy options
++{{showhide id="3" showmessage="DataGatherPolicy options" hidemessage="DataGatherPolicy options"}}
++(% class="table-bordered table-hover" style="border-color:powderblue" %)
++|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
++| monitorState|String| | Possible monitor states: DODAĆ LINKA DO CONSTANTS. More info about gathering data [[here>>https://wiki.spicymobile.pl/wiki/mobigatesdk/view/Main/mobigatesdkintegrationforandroiddevelopers/#H5.8Datagatherpolicy]]
++|notificationText|String| | if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text
++{{/showhide}}
++
++When the library is already initialized run it. Use //startSDK(onSuccess, onError)// method for that:
++
++**Mobigate.startSDK(onSuccess, onError)**
++
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
++|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
++|onSuccess|Function|returns callback object
++|onError|Function|returns callback object
++
++{{showhide id="3" showmessage="Example" hidemessage="Example"}}
++{{code language="javascript"}}
++  initLibrary = () => {
++    if (Platform.OS === 'android') {
++      Mobigate.init("V0K6jhiIfem6CRWHYZ59Nmj3oFBBKbJsnSsWfR2JNq7ktblOUXwbJoBQTpWnw2uSwW76gpiu2kun50jweTY69B",
++        {
++          /*custom options, check docs for more details
++           appIdentifier: 'customUserAppIdentifier',
++           appInstallationSource: "customAppInstallationSourcexyz",
++           email: 'testemail@gmail.com',
++           userAgent: 'customUserAgent',
++           customUserId: 'customUserId',*/
++        }, (success) => {
++          /* You can configure custom collectors after init
++          Mobigate.disableAllDataCollector()
++          Mobigate.configureDataCollectors(true, [Mobigate.DATA_COLLECTOR_APPS_LIST,
++          Mobigate.DATA_COLLECTOR_BATTERY,
++          Mobigate.DATA_COLLECTOR_PHONE_INFO])*/
++
++          Mobigate.startSDK((result) => {
++            this.setState({
++              status: 'started',
++            });
++
++          }, (errorResult) => {
++            this.setState({
++              status: errorResult,
++            });
++          })
++        }, (initError) => {
++          this.setState({
++            status: initError,
++          });
++        })
++    }else{
++      this.setState({
++        status: 'Mobigate SDK supports only Android'
++      })
++    }
++  }
++{{/code}}
++{{/showhide}}
++
++== 3.2 Tracking in app events ==
++
++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.
++
++=== 3.2.1 Overview ===
++
++An event consists of two fields that you (% style="display:none" %) (%%)can use to describe a user's interaction with your app content:
++
++(% class="table-bordered table-hover" %)
++|(% 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**
++|(% style="width:200px" %)Category|(% style="width:200px" %)String|(% style="width:200px" %)yes|(% style="width:200px" %)Event category
++|(% style="width:200px" %)Parameter|(% style="width:200px" %)String|(% style="width:200px" %)no|(% style="width:200px" %)Event parameter.
++There can be more than one
++
++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"]]).
++
++=== 3.2.2 Implementation ===
++
++Tracking in-app events is performed by two methods:
++
++**Mobigate.trackEvent(options)**
++
++{{showhide id="2" showmessage="Options" hidemessage="Options"}}
++(% class="table-bordered table-hover" style="border-color:powderblue" %)
  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
--| monitorState|String| | Application identifier
--|notificationText|String| | if state = "DEFAULT" you can pass custom foreground service notification text
++|name|String | | Event category name.
++|parameters|Json array| | Array of parameters. Look below on example.
++{{/showhide}}
--== Tracking in app events ==
++{{showhide id="3" showmessage="Example" hidemessage="Example"}}
++{{code language="javascript"}}
++  sendTrackEvent = () => {
++    if (Platform.OS === 'android') {
++      Mobigate.trackEvent({
++        name: Mobigate.CATEGORY_PURCHASE,
++        parameters: {
++          [Mobigate.PARAMETER_CONTENT_ID]: 42313532,
++          [Mobigate.PARAMETER_PRICE]: 43.23,
++          [Mobigate.PARAMETER_QUANTITY]: 2,
++          'userCustomParameterName':'simpleName'
++        },
++      })
++    }
++  }
++{{/code}}
++{{/showhide}}
--== Remaining methods ==
++**Mobigate.trackAppInstall(timestamp)**
++(% class="table-bordered table-hover" style="border-color:powderblue" %)
++|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
++|timestamp|double|Unix timestamp in milliseconds
++{{showhide id="3" showmessage="Example" hidemessage="Example"}}
++{{code language="javascript"}}
++  sendTrackEvent = () => {
++    if (Platform.OS === 'android') {
++      Mobigate.trackAppInstall(1578042916000)
++    }
++  }
++{{/code}}
++{{/showhide}}
++=== 3.2.3 Event categories ===
++The following section describes the recommended structure of each event category. In-app events categories are defined as part of plugin String constants.
++
++
++{{showhide id="1" showmessage="LEVEL_ACCOMPLISHED" hidemessage="LEVEL_ACCOMPLISHED" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: 0px"}}
++
++\\**Description:** Track accomplished game level achievement
++**Event category:** LEVEL_ACCOMPLISHED
++**Recommended parameters:** LEVEL, SCORE
++{{/showhide}}
++
++{{showhide id="2" showmessage="ADD_PAYMENT_INFO" hidemessage="ADD_PAYMENT_INFO" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track payment info
++**Event category:** ADD_PAYMENT_INFO
++**Recommended parameters:** SUCCESS
++{{/showhide}}
++
++{{showhide id="3" showmessage="ADD_TO_BASKET" hidemessage="ADD_TO_BASKET" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track add item to basket
++**Event category:** ADD_TO_BASKET
++**Recommended parameters:** PRICE, CONTENT_TYPE, CONTENT_ID, CONTENT, CURRENCY, QUANTITY
++{{/showhide}}
++
++{{showhide id="4" showmessage="REMOVED_FROM_BASKET" hidemessage="REMOVED_FROM_BASKET" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track removed item from basket
++**Event category:** REMOVED_FROM_BASKET
++**Recommended parameters:** PRICE, CONTENT_TYPE, CONTENT_ID, CONTENT, CURRENCY, QUANTITY
++{{/showhide}}
++
++{{showhide id="5" showmessage="ADD_TO_WISH_LIST" hidemessage="ADD_TO_WISH_LIST" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track add item to wish list
++**Event category:** ADD_TO_WISH_LIST
++**Recommended parameters:** PRICE, CONTENT_TYPE, CONTENT_ID, CONTENT, CURRENCY, QUANTITY
++{{/showhide}}
++
++{{showhide id="6" showmessage="REGISTRATION" hidemessage="REGISTRATION" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track registration
++**Event category:** REGISTRATION
++**Recommended parameters:** REGISTRATION_METHOD
++{{/showhide}}
++
++{{showhide id="7" showmessage="TUTORIAL_COMPLETION" hidemessage="TUTORIAL_COMPLETION" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track tutorial completion
++**Event category:** TUTORIAL_COMPLETION
++**Recommended parameters:** SUCCESS, CONTENT, CONTENT_ID
++{{/showhide}}
++
++{{showhide id="8" showmessage="TRIGGER_CHECKOUT" hidemessage="TRIGGER_CHECKOUT" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track triggered checkout
++**Event category:** TRIGGER_CHECKOUT
++**Recommended parameters:** PROCE, CONTENT_TYPE, CONTENT_ID, CONTENT, QUANTITY, PAYMENT_INFO_AVAILABLE, CURRENCY
++{{/showhide}}
++
++{{showhide id="9" showmessage="PURCHASE" hidemessage="PURCHASE" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track purchased item
++**Event category:** PURCHASE
++**Recommended parameters:** REVENUE, CONTENT_TYPE, CONTENT_ID, CONTENT, PRICE, QUANTITY, CURRENCY, ORDER_ID
++{{/showhide}}
++
++{{showhide id="10" showmessage="SUBSCRIBE" hidemessage="SUBSCRIBE" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track subscription purchase
++**Event category:** SUBSCRIBE
++**Recommended parameters:** REVENUE, CURRENCY
++{{/showhide}}
++
++{{showhide id="11" showmessage="BEGIN_TRIAL" hidemessage="BEGIN_TRIAL" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track begin trail of product
++**Event category:** BEGIN_TRIAL
++**Recommended parameters:** PRICE, CURRENCY
++{{/showhide}}
++
++{{showhide id="12" showmessage="RATE" hidemessage="RATE" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++
++\\**Description:** Track app/item rate
++**Event category:** RATE
++**Recommended parameters:** RATING_VALUE, CONTENT_TYPE, CONTENT_ID, CONTENT, MAX_RATING_VALUE
++{{/showhide}}
++
++{{showhide id="13" showmessage="SEARCH" hidemessage="SEARCH" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track search event
++**Event category:** SEARCH
++**Recommended parameters:** CONTENT_TYPE, SEARCH_STRING, SUCCESS
++{{/showhide}}
++
++{{showhide id="14" showmessage="USED_CREDIT" hidemessage="USED_CREDIT" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track use of credit
++**Event category:** USED_CREDIT
++**Recommended parameters:** PRICE, CONTENT_TYPE, CONTENT_ID, CONTENT
++{{/showhide}}
++
++{{showhide id="15" showmessage="UNLOCKED_ACHIEVEMENT" hidemessage="UNLOCKED_ACHIEVEMENT" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track achievement unlock
++**Event category:** UNLOCKED_ACHIEVEMENT
++**Recommended parameters:** DESCRIPTION
++{{/showhide}}
++
++{{showhide id="16" showmessage="VIEW_CONTENT" hidemessage="VIEW_CONTENT" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track content view event
++**Event category:** VIEW_CONTENT
++**Recommended parameters:** PRICE, CONTENT_TYPE, CONTENT_ID, CONTENT, CURRENCY
++{{/showhide}}
++
++{{showhide id="17" showmessage="VIEW_LIST" hidemessage="VIEW_LIST" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track list event
++**Event category:** VIEW_LIST
++**Recommended parameters:** CONTENT_TYPE, CONTENT_LIST
++{{/showhide}}
++
++{{showhide id="18" showmessage="CLICK_AD" hidemessage="CLICK_AD" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track ad click
++**Event category:** CLICK_AD
++**Recommended parameters:** CONTENT_TYPE, CONTENT_ID
++{{/showhide}}
++
++{{showhide id="19" showmessage="VIEW_AD" hidemessage="VIEW_AD" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track view ad
++**Event category:** VIEW_AD
++**Recommended parameters:** CONTENT_TYPE, CONTENT_ID
++{{/showhide}}
++
++{{showhide id="20" showmessage="EVENT_BOOKING" hidemessage="EVENT_BOOKING" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track booking event
++**Event category:** EVENT_BOOKING
++**Recommended parameters:** REVENUE, DESTINATION_A, DESTINATION_B, CLASS, DESCRIPTION, CUSTOMER_USER_ID, CONTENT_TYPE, CONTENT_ID, DATE_A, DATE_B
++{{/showhide}}
++
++{{showhide id="21" showmessage="SHARE" hidemessage="SHARE" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track share event
++**Event category:** SHARE
++**Recommended parameters:** DESCRIPTION
++{{/showhide}}
++
++{{showhide id="22" showmessage="INVITE" hidemessage="INVITE" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track social invite event
++**Event category:** INVITE
++**Recommended parameters:** NONE
++{{/showhide}}
++
++{{showhide id="23" showmessage="LOGIN" hidemessage="LOGIN" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track user login event
++**Event category:** LOGIN
++**Recommended parameters:** NONE
++{{/showhide}}
++
++{{showhide id="24" showmessage="EVENT_RETURN" hidemessage="EVENT_RETURN" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track re engagement event
++**Event category:** EVENT_RETURN
++**Recommended parameters:** NONE
++{{/showhide}}
++
++{{showhide id="25" showmessage="OPENED_PUSH_NOTIFICATION" hidemessage="OPENED_PUSH_NOTIFICATION" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track user opened push notification
++**Event category:** OPENED_PUSH_NOTIFICATION
++**Recommended parameters:** NONE
++{{/showhide}}
++
++{{showhide id="26" showmessage="UPDATE" hidemessage="UPDATE" effect="slide" effectduration="0.3" style="border-radius: 5px; border: 1px solid powderblue; padding: 7px 7px 7px 30px; margin: -1px 0px 0px 0px"}}
++\\**Description:** Track update event
++**Event category:** UPDATE
++**Recommended parameters:** CONTENT_ID
++{{/showhide}}
++
++=== 3.2.4 Event parameters ===
++
++== 3.3 Remaining methods ==
++
++
++
++
++
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
  | | | |
--= Constants =
++= 4. Constants =
--= Sample app =
++= 5. Sample app =

Changes for page React native integration

Summary

Details

MobigateSDK Center