Android SDK version 2.1.9

Integrating the Oracle CX Advertising SDK (formally known as the Oracle Data Cloud platform) into your native and hybrid apps enables you to extract mobile user attributes from your screens (product page visits, purchase intent signals, add-to-cart actions, and conversions), and transfer them into the Oracle CX Advertising platform.

To import your mobile app data into the Oracle CX Advertising platform, add the Oracle CX Advertising SDK to the screens in your mobile app, pass phints (key-value pairs representing user attributes) to the platform, and create rules to map the phints into categories in your taxonomy.

To integrate the Android SDK in your apps:

  1. Get a site ID.
  2. Scope your data.
  3. Integrate the Android SDK.
  4. Classify your data.
  5. Monitor data ingest.

Note: This topic discusses working with the Android SDK version 2.1.9. To use the latest version of the SDK, see Oracle CX Advertising Android SDK and review the changelog.

Getting a site ID

To instantiate the Oracle CX Advertising platform SDK in your mobile app, you need a site ID. The site ID is used to manage your data in the Oracle CX Advertising platform. Classification rules use the site ID to identify into which categories to map user attributes. You generate a site ID by creating a container. You can create containers in the UI or with the containers API. It is a good practice to create separate site IDs for testing and for production environments.

After you create the container, open a Oracle Support ticket requesting "Direct Ingest Access for ADID" and include your partner name, partner ID, and the site ID.

To onboard data for user profiles located in the European Union (EU), you must have signed Oracle's General Data Protection Regulation (GDPR) Consent agreement. If you have not signed the agreement, you can only create containers that are configured for non-EU countries. This means that a blacklist must include the EU region or countries and a whitelist may not. If you attempt to create a container with an invalid configuration, the UI or API displays an error. By default, new containers blacklist the EU. Contact your Oracle Account Representative to obtain and sign the GDPR Consent agreement.

Scoping data

Identify the user attributes you want to extract from your mobile app and transfer to the Oracle CX Advertising platform. For example, if your app includes a screen about toasters, you could pass a toaster attribute to the platform when users visit that screen. If you purchased consulting services, your solutions consultant can work with you on scoping your mobile app and designing a data collection strategy.

Integrating the Android SDK

To begin collecting page-level and user data from your mobile apps and transferring it into the Oracle CX Advertising platform, you need to install and implement the Oracle CX Advertising SDK. After you implement the SDK, you must re-release your app via the app store.

To install the Android SDK:

  1. Download version 2.1.9 of the Android SDK.
  2. Follow the instructions included in the readme file within the SDK package.

Note: This topic discusses working with the Android SDK version 2.1.9. To use the latest version of the SDK, see Oracle CX Advertising Android SDK and review the changelog.

Classifying data

After you have integrated the Android SDK into your app, classification rules need to be written to map the page and user attributes you are extracting from your mobile app to categories in the Oracle CX Advertising platform (a category is a collection of users that have the same attribute). purchase =, then the add the user to the toaster category).
Classification rules can be written using one of the following three methods:

  • Self-classification tools: Use the Self Classification tools in the Oracle CX Advertising platform UI to manually create the data mapping rules and categories.
  • category and rule APIs: Programmatically create the data mapping rules and categories.
  • Classification via the Oracle CX Advertising platforms classification and taxonomy team: You will create a data map that will enable the platform to create classification rules that map your phints to categories in your taxonomy. Your data map must include the following information:
    • The set of keys used in your phints.
    • The possible set of values for each key, and associate them with human readable category names, if necessary.
    • The hierarchical relationships, if any, between a set of keys.

    For example, consider an auto shopping site that collects the makes and models of cars for which users have demonstrated intent to purchase. The key-value pair for the make node would have the following syntax: MA100=[VALUE]. The example key-value pairs for this node could be as follows:

    • MA100=Honda
    • MA100=Acura
    • MA100=Toyota

    The key-value pair for the model node would have the following syntax: MA110=[VALUE]. Based on the previous example make nodes, example key-value pairs for the model node could be as follows:

    • MA110=Accord
    • MA110=Civic
    • MA110=TL
    • MA110=TSX
    • MA110=Corolla
    • MA110=Camry

    If the values for the makes were encoded (for example, you pass 23098, 21409, 57983 instead of Honda, Acura, and Toyota), the platform would need human readable category names for these encoded values. For example, the following translations could be used:

    • MA100=23098 > Honda
    • MA100=21409 > Acura
    • MA100=57983 > Toyota

    The following data map could then be created for this site:

    Key

    Key translation

    Value

    Value translation (category name)

    MA100

    Make

    Honda

    Honda

    MA100

    Make

    21409

    Acura

    MA100

    Make

    57983

    Toyota

    MA110

    Make > Model

    Accord

    Honda > Accord

    MA110

    Make > Model

    89065

    Honda > Civic

    MA110

    Make > Model

    TL

    Acura > TL

    MA110

    Make > Model

    TSX

    Acura>TSX

    MA110

    Make > Model

    Corolla

    Toyota > Corolla

    MA110

    Make > Model

    Camry

    Toyota > Camry

When you are done creating your data map, send it to your Oracle CX Advertising Partner Manager.

Monitoring data ingest

After your app begins transferring data into the Oracle CX Advertising platform, you should verify that your data is being collected and classified correctly and that your app is generating the expected amount of inventory.

To monitor your data ingest:

  1. Check if your mobile app is calling the platform. Use the site hits report in the platform to verify that your app is sending calls.
  2. Check if your inventory is growing. Use the inventory trend report to verify that the amount of inventory per category is increasing daily.
  3. Check your 30-day inventory. Use the Audience Builder in the Oracle Data Cloud platform to view the estimated number of unique users in your categories based on current configurations.

You can also use the categories API to programmatically check your inventory of your unique users.