Zephr User Guide

Configure Treasure Data in the Admin Console

2 views 0

To configure Treasure Data in the Admin Console, complete the following steps:

  1. Select the Settings icon (Settings icon), which is located at the top right of all screens
  2. Select Extensions
  3. Select Treasure Data CDP from the Customer Data Platform section

    The Treasure Data CDP screen displays, as illustrated below:

    Treasure Data

  4. Select the Treasure Data API button

    The Treasure Data API screen displays, as illustrated below:

    Treasure Data API

  5. To configure the API for Treasure Data, complete the following steps:

    1. Enter your Treasure Data master key in the Treasure Data Master Key text box

      The master key is used for all allowed operations based on the user’s permission level and access.

      To find your Treasure Data master key in the Treasure Data Console, complete the following steps:

      1. Select My settings
      2. Select API Keys
      3. Select Access Type ‘Master Key’
    2. Enter your Treasure Data write-only key in the Treasure Data Write Only Key text box

      The write only key provides an extra security layer when controlling access to a Treasure Data account using the REST APIs. The user’s Write-only API Key only allows data to be imported to Treasure Data databases that the permissions and access levels associated with the user allow write access. This is useful when providing access to third-parties or when API keys need to be embedded in ingestion libraries, for example for web page integrations.

      To find your Treasure Data master key in the Treasure Data Console, complete the following steps:

      1. Select My settings
      2. Select API Keys
      3. Select Access Type ‘Write-only Key’
    3. Enter the name of the database you want to use in the Treasure Data Database Name text box

      To find a Treasure Data database name in the Treasure Data Console, complete the following steps:

      1. Select Data Workbench
      2. Select Databases
    4. Enter the URL that is used for requests in the Backend User Base URL text box
    5. Enter an array of Treasure Data Profile API tokens in the Audience Tokens text box

      Profile API tokens are generated in Treasure Data, and one or more Segments can be linked to a single token. They are used to query Treasure Data for the Segments for a specific user.

      If the script is injected by Zephr, you can enter values from the Zephr Extension configuration schema; if you are deploying the frontend script as a Zephr Custom UI component, you must add the values to the script manually.

      Note: An example script is provided in the Example Script topic.

      For further information on using Profile API tokens, refer to the Use the API Token to Increase Customer Personalization topic in the Treasure Data documentation.

    6. By default, the Add manually audiences and segments checkbox is not selected. This means that Zephr retrieves all the Audiences and Segments that are defined in Treasure Data

      If you want to configure specific Audiences, and subsets of Segments, select the Add manually audiences and segments checkbox.

    7. If the Add manually audiences and segments checkbox is selected, enter the Audience ID and the IDs of any Segments in that Audience in the Audiences and Segments text box

      For example, to add an Audience with an ID of 280983 and a subset of Segments with IDs of 140948, 149949, and 144665, enter the following:

                {
                  "280983": [
                    "140948",
                    "149949",
                    "144665"
                  ]
                }
                
    8. By default, a timeout of 5000 milliseconds is configured. To change this, update the entry in the Timeout (MS) text box
    9. Select the Done button to save the Treasure Data API configuration and return to the Treasure Data screen. Selecting the Cancel button displays the Treasure Data screen without saving the Treasure Data API configuration
  6. Select the toggles beside each site for which you want to activate the plugin. Alternatively, select the Select All Sites toggle to activate the plugin on all your sites
  7. Select the Save button to save the configuration and activate the Treasure Data extension on the selected sites