![Metadata Transfer Between Zype CMS and Apps Creator]({"bg": "//theme.zdassets.com/theme_assets/848525/684b33c3f7116e8cd620310d227abe4847035ee7.jpg"})
![Metadata Transfer Between Zype CMS and Apps Creator]({"bg": "//theme.zdassets.com/theme_assets/848525/3302a7ad8ad34d27faa08a325c1ea028d7b69132.png"})
Note: This article refers to the first generation of Apps Creator. For information on the most recent version, see the Introduction to Apps Creator article. |
Overview
This document outlines what metadata transfers from Zype CMS into Apps Creator when using the two platforms together.
Once the Zype MRSS Feed has been ingested into the Apps Creator platform, certain metadata will be synced so you won’t need to worry about adding additional Metadata into the Apps Creator dashboard that carries over from the CMS. For each Video, the MRSS feed will provide the following metadata to the Apps Creator which will be visible within the apps:
- Title
- Description
- Thumbnail
- Closed Caption/Subtitle
- Parental Guideline Rating
- Custom Attributes (Actor, Director)
- Copyright
The MRSS feed will carry several other metadata items, but these will not be visible anywhere in the app’s UI. The following metadata will be passed through and will only affect your app’s backend:
- Video ID
- Published at
- Ad Timings or Cuepoints
In addition to individual video metadata, the Title of the playlist (MRSS Feed) will also carry over, but unlike other fields, you may edit this again in Apps Creator if desired.
Examples of Apps Creator Video Metadata Fields Visible to the End-User
Apps Creator will automatically pull this metadata to be displayed to end users from the Video Fields as entered in the Zype CMS.
Title
The title of the video.
As seen in app:
Description
The description of the video.
As seen in app:
Duration
Length of video. This value will be auto-generated.
As seen in app:
Thumbnail
The image used to represent the video.
As seen in app:
Subtitle (Closed Captions)
The closed captioning of the video.
As seen in app:
Published At
The media copyright year of publication of the video.
As seen in app:
Parental Guidelines Rating
The parental guidelines rating of the video.
As seen in app:
Custom Attributes (Actor, Director)
"actor" and/or "director" should be added as the name for the custom attribute. Please note that this is case sensitive and the Name should be all lower case.
As seen in app:
Transfer of Metadata Fields for Playlists of Videos
The Title and Apps Creator (MAZ MRSS) Feed URL on the details tab of a playlist being edited.
Playlist Fields within Apps Creator
When sending a Playlist from Zype to Apps Creator, you must add a new MRSS feed within the Apps Creator dashboard, and then place the Apps Creator (MAZ) MRSS feed URL in the Feed URL field:
The Title of the Playlist will auto-populate and represent the title for the entire feed, as seen in this example “2021 AKC National Championship by Royal Canin”:
Additional Information for Developers
For those who desire more granular detail, the chart below displays what fields are passed through from Zype’s CMS into Apps Creator according to metadata fields listed by code name.
|
ZYPE METADATA FIELD |
ZYPE CMS FIELD |
APPS CREATOR FIELD |
|
|
Playlist Fields |
Title |
"Title" field on the Edit Playlists page |
"Title" {External Facing} |
|
Playlist Fields |
Description |
"Description" field on the Edit Playlists page |
Ignored |
|
Playlist Fields |
Link |
"MAZ MRSS Feed URL" field on the Edit Playlists page |
"Feed URL" |
|
Video Fields |
guid |
"Video ID" on the Edit Video page |
Not shown, but passed through |
|
Video Fields |
pubDate |
"Published At" field on the Edit Video page If "Published At" field is not available, then the "Created At" field on the Edit Video page will be used |
Ignored |
|
Video Fields |
title |
"Title" field on the Edit Video page |
"Title" |
|
Video Fields |
description |
"Description" field on the Edit Video page If "Description" field is not available, then the "Title" field on the Edit Video page will be used |
"Description" |
|
Video Fields |
keywords |
"Additional Keywords" field on the Edit Video page |
Ignored |
|
Video Fields |
“media:content” |
This is not user provided. |
Not shown, but passed through |
|
Video Fields |
“media:thumbnail” |
Shows the selected thumbnail from the thumbnails tab of the Edit Video page. If there's no thumbnail, nothing is provided. |
"Thumbnail" |
|
Video Fields |
“media:subTitle” |
Shows the subtitles provided on the subtitle tab of the Edit Video page |
"Closed captioning" |
|
Video Fields |
“media:description” |
"Description" field on the Edit Video page |
"Description" |
|
Video Fields |
“media:title” |
"Title" field on the Edit Video page |
"Title" |
|
Video Fields |
“media:copyright” |
The year from the "Published At" field on the edit video page. If this is blank, no year will be shown. |
"Copyright" |
|
Video Fields |
"media:parental_guidelines_rating" |
The Parental Guidelines Rating field on the Edit Video page |
Not shown, but passed through |
|
Video Fields |
cuepoints |
The Ad Timings page of a video |
Not shown, but passed through |
|
Video Fields |
“media:credit role=actor" |
Set "actor" as "Name" under custom attributes on the Edit Video page.Then set whatever value you want for the value. |
"actor" |
|
Video Fields |
“media:credit role=director" |
Set "director" as "Name" under custom attributes on the Edit Video page.Then set whatever value you want for the value. |
"director" |
|
Video Fields |
“media:category” |
Categories that are assigned to video on the Categories tab of the Edit Video page |
Not shown, but passed through |
Additional Information
For more information on how to manage videos and playlists, visit these two articles: