Salesforce Properties Setup

This topic will cover how to set up the properties in Salesforce that will be updated by the Audience Insights Salesforce publish integration.

Overview

This publish integration updates the Contact object in Salesforce. What Audience Insights calls properties are referred to as fields by Salesforce.

The Audience Insights publish integration will send values to Salesforce as custom fields. These custom fields must first be created in Salesforce. Only the fields that exist in Salesforce can be set and updated. This allows customers to limit fields to only ones that they use.

Requirements

  • Salesforce account
  • The Salesforce user must have permissions to edit the Contact object in the Object Manager

Supported fields

Below are the fields supported by the Brightcove integration.

Label

Internal Name

Field Type

Days Since Last Video View

dayssincelastengagement_v1_0_0

Number

Devices Used (Last 3 Months)

devicesusedlastthreemonths_v1_0_0

Single-line text

Email Hash (MD5)

emailhashmd5_v1_0_0

Single-line text

Email Hash (SHA2)

emailhashsha2_v1_0_0

Single-line text

Engagement Status

engagementStatus_v1_0_0

Single-line text

Fan of Series

fanofseries_v1_0_0

Single-line text

Hours Viewed (Last 3 Months)

hoursviewedlastthreemonths_v1_0_0

Number

Involuntary Cancellations

involuntarycancellations_v1_0_0

Number

Is Reconnect

isreconnect_v1_0_0

Single checkbox

Last Video View Date

lastviewdate_v1_0_0

Date picker

Primary Device Used (Last 3 Months)

primarydevicelastthreemonths_v1_0_0

Single-line text

Primary Device Used (Lifetime)

primarydevicelifetime_v1_0_0

Single-line text

Primary Viewing Location (Last 3 Months)

primaryviewinglocationlastthreemonths_v1_0_0

Single-line text

Primary Viewing Location (Lifetime)

primaryviewinglocationlifetime_v1_0_0

Single-line text

Series Sampled

seriessampled_v1_0_0

Single-line text

Customer ID

customerid_v1_0_0

Single-line text

Subscription Channel

channel_v1_0_0

Single-line text

Subscription Currency

unitpricecurrency_v1_0_0

Single-line text

Subscription End Date

activeenddate_v1_0_0

Date picker

Subscription ID

subscriptionid_v1_0_0

Single-line text

Subscriber Lifetime Value

totalpayments_v1_0_0

Number

Subscription Product

productname_v1_0_0

Single-line text

Subscription Special Offer Used

usedspecialoffer_v1_0_0

Single checkbox 

Subscription Start Date

activestartdate_v1_0_0

Date picker

Subscription Trial Start Date

trialstartdate_v1_0_0

Date picker

Subscription Unit

subscriptionunit_v1_0_0

Single-line text

Subscription Unit Price

unitprice_v1_0_0

Number

Subscription Tenure (in Days)

tenure_v1_0_0

Number

Voluntary Cancellations

voluntarycancellations_v1_0_0

Number

Export Context

exportcontext_v1_0_0

Single-line text

Customer Subscription Count

customersubscriptioncount_v1_0_0

Number

Customer Tenure (in Days)

customertenure_v1_0_0

Number

Customer Voluntary Cancellation Count

customervoluntarycancellationcount_v1_0_0

Number

Most Recent Videos

mostrecentvideos_v1_0_0

Single line text

Most Recent Entertaining Videos

mostrecententertainingvideos_v1_0_0

Single line text

First Watched Videos

firstwatchedvideos_v1_0_0

Single line text

Top 3 Genres (Last 3 Months)

genretop3lastthreemonths_v1_0_0

Single line text

Top 3 Genres (Lifetime)

genretop3lifetime_v1_0_0

Single line text

Customer Hours Viewed

customerhoursviewed_v1_0_0

Number

Entertainment Index (Last 3 Months)

entertainmentindexlastthreemonths_v1_0_0

Number

Entertainment Index (Lifetime)

entertainmentindexlifetime_v1_0_0

Number

Segment Ids

segmentids_v1_0_0

Single line text

Segment Names

segmentnames_v1_0_0

Single line text

Create Custom Fields in Salesforce

Object Manager - Contacts

  1. From the Salesforce dashboard, click the gear icon in the top right corner and navigate to the setup page:
    Navigate to Setup
    Navigate to Setup

    This will take you to the setup home page.

  2. There will be a menu on the left hand side of the page. Under the Platform Tools section, expand Objects and Fields, and click on Object Manager:
    Navigate to Object Manager
    Navigate to Object Manager
  3. This will take you to a list of the Objects defined in the account. From this list, select Contact. This will take you to the Contact page of the Object Manager.
  4. Click on Fields and Relationships in the menu on the left hand side:
    Navigate to Fields and RelationshipsThe type should match what is specified in the supported fields document.
    Navigate to Fields and Relationships
  5. This will show a list of fields that have been configured for the Contact Object.

Add a new field

  1. From the Fields and Relationships page, click the New button in the upper right. This will kick off a wizard to set up a new field. (See Supported fields above for the fields that can be configured for Video Cloud reports.)
  2. For this example, we will set up the “Subscription Product” field.
  3. Select a data type for the field:
    Select Data Type
    Select Data Type

    Note: the type should match what is specified in the supported fields table.

  4. For the Subscription Product example, the data type is “Single-line text”. Select the text option and click the Next button.
  5. Enter field details:
    • Enter the field label and name, and optionally a description.
    • The label can be any helpful label the user wants, but the name must exactly match the internal name from the Supported Fields Table. If it does not match, it will not be updated.
    • For the Subscription Product example, the name will be “productname_v1_0_0”
    Field Details
    Field Details
  6. Establish field-level security - Set appropriate access levels for this field. This may vary depending on user requirements, but our recommendation is to make it visible most places:
    Access Control
    Access Control
  7. Add to page layouts - set where the field should appear.
  8. Click Save to finish adding the field.
  9. The new field should be visible in the Fields and Relationships page:
    Sample Field Created
    Sample Field Created

    Note the the field name has a suffix of __c automatically added. That is how Salesforce denotes its custom fields and is expected.