Create a custom metadata schema for CTAs (Calls to Action) in player

About

Custom metadata allows you to create dynamic Call to Action (CTA) messages in your videos based on an entry’s metadata. This is particularly useful when managing large content libraries where CTAs need to vary depending on the video, ensuring that each CTA is relevant to the specific media entry. By mapping metadata fields to CTA components, you can automate updates, eliminating the need for manual adjustments per video.

Example of metadata CTA in a video portal entry

Step 1: Create a custom metadata schema

Access the Custom Data page

1. Log into your KMC.
2. Click the Settings gear icon at the right of the navigation menu.



The Account page displays.

3. Click the Custom Data tab.



The Custom Data page displays.

Create a custom metadata schema

1. Click Add Custom Schema.



The Add Custom Schema window displays.



2. Complete the following fields:

• Custom Schema Title - Add a title (for example, Metadata CTA)
• Description - optional - Enter a relevant description.
• System name - optional - This field is required if you are uploading content using bulk XML files or if you need access to the schema via the API.
• Apply to - Select Entries.

3. Click + Add Custom Field.

The Add Custom Field window displays.

4. Complete the fields.

• Field Type - Select Text.
• Max No. of Values - Choose Single (default).
• Field Label - Type a name for the first metadata field, for example, ctaTitle.
• Short description - optional
• Description - optional
• Searchable - You might want to make sure the searchable button is enabled, this will allow the metadata to be findable in the search results.
• Required - This makes the field mandatory. The user must fill it out to submit the form.
• Hidden - This hides the field from the registration form. Use this option for fields you're unsure about, allowing you to show or hide them as needed without replacing the form.

5. Click Add to save the custom field.

6. Repeat steps 3 - 5 above for the CTA elements you wish the player to display:

• Title
• Description
• Primary button label
• Primary button URL
• Secondary button label
• Secondary button URL

7. Click Save at the top right to finalize the schema.

Use the following image as a guideline, but feel free to choose different names that fit your needs:

Example configuration

Your new metadata schema displays under the Custom Data tab.

Save the metadata profile ID - you’ll need it when setting up the player.

Step 2: Complete the custom metadata fields for the entry

1. Access the entry details page by clicking the Content tab in the navigation menu.



The Entries page displays by default.

2. Click on the desired entry's title or thumbnail. 



The Metadata tab displays by default.



3. Scroll down to the Metadata CTA section.
4. Complete the fields: 

• Title - Enter the CTA's title  
• Description - Enter the description to display under the CTA title
• Primary button URL- Add the desired URL
• Secondary button URL- Add the second URL
• Primary button label - Enter the text for the button's label
• Secondary button label - Enter the text for the second button's label

The field names in the image below are just examples. Yours will match your metadata schema.

Was this article helpful?

Thank you for your feedback!

Name

Email

Submit your feedback

Thank you! Your comment has been submitted.