adverge-dk-react-native-sdk

Adverge React Native SDK

Note: this version of Adverge SDK has peer dependency to InTrack-react-native-bridge , so if you want to use it withour inTrack, please use adverge-react-native-sdk

Table of Contents

• How to install adverge react native sdk

• With package managers(npm, yarn)

• Initialization And Test

• Api

• Init

• GetDeviceId

• Identify

• Click

• Impression

How to install and import Adverge react native SDK

With Package Managers

You can use one of the following commands to install the sdk.

npm install  adverge-dk-react-native-sdk

The following code shows you how could it be imported in es6 or 7 or typescript.

import {init} from  'adverge-dk-react-native-sdk'

...

Initialization And Test

To begin, call the init method to initialize Adverge sdk with a writekey if available; otherwise, initialize it with an arbitrary string:

init({ writeKey: "Your Write Key", debugMode: false });

Note: make sure you call init method after intrack initialization, for example:

if (!(await InTrack.isInitialized())) {
  //init inTrack
  await InTrack.init({
    appKey: "INTRACK_APP_KEY__",
    iosAuthKey: "ّINTRACK_AUTH_KEY_FOR_IOS__",
    androidAuthKey: "INTRACK_AUTH_KEY_FOR_ANDROID__",
  });
  InTrack.start();
  /// other inTrack related codes...

  // init Adverge:
  Adverge.init({ writeKey: "Your ADVERGE Write Key", debugMode: true });
}

Now you are ready to send events, and call Adverge methods:

identify(userId); // optional, if the user is logged-in

click(adIds); // calls a click event

impression(adIds); // calls an impression event

flush(); // cleanse the queue and sends all the events

getDeviceId(); // get Adverge device Id (return a promise)

Api

Init

Use the init method to initialize Adverge react native SDK.

init({ writeKey, debugMode });

init({ writeKey: "adverge_writeKey", debugMode: false });

writeKey

The given adverge writeKey.

debugMode

This parameter is used to enable logging. Pass true in order to enable debug mode.

GetDeviceId

Use the getDeviceId method to get Adverge Device ID.

getDeviceId();

getDeviceId()
  .then((deviceId) => {
    console.log("Adverge deviceId:", deviceId);
  })

  .catch((error) => {
    console.error(error);
  });

Identify

Use the identify method to link users to their actions

identify(userId);

identify("12091906-01011992");

userId

The database ID for the user. If you don’t know who the user is, you can set the userId an empty string.

Click

The click method allows you to record click count.

click(adIds);

click(["12091906"]);

adIds

The list of database IDs for advertisements.

Impression

The impression method allows you to record impression count.

impression(adIds);

impression(["12091906"]);

adIds

The list of database IDs for advertisements.