Campaign Fields and Data Definitions
Brightcove Campaign will deliver a set of video viewing data to specific fields in your integrated platform. Below is an example of those fields and a description of what the data is that will populate each field
Standard fields
These fields will always be populated by Brightcove Campaign.
| Field | Description |
|---|---|
| video_id | The ID of the Brightcove video associated with the viewing event |
| video_name | The name of the video in Video Cloud |
| tracking_id | You can add a custom tracking ID to a URL |
| external_id | The Global User ID (GUID) used to identify the user |
| player_id | The ID of the Brightcove Player that created the view event |
| page_url | The URL of the page where the video was viewed |
| watched | Percent watched - How far down the timeline they watched |
| time_watched | Seconds of the video watched - The total amount of time they actually spent with that video |
| created_at | Creation date |
| updated_at | Last updated date |
| is_synced | A boolean denoting whether or not the view event has been synchronized to the third party platform. |
Additional fields
These fields are not automatically populated. They are used to track additional custom data. By default, they are configured to capture interactivity from Gallery In-Page experiences. If you are not using interactivity, these fields will be blank.
| Field | Description |
|---|---|
| event_1, event_2, event_3 | Custom events |
| metric_1, metric_2, metric_3 | Custom metrics |
| UTM fields - utmSource, utmMedium, utmCampaign, utmTerm and utmContent | For information on working with UTM fields see Working with UTM Fields in the Campaign Module. |
Optional field tracking
You may want to use this feature if you want to send additional data to a third-party MAP without the use of additional JavaScript to leverage Campaign's client-side API for custom metric tracking.
Once enabled, every event call logged from a Campaign-enabled player will also include the key/value pairs for the video metadata requested.
Important Caveats
- This feature is currently only supported for Eloqua integrations (it's possible that more third-party integrations could be supported in the future)
- This feature can only be used for tracking the following types of metadata:
- Video Reference ID
- A comma-delimited list of video tags
- Video custom metadata fields
- Up to 3 values can be set up for this type of tracking
- Once this setup has been completed, Brightcove is unable to remove or modify the custom objects sent to your third-party MAP. In other words, this is a one-time set-up which cannot be reversed at this time.
- This data will not be available through the Campaign module
- This data will not be available through the Audience API
- This data does appear in exported View Events reports
How to request this feature
To set this up please contact Brightcove Support and request that you'd like to "enable a MAP integration for optional field tracking". Please review the above caveats and include the following in your request:
- Your Brightcove Account ID
- The ID of the Eloqua data integration you'd like to enable this on
- Optional fields are set up on an integration-by-integration basis. Since it's possible to have more than one integration on your account, Brightcove will need to know the ID of the integration it should be enabled on.
- Up to 3 fields you’d like to enable. This must be one or a combination of the following:
- Reference ID
- Tags
- Internal name of an existing video custom metadata field on your account
Once you provide this request to Customer Support, no further work is required on your end to enable this in Eloqua. After Customer Support confirms that the optional fields have been enabled and View Events have been sync'd, you should start to see these additional fields being automatically be added to your BrightcoveVideoView Custom Object in Eloqua.