Add extra metadata to your players with custom attributes

What are custom attributes

Custom attributes are a powerful and flexible way to add additional metadata to a player. They allow you to classify your players in custom and creative ways, giving you massive flexibility to search and sort your content with your API-connected tools. 

Custom attributes are also pushed automatically into integrated Marketing Automation Platforms, including Hubspot, Marketo, Oracle Eloqua, and Salesforce.

Custom attributes give you complete control over defining any metadata for your player (or video content) that's important to your video strategy. For example, you can use custom attributes to organize your players by project, by 'top of funnel' vs 'bottom of funnel' content, by product line, or any other relevant terms. You can set as many custom attributes as you need to your players, meaning each player can be organized into as many sub-categories as you need.

Parts of a custom attribute

To add an attribute you must select an Attribute type, Attribute name, and Value. This is where you define all the specific characteristics of this attribute.

There are 3 fields: Attribute type, a dropdown list; Attribute name, an empty field; and value, also an empty field. 

  • Attribute Type: What type of data the attribute value will be (text, number, list, or flag).
  • Attribute Name: The label, or category for the attribute value.
  • Value: The specific value that is assigned to that player. 

For example, let's say you want to classify a player based on the product line. We could create the following attribute: 

Attribute Type: Text
Attribute Name: Product Line
Value: Widget

This would add a Product Line=Widget custom field to the player metadata.  

However, with custom attributes, you're setting these details specifically so that your API-connected tools can read them (including Marketo), and be able to sort them based on these extra details.

What are custom attributes for?

Custom attributes are a powerful tool that you can use creatively for your own unique purposes. Essentially, they are a tool you can use for different API scenarios to allow your various tools to pull in and segment players based on the custom attribute tags you have set for each player.

You can call custom attributes for anything you build using the Vidyard Dashboard API, and custom attributes are also pushed into integrated Marketo, HubSpot, or Oracle Eloqua accounts.
Note: Vidyard's Dashboard API documentation has a list of attribute endpoints - see Attributes in theDashboard API document


  • With the Marketo or HubSpot integration, you could use custom attributes to create Smart Lists segmented by "Top of Funnel" players, or even by videos selling products in a certain price range.
  • You could set custom attributes based on the content of the videos in your players. Then set up your website's CMS (content management system) to pull players into different pages of your site based on their content. This way, as you update content in Vidyard, your website will dynamically update which players it shows with relevant content. 
  • You could create an integrated enterprise search that crawls through the attributes for advanced metadata.

Where to set custom attributes

Note: Each attribute that you add will be set for this player only. 

From the Content menu click Players.

Hover your cursor over the player and click Settings.
Hovering over a player to click Settings.

Player settings tab has a custom attributes sub-tab.

Attribute Types

Use the attribute type to set the type of value for your attribute. 

The dropdown list for Attribute type has four options: Text, Numbers, Flag, List. 

Here's a breakdown of what the four attribute types are for: 

Attribute TypeWhat is itExample
TextThe attribute value will be text-only

To indicate which campaign this player belongs to
Attribute Name: Campaign Name
Value: Summer Sales

NumberThis attribute value will be numeric-onlyTo indicate the price point of the products shown in this player
Attribute Name: Price Point
Value: 12000
FlagThe value is either true or false. Select ON for true, and OFF for false.

To indicate whether or not this player is gated
Attribute Name: Gated
Value: ON (value is true)

ListThe value is selected from a set list of options. To indicate the stage of the sales funnel for this player
Attribute Name: Funnel stage
Value: Top, Middle, Bottom
(A player can select one option from the list)

Public vs Private attributes

You have the choice between adding public or private attributes to your Vidyard players.

Public attributes 

Public attributes will be accessible through JavaScript to Vidyard player Events, and therefore are publicly available through the page. These are great for any time you want to use metadata from custom attributes to help build out your player event functionality. For example, this allows you to dynamically load content into your player event based on the metadata set in your custom attributes.

Public attributes are available through the Vidyard Dashboard API, and as a JavaScript variable in the player events as CTA.player_public_attributes.

Private attributes

Private custom attributes are available securely through the Dashboard API only. (Learn more below.)

Private Attributes and Public attributes in the Vidyard Dashboard

Add your player attributes

Note: Add your custom attributes to either the Public or Private category according to where you want to be able to access them, and according to the privacy level needed for that information.

Add each attribute that you need to player.

See the sub-headings below for how to add each type of attribute. Click the trash icon to remove one, and you can edit the value from this view. 

Click Save Changes when you've finished setting the attributes. 

In the below example, you would be able to set up your integrated applications to pull in this player when requesting gated players, top of funnel players, players showing products at the $12,000 price point, or players in the Summer Sales campaign.Example of custom attributes on a player

Add a text attribute

  1. Select Text from the Attribute Type dropdown list. 
  2. In the Attribute Name field enter a label for your attribute. For example, "Campaign", or "Campaign Name". 
  3. In the Values field, enter the specific value of this attribute. For example "Summer Sales". 

The Attribute Type is "text", the Attribute Name is "Campaign", and the Value is "Summer Sales".

Add a numeric attribute 

  1. Select Number from the Attribute Type dropdown list. 
  2. In the Attribute Name field enter a label for your attribute. For example, "Price point". 
  3. In the Values field, enter the specific numeric value of this attribute. For example, "12000". 
  4. Click +

The Attribute Type is "number", the Attribute Name is "Price point", and the Value is "12000".

Add a flag attribute

  1. Select Flag from the Attribute Type dropdown list. 
  2. In the Attribute Name field enter a label for your attribute. In this example, the "Gated" attribute will determine whether or not a player is gated with an email. 
  3. In the Values field, turn the switch ON or OFF. "ON" indicates a value of "True", and "OFF" indicates a value of "False". 
  4. Click +.

Add a list attribute

  1. Select List from the Attribute Type dropdown list. 
  2. In the Attribute Name field enter a label for your list. 
  3. In the Values field, click Edit List.
  4. Type each list option into the field and click +
  5. Click which list option will be selected for this player. The selected player will be indicated with a checkmark. 
  6. Click Close when your list is complete.
  7. Click + to add the attribute to this player. 


Making use of your custom attributes

In order to pull custom attribute data into other application, you or your web developer need to use Vidyard's Dashboard API Attribute endpoints to tell your integrated platform where to find this information, and what to do with it. See the the full article on Vidyard's Dashboard API

Here's an example of things you can tell your integration to do with Vidyard's Dashboard API Attribute endpoints:  

  • "Get Top of funnel players"
  • "Get all Gated players"
  • "Get all videos from Summer Sales campaign"
  • "Get all videos about products in the $12,000 range"

Then you (or your web developer) can set up your integrated application to do something specific or interesting with this information. 

For example: 

  • Display all "Top of funnel" players on this web page
  • In Marketo, give a certain score to all leads who have "watched 50% of a video" with the attribute "Funnel: Top"

Was this article helpful?

Can’t find what you’re looking for? Please contact us below.

Email Vidyard Support
Why you didn't like the article?

If you would like Vidyard to get in contact with you regarding your feedback, please enter your email address.

  • No, Thanks