This is the Cordova SDK of adjust™. You can read more about adjust™ at [adjust.com].
These are the minimal steps required to integrate the adjust SDK into your Cordova project. We are going to assume the command line interface is used.
Download the latest version from our [releases page][releases]. Extract the zip file in a folder of your choice.
After you added iOS and/or Android as a platform for your project, enter the following command in your project folder:
> cordova plugin add path_to_folder/cordova_sdk
Installing com.adjust.sdk (android)
Installing com.adjust.sdk (ios)
The adjust plugin automatically registers with the cordova events deviceready
, resume
and pause
.
To configure the parameters of your app to adjust, follow these steps:
- Open the file
plugins/com.adjust.sdk/config/adjust.json
. - Replace the
appToken
value with the App Token that you can find in your [dashboard]. - Copy the the adjust hook folder
plugins/com.adjust.sdk/hooks
to the root of your project. It contains the script to replace the configuration values from theadjust.json
file. - There should be a new file
hooks/after_prepare/replace_adjust.js
located at the root of your project. Check if this file has execute permission and add the permission if needed.
Depending on whether or not you build your app for testing or for production
you must set the key environment
with one of these values:
"environment" : "sandbox"
"environment" : "production"
Important: This value should be set to sandbox
if and only if you or
someone else is testing your app. Make sure to set the environment to
production
just before you publish the app. Set it back to sandbox
when you
start testing it again.
We use this environment to distinguish between real traffic and artificial traffic from test devices. It is very important that you keep this value meaningful at all times! Especially if you are tracking revenue.
You can increase or decrease the amount of logs you see by setting the key
logLevel
with one of the following values:
"logLevel" : "verbose" // enable all logging
"logLevel" : "debug" // enable more logging
"logLevel" : "info" // the default
"logLevel" : "warn" // disable info logging
"logLevel" : "error" // disable warnings as well
"logLevel" : "assert" // disable errors as well
If your app makes heavy use of event tracking, you might want to delay some
HTTP requests in order to send them in one batch every minute. You can enable
event buffering by setting the key enableEventBuffering
to true
.
Since the 1st of August of 2014, apps in the Google Play Store must use the [Google Advertising ID][google_ad_id] to uniquely identify the devices. To allow the adjust SDK to use the Google Advertising ID, you must integrate the [Google Play Services][google_play_services].
Assuming you have the appropriate repositories available, this plugin will install the necessary Google services frameworks for that.
If you are using Proguard, add these lines to your Proguard file:
-keep class com.adjust.sdk.** { *; }
-keep class com.google.android.gms.common.** { *; }
-keep class com.google.android.gms.ads.identifier.** { *; }
```
## Additional Features
Once you integrated the adjust SDK into your project, you can take advantage of
the following features.
### 4. Add tracking of custom events.
You can tell adjust about every event you want. Suppose you want to track every
tap on a button. You would have to create a new Event Token in your
[dashboard]. Let's say that Event Token is `abc123`. In your button's `click`
event function you could then add the following line to track the click:
```javascript
Adjust.trackEvent('abc123');
```
You can also register a callback URL for that event in your [dashboard] and we
will send a GET request to that URL whenever the event gets tracked. In that
case you can also put some key-value-pairs in a dictionary and pass it to the
`trackEvent` function. We will then append these named parameters to your
callback URL.
For example, suppose you have registered the URL
`http://www.adjust.com/callback` for your event with Event Token `abc123` and
execute the following lines:
```javascript
var parameters = { 'key' : 'value', 'foo' : 'bar' };
Adjust.trackEvent('abc1234', parameters);
```
In that case we would track the event and send a request to:
```
http://www.adjust.com/callback?key=value&foo=bar
```
It should be mentioned that we support a variety of placeholders like `{idfa}`
for iOS or `{android_id}` for Android that can be used as parameter values. In
the resulting callback the `{idfa}` placeholder would be replaced with the ID
for Advertisers of the current device for iOS and the `{android_id}` would be
replaced with the AndroidID of the current device for Android. Also note that
we don't store any of your custom parameters, but only append them to your
callbacks. If you haven't registered a callback for an event, these parameters
won't even be read.
### 5. Add tracking of revenue
If your users can generate revenue by clicking on advertisements or making
in-app purchases you can track those revenues. If, for example, a click is
worth one cent, you could make the following call to track that revenue:
```javascript
Adjust.trackRevenue(1.0);
```
The parameter is supposed to be in cents and will get rounded to one decimal
point. If you want to differentiate between different kinds of revenue you can
get different Event Tokens for each kind. Again, you need to create those Event
Tokens in your [dashboard]. In that case you would make a call like this:
```javascript
Adjust.trackRevenue(1.0, 'abc123');
```
Again, you can register a callback and provide a dictionary of named
parameters, just like it worked with normal events.
```javascript
var parameters = { 'key' : 'value', 'foo' : 'bar' };
Adjust.trackRevenue(1.0, 'abc1234', parameters);
```
### 6. Receive delegate callbacks
Every time your app tries to track a session, an event or some revenue, you can
be notified about the success of that operation and receive additional
information about the current install. For that you can pass a javascript
callback function that receives one argument to the
`setFinishedTrackingCallback`, such as:
```javascript
Adjust.setFinishedTrackingCallback(function (responseData) { });
```
The callback function will get called every time any activity was tracked or
failed to track. Within the callback function you have access to the
`responseData` object parameter. Here is a quick summary of its attributes:
- `activityKind` indicates what kind of activity was tracked.
Returns one of these values:
```
session
event
revenue
reattribution
```
- `success` indicates whether or not the tracking attempt was successful.
Possible values `'true'` or `'false'`.
- `willRetry` is true when the request failed, but will be retried. Possible
values `'true'` or `'false'`.
- `error` an error message when the activity failed to track or the response
could not be parsed. Is `undefined` otherwise.
- `trackerToken` the tracker token of the current install. Is `undefined` if
request failed or response could not be parsed.
- `trackerName` the tracker name of the current install. Is `undefined` if
request failed or response could not be parsed.
- `network` the first grouping level of the tracker name. Is `undefined` if
request failed or response could not be parsed.
- `campaign` the second grouping level of the tracker name. Is `undefined` if
request failed or response could not be parsed.
- `adgroup` the third grouping level of the tracker name. Is `undefined` if
request failed or response could not be parsed.
- `creative` the fourth grouping level of the tracker name. Is `undefined` if
request failed or response could not be parsed.
Please make sure to consider [applicable attribution data policies.][attribution-data]
[adjust.com]: http://adjust.com
[dashboard]: http://adjust.com
[releases]: https://github.com/adjust/cordova_sdk/releases
[attribution-data]: https://github.com/adjust/sdks/blob/master/doc/attribution-data.md
[google_play_services]: http://developer.android.com/google/play-services/index.html
[google_ad_id]: https://developer.android.com/google/play-services/id.html
[google_play_services_plugin]: https://github.com/MobileChromeApps/google-play-services
## License
The adjust-sdk is licensed under the MIT License.
Copyright (c) 2012-2014 adjust GmbH,
http://www.adjust.com
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.