Skip to main content
Skip table of contents

LiveRamp Data Onboarding

The following channel-specific fields are shown for LiveRamp Data Onboarding channels:

  • Service Credentials section, containing:

    • API base URL: this mandatory text property is set to the value 'https://api.liveramp.com' by default. It accepts a maximum of 100 characters. It represents the base URL used to connect to the LiveRamp Distribution API.

    • API key: this mandatory, password-masked field accepts a maximum of 100 characters and is used when connecting to the LiveRamp Distribution API.

    • File type: this dropdown property exposes the following values:

      • US PII (the default)

      • EU PII

    • The property determines the file format to be used when generating export files using the channel. The export template provided must be appropriate for the selected file type.

    • Export template: you must select an export template to use at the channel. The template defines the attributes and format of the exported data. You can populate the property by browsing for an export template, or by using drag and drop. Having selected an export template, you can open its latest version in the Export Template Designer. You can also clear your selection.
      The export template provided must be suitable for use with the channel's selected File type. The following header row values are supported when File type is set to 'US PII'

      • CCID

      • FIRSTNAME

      • LASTNAME

      • ADDRESS1

      • ADDRESS2

      • CITY

      • STATE

      • ZIP

      • ZIP4

      • EMAIL1

      • EMAIL2

      • EMAIL3

      • PHONE1

      • PHONE2

    • The following header row values are supported when File type is set to 'EU PII'

      • CustomerID

      • FIRSTNAME

      • LASTNAME

      • ADDRESS1

      • ADDRESS2

      • ADDRESS3

      • ADDRESS4

      • TOWN

      • COUNTY

      • POSTCODE

      • EMAIL1

      • EMAIL2

      • EMAIL3

      • MOBILE1

      • MOBILE2

      • LANDLINE1

      • MD5EMAIL1

      • MD5EMAIL2

      • MD5EMAIL3

      • SHA1EMAIL1

      • SHA1EMAIL2

      • SHA1EMAIL3

      • SHA256EMAIL1

      • SHA256EMAIL2

      • SHA256EMAIL3

  • SFTP Credentials section, containing:

    • SFTP server host address: this mandatory text field can be a maximum of 100 characters in length and is used to specify the LiveRamp SFTP server's host address.

    • SFTP username: this mandatory text field can be a maximum of 100 characters in length, and is used to specify the user name used to connect to the LiveRamp SFTP server.

    • SFTP password: this password-masked text field can be a maximum of 100 characters in length and is used in conjunction with SFTP username when connecting to the LiveRamp SFTP server.

    • SFTP folder path: this mandatory text field can be a maximum of 1000 characters in length and is used to specify the folder path to which LiveRamp onboarding files will be uploaded.

    • Export Settings section: for further information on properties in this section, please see the Data Extract channel documentation. The section exposes the following properties:

      • Extract file name format: provision of a format for the names of files generated when offers are executed through this channel type is mandatory.

      • Allow duplicates on resolution: a checkbox, unchecked by default.

    • Encryption Options: this section contains the following:

      • Use PGP encryption: this checkbox allows you to specify that extract files generated using the channel will be encrypted using a public key. It is unchecked by default. Checking it displays the Public key file property.
        When PGP encryption is configured at a data extract channel, full export files generated using the channel are encrypted. Sample and summary files are not encrypted. PGP encryption is also applied when files are generated in Test mode, and when file compression is enabled.

      • Public key file: this property is shown when Use PGP encryption is checked. It is mandatory when displayed. It allows you to select a public key file to be used by the channel's PGP encryption. You can browse the Windows file system for a public key file. Having selected a public key file, you can clear your selection.

  • The following properties are exposed at the Advanced tab:

    • Enable trace: if checked, API requests and responses will be logged at offer execution using the channel.
      Note the following message, displayed when the property is checked:
      API call max. re-try: this integer property defaults to 10, and accepts a range of values from 5 to 60. It represents the number of retry attempts to be undertaken if a call to the provider's API fails.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.