Home - konstantin-shinkarenko/doc-sample-proj GitHub Wiki

Conviva Android Sensor integration.

NOTE: This documentation is for Android SDK 4.0.2 and above. 
If you are using the legacy SDK, we highly recommend you upgrade to the new SDK.

Prerequisites:

  1. CUSTOMER_KEYs for your account to start reporting data. Conviva provides two accounts: one for test, one for production. Respectively, you will get two keys: TEST and PROD. Obtain your CUSTOMER_KEY here: Pulse - Account Info. Ask your Conviva representative for assistance if you have problems logging in.

  2. GatewayURL to enable debugging of your traffic via online tool Touchstone : The gatewayUrl is specific for your account and shall ONLY be used for tests, never for PROD deployment:

https://<YOUR_TEST_ACCOUNT_CUSTOMER_KEY>.testonly.conviva.com

The key steps for integration:

  • Install the library
  • Init using the CUSTOMER_KEY
  • Set Device Metadata (NOTE: check which fields are required for your platform / player, Conviva auto-detects certain value to make it easier);
  • Implement metadata & event reporting:
    • Report user playback request along with metadata (content, workflow, audience, etc)
    • Report video events OR pass player object reference to Conviva for auto-detection
    • Report ad events (if applicable)
    • Report user actions (backgrounding, user dialogue, etc)
    • Report end of playback
  • Once done - do sanity check using self-validation: App Manager -> Validate Build
  • Submit the app to Conviva for certification and get thumbs up!
  • Go live with your app - swap your TEST CUSTOMER_KEY by the PROD one, and make sure NO gatewayUrl for Touchstone used!

Done!

Analyse your data in Pulse and improve your viewer experience - let's make video experience better!