In this section we explain what metadata is and the process for creating the schema - the definition of your metadata. We also cover the process of creating and updating metadata.
What is metadata?
Metadata provides a way for you to store additional information, such as product data, with assets. There are three main use cases for metadata:
Improving searchability of assets in Content Hub - product metadata is one example
Providing data to improve front end experiences - we use this to implement Point of Interest (POI)
Providing data to assist automated processes, to identify assets and provide data for scripts to operate on
For example, product information might include colors, original and sale prices and product codes. You could add a field to your metadata called "color" and dynamically build up an Autumn fashion collection by including all the items that had a color of "brown". Metadata could also be used for original and sale prices, allowing you to retrieve the sale price from your inventory system, updating this information in the asset's metadata and displaying this on your site.
Metadata can be retrieved using the Dynamic Media API, as explained on the Dynamic Media playground and shown in the example below.
In order to access metadata it must be provisioned on your account. Any custom schemas need to be enabled as part of the provisioning process, which would then allow customers to retrieve this metadata using the Dynamic Media API.
Metadata can also be displayed, edited and searched for in Content Hub.
The process for defining your metadata schema and subsequently adding metadata to your assets is as follows:
Define your metadata schema. See Defining your metadata for more details.
Once you are sure that the schema contains the information you wish to store with your assets, send the schema definition to your Amplience technical consultant.
The technical consultant will create a metadata schema using your specification and add this to your OnDemand account.
A script will be created to add metadata to assets using this schema. This script will process a file that you supply containing the assets and the metadata to add.
Note: that the metadata schema cannot be modified once it has been added to your account.
To process for adding metadata to assets is explained on the Adding metadata to assets page. A brief summary of the process is as follows:
Upload a pipe ("|") delimited CSV file to a folder at an agreed location (usually the Amplience FTP server). This file specifies which assets to add metadata to the required values.
The metadata CSV file will be processed automatically and metadata will be added to the specified assets. The asset is then published with the new metadata.