Roku SourcepointSdk

Install the SDK

For each folder in dist/ copy the sourcepoint-sdk folder into your corresponding project folder.

Load the SDK

The SDK must be created in your main thread, as it will create its own Screen object if it needs to show messages.

Note: See the test-channel for an example of how to trigger SDK functions from your screen if needed.

After creating your application's screen, create the SourcepointSdk:

m.spSdk = SourcepointSdk(accountId, propertyHref, legislationConfigs, optionalConfigs, showMessage)

SourcepointSdk takes the following arguments:

Argument	Data Type	Required?	Description
accountId	Integer	Required	The accountId associates the property with your organization's Sourcepoint account. It can be retrieved by contacting your Sourcepoint Account Manager or via the My Account page in your Sourcepoint account.
propertyHref	String	Required	Maps the implementation to a specific URL as set up in the Sourcepoint account dashboard. (e.g. https://www.sourcepoint.com)
legislationConfigs	Object	Required	The consent legislations enabled for your implementation with optional configs. For example: {"ccpa": { "targetingParams": {"roku": true} }, "gdpr": {}}
optionalConfigs	Object	Optional	Optional configurations for your implementation which accepts the following keys: -authId -campaignEnv -consentLanguage
authId	String	Optional	Allows your organization to share an end-user's consent preferences across their different authenticated (i.e. logged-in) devices. Click here to learn more. Note: Included in your optionalConfigs argument.
campaignEnv	"prod" | "stage"	Optional	When set to stage, the implementation will default to campaigns configured in your stage campaign environment. This parameter defaults to prod. Note: Included in your optionalConfigs argument.
consentLanguage	String	Optional	Ensure that the purposes or stack names listed in a consent message remain in the same language regardless of an end-user's browser language setting. Click here for a list of ISO 639-1 language codes. Note: Included in your optionalConfigs argument.
showMessage	Boolean	Optional	Decides whether to get and show messages, and retrieve consent immediately. This parameter defaults to true.

Global Privacy Platform (GPP) Multi-State Privacy (MSPS) Support

In order to return GPP Section data in the user's consent, add the includeGPPData key within the legislationConfigs argument of the ccpa object.

The value of this key should be boolean true for default settings, or a JSON string representation of an object with the keys below and the values to set.

If using the default value true for the includeGPPData key, the following MSPA arguments will be set accordingly:

• MspaCoveredTransaction: "no"
• MspaOptOutOptionMode: "na"
• MspaServiceProviderMode: "na"

Example:

m.spSdk = new SourcepointSdk(accountId, propertyHref, {"ccpa": {"includeGPPData": true}, "gdpr": {}}, {}, false)

Optionally, your organization can customize support for the MSPS by configuring the above attributes as part of the GPP config. Click here for more information on each attribute, possible values, and examples for signatories and non-signatories of the MSPA.

Example:

m.spSdk = new SourcepointSdk(accountId, propertyHref, {"ccpa": {"includeGPPData": formatjson({"MspaCoveredTransaction": "yes", "MspaOptOutOptionMode": "yes", "MspaServiceProviderMode": "no"})}, "gdpr": {}}, {}, false)

Retrieve user consent

consent = m.spSdk.getUserConsent()

The first time this is called your configured scenarios will run and determine whether to show a message(s). If your scenarios dictate a message(s) should be shown, this will create a new screen and show those message(s). Once message(s) have been dismissed, the end-users consent will be returned. Each subsequent call to this function will return the same consent object.

If showMessage is true when SourcepointSdk is created this will be called automatically.

Consent will be returned keyed by legislation. See below for keys and values. You can safely ignore top-level keys prefixed with IAB, they are included as part of the IAB standard.

userConsent.ccpa

Key	Data Type	Description
applies	Boolean	True if this user is subject to this legislation based on Vendor List settings.
consents.rejectedCategories	Array	List of category IDs that have been rejected by the user.*
consents.rejectedVendors	Array	List of vendor IDs that have been rejected by the user.*
consents.status	String	The user's consent status. Possible values are: consentedAll, rejectedAll, rejectedSome, rejectedNone
consents.uspstring	String	The user's IAB US Privacy string

• These lists will always be empty in our current implementation because categories and vendors are not individually toggleable.

userConsent.gdpr

Key	Data Type	Description
applies	Boolean	True if this user is subject to this legislation based on Vendor List settings.
consents.euconsent	String	The user's IAB TCF consent string
consents.tcfData	Object	Object containing IAB standardized consent keys and values.
consents.vendorGrants	Object	An object containing information about which vendors are consented to. Keyed by vendor ID. See below
consents.uspstring	String	The user's IAB US Privacy string

userConsent.gdpr.vendorGrants

Key	Data Type	Description
purposeGrants	Object<String: Boolean>	An object keyed by purpose ID, true if the user has consented to that purpose
vendorGrant	Boolean	True if the user has consented to this vendor, false otherwise

Clear User consent

m.spSdk.clearUserConsent()

Retrieve SDK errors

errors = m.spSdk.getErrors()

Any errors encountered by the SDK will be reported via this method. Expected possible errors include network errors, or unrecognized JSON schemas.

Open a Privacy Manager

To open a privacy manager you can hardcode the ID of the privacy manager to open by running:

m.spSdk.openPrivacyManager(legislation, privacyManagerId)

The above accepts the following as an argument:

Argument	Data Type	Description
legislation	String	"ccpa" or "gdpr"
privacyManagerId	Integer	The ID of the privacy manager to open.

The above returns the same consent object that m.spSdk.getUserConsent() does, updated with the user's latest choices.

As an alternative to hardcoding a privacyManagerId, you can setup a targeted scenario and call m.spSdk.runCampaignLogic(legislationsEnabled) to show your privacy manager.

For example: m.spSdk.runCampaignLogic({ "gdpr": { "targetingParams": { "showPm": true } } }) to re-run campaign logic for only GDPR, sending specific targetingParams that will trigger a show PM always scenario. (Note: these are example targeting params corresponding to an example scenario).

Developing the SDK

Enable development mode for your Roku device: https://developer.roku.com/en-gb/docs/developer-program/getting-started/developer-setup.md

Install dependencies:

npm install

Run Brighterscript compiler with auto channel reloading:

ROKU_DEV_HOST=[roku device ip] ROKU_DEV_USER=[ device user ] ROKU_DEV_PASSWORD=[roku device password] npm run develop

View debugging output

ROKU_DEV_HOST=[ device ip ] ROKU_DEV_USER=[ device user ] ROKU_DEV_PASSWORD=[ device password ] npm run debug

Testing the SDK

Running tests:

ROKU_DEV_HOST=[ device ip ] ROKU_DEV_USER=[ device user ] ROKU_DEV_PASSWORD=[ device password ] npm run test

Important: please update the propertyHref in test-channel/main.bs to "https://tests.roku.dan.sourcepoint.com"

Note: contents of tests/bin and tests/lib are from https://github.com/rokudev/automated-channel-testing

Releasing the SDK

Compile Brighterscript to Brightscript:

npm run compile

Push the updates.

Create a new release.

Side loading the test channel

Enable developer mode on your roku device - https://blog.roku.com/developer/developer-setup-guide

Upload the test-channel.zip file in the root of this repository to your Roku device