Digital Measurement Android Artifactory Guide: Difference between revisions
From Engineering Client Portal
ColinBrown (talk | contribs) No edit summary |
ColinBrown (talk | contribs) No edit summary |
||
Line 23: | Line 23: | ||
<br> | <br> | ||
[[File:note2.jpg|icon]] Please do not upload any file to github containing the credentials to download the NielsenSDK. This will automatically lock your access. | [[File:note2.jpg|icon]] Please do not upload any file to github containing the credentials to download the NielsenSDK.<br> This will automatically lock your access. | ||
=== Credentials === | === Credentials === |
Revision as of 20:55, 29 July 2019
The Nielsen AppSDK can either be downloaded directly from the Engineering Portal, or can be integrated directly within an application through the use of a CocoaPod or Gradle.
How to install the Nielsen AppSDK using Gradle for Android
Below are the steps which need to be performed by app developers to integrate the Nielsen App SDK within an Android application.
Update grade.properties
The first step is to add the credentials received from Nielsen into your gradle.properties file, typically near the end of the file. We recommend using the version in your home folder (Global Properties). Gradle looks for gradle.properties files in this sequence:
gradle.properties
in project root directory.gradle.properties
in GRADLE_USER_HOME directory.- system properties, e.g. when
-Dgradle.user.home
is set on the command line.
Properties from one file will override the properties from the previous ones (so file in gradle user home has precedence over the others, and file in sub-project has precedence over the one in project root).
Reference: https://gradle.org/docs/current/userguide/build_environment.html
machine raw.githubusercontent.com
nielsen_user=<Nielsen App SDK client>
nielsen_authCode=<Auth token>
icon Please do not upload any file to github containing the credentials to download the NielsenSDK.
This will automatically lock your access.
Credentials
Obtain credentials → here ←
Add Nielsen Maven Repository
Please add the Nielsen maven repository inside the repositories section of your app's module build.gradle file like below:
android{
repositories {
//Copy below code inside repository section of app’s build.gradle file
maven { url 'https://raw.githubusercontent.com/NielsenDigitalSDK/nielsenappsdk-android/master/'
credentials {
//Make sure you add nielsen_user and nielsen_passwd with respective nielsen provided
// values to global gradle.properties file
username = project.property("nielsen_user")
password = project.property("nielsen_authCode")
}
authentication {
basic(BasicAuthentication)
}
}
}
}
Add gradle dependency
Please add Nielsen app SDK as compile time dependency inside build.gradle file as below
grade 4.x and above
For gradle version starting with 4.x add below line inside dependencies section of build.gradle file.
implementation 'com.nielsenappsdk:${flavour}:${version}'
grade prior to 4.x
For gradle version previous to 4.x add below line inside dependencies section of build.gradle file.
compile 'com.nielsenappsdk:${flavour}:${version}'
Version Control
Please replace ${version} with required Nielsen App SDK release version given in below table Please replace ${flavour} with one of below flavour type value
Flavour Type | Description | |
---|---|---|
global | For Global Clients | |
agf | For AGF Clients | |
vri | based nielsen app sdk clients (Japan) |
Below is an example for dependency
dependencies { ....
implementation 'com.nielsenappsdk:global:+'
}
Ensuring you have the latest release information
It is recommended to use the most recent version of the NielsenSDK by using the following:
dependencies { ....
implementation 'com.nielsenappsdk:global:+'
}
In addition, please add below gradle task inside your build.gradle (Module:app)
or build.gradle(Project:My-app)
file to fetch latest release details of nielsen app sdk as below:
Please note: The
build.gradle (Module:app)
can overwrite thebuild.gradle(Project:My-app)
.
task NielsenSdkReleaseCheck {
def login_details = project.property("nielsen_user")+":"+project.property("nielsen_authCode")
def p = ['curl', '-u',login_details ,"https://raw.githubusercontent.com/NielsenDigitalSDK/nielsenappsdk-android/master/com/nielsenappsdk/global/NielsenAppSdk-ReadMe.md"].execute().text
project.logger.log(LogLevel.ERROR,p)
}
preBuild.dependsOn('NielsenSdkReleaseCheck')
Sync
If you are finished with all previous steps then you can sync your build.gradle and after successful build you are ready to use Nielsen App SDK library in your code.