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 will also be pushed automatically into integrated Marketo and HubSpot accounts.
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.
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.
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.
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 and HubSpot accounts.
Note: Vidyard's Dashboard API documentation has a list of attribute endpoints - see Attributes in the Dashboard API document.
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.
Use the attribute type to set the type of value for your attribute.
Here's a breakdown of what the four attribute types are for:
|Attribute Type||What is it||Example|
|Text||The attribute value will be text-only|
To indicate which campaign this player belongs to
|Number||This attribute value will be numeric-only||To indicate the price point of the products shown in this player|
Attribute Name: Price Point
|Flag||The value is either true or false. Select ON for true, and OFF for false.|
To indicate whether or not this player is gated
|List||The 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)
You have the choice between adding public or private attributes to your Vidyard players.
Private custom attributes will available securely through the Dashboard API only. (Learn more below.)
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 for this 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 could 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.
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. You can see the full article on Vidyard's Dashboard API here.
Here's an example of things you can tell your integration to do with Vidyard's Dashboard API Attribute endpoints:
Then you (or your web developer) can set up your integrated application to do something specific or interesting with this information.