ionic-capacitor-tenjin v1.0.1
Tenjin Ionic Capacitor Plugin
Summary
Tenjin's SDK allows users to track events and installs in their iOS apps. To learn more about Tenjin and our product offering, please visit https://www.tenjin.com.
Notes:
On iOS:
For AppTrackingTransparency, be sure to update your project .plist
file and add NSUserTrackingUsageDescription
along with the text message you want to display to users. This library is only available in iOS 14.0+. For further information on this, you can check our iOS documentation
On Android: You will need to add Google's Install Referrer Library to your gradle dependencies. If you haven’t already installed the Google Play Services you also need to add it
dependencies {
classpath("com.android.installreferrer:installreferrer:1.1.2")
classpath("com.google.android.gms:play-services-analytics:17.0.0")
}
Plugin Integration
Install
npm install ionic-capacitor-tenjin
npx cap sync
Import
import Tenjin from 'ionic-capacitor-tenjin';
Available methods
Initialize
You need to initialize the plugin before doing calling any of the other methods available, for this, you would need the api key provided on Tenjin's dashboard:
Tenjin.initialize(sdkKey: string)
Connect
Tenjin.connect()
OptIn
Tenjin.optIn()
OptOut
Tenjin.optOut()
OptIn with parameters
Tenjin.optIn(params: string[])
OptOut with parameters
Tenjin.optOut(params: string[])
Register transaction
transaction(productName: string, currencyCode: string, quantity: number, unitPrice: number)
Send event with name
Tenjin.eventWithName(name: string)
Send event with name and value
Tenjin.eventWithNameAndValue(name: string, value: string)
Append app subversion
Tenjin.appendAppSubversion(subversion: number)
Impression Level Ad Revenue Integration
Tenjin supports the ability to integrate with the Impression Level Ad Revenue (ILRD) feature from,
- AppLovin
- IronSource
- HyperBid
- AdMob
- TopOn
This feature allows you to receive events which correspond to your ad revenue that is affected by each advertisement show to a user. To enable this feature, follow the below instructions.
:warning: NOTE: ILRD is a paid feature, so please contact your Tenjin account manager to discuss the price at first before sending ILRD events.
Attribution Info
Tenjin supports retrieving of attributes, which are required for developers to get analytics installation id (previously known as tenjin reference id). This parameter can be used when there is no advertising id.
:warning: NOTE: Attribution Info is a paid feature, so please contact your Tenjin account manager if you are interested in.
Customer User ID
Tenjin.setCustomerUserId(userId)
Parameters:
userId
: string
Tenjin.getCustomerUserId()
Returns: string
Update SKAN Postback Conversion Value (iOS only)
Tenjin.updatePostbackConversionValue(conversionValue)
Parameters:
conversionValue
: number
Tenjin.updatePostbackConversionValueCoarseValue(conversionValue, coarseValue)
Parameters:
conversionValue
: numbercoarseValue
: string
Tenjin.updatePostbackConversionValueCoarseValueLockWindow(conversionValue, coarseValue, lockWindow)
Parameters:
conversionValue
: numbercoarseValue
: stringlockWindow
: boolean
Support
If you have any issues with the plugin integration or usage, please contact us to support@tenjin.com