Metadata Controller handles all metadata for a mediacontainer, e.g. container_title, meta_productionCountry, etc.
Metadata can originate from automatic processing (e.g. after uploading an image, IPTC metadata will be extracted from image).
Metadata is multi-lingual.
Reference
Find metadata
Find all metadata for a given mediaContainerId. If the mediaContainerId is a public area then also the metadata for the mediaContainers related to that public area are returned (e.g. the title of videos in the public area which could differ from the “original” title).
Additionally all metadata for this mediacontainer in channels (which could be different from the metadata of the original mediacontainer) are in the response.
Create metadata
Create a new metadate element/entry for a given mediacontainer or channel.
If the metadata already exists, this call works like metadata.update.
If customer has set individualConfiguration.mediaContainer.prettifyContainerName=true metadata with title “container_name” will be prettified (e.g. “IMG_0453_New York” will become “IMG 0453 New York”)
Metadata create can automatically translate from an existing field using translate parameter. Azure translation must be enabled for the customer.
Update metadata
Updates an existing metadata entry.
BatchUpdate metadata
Updates (or creates if necessary) metadata for a bunch of mediacontainers.
If the metadata already exists and ignoreConflict is not set, return these values without updating.
If access to one of the mediacontainers is not granted or metadata is not valid, it will be silently ignored.
Returns the jobId to use to fetch the result later (after activities are 100%) *
The following (example) events can occur during the process and will create the describe job result. See Activity.batchResult for details. See column “IgnoreConflict” to see what happens if you send “ignoreConflict = true”.
Event | Result | IgnoreConflict | Notes |
---|---|---|---|
mediaContainerAccessNotGranted | ignored | Access to MediaContainer not granted | |
mediaContainerIsLocked | ignored | MediaContainer is locked | |
notAvailableForPublicAreas | ignored | MediaContainer type and metadata do not match e.g. updating meta_productionCountry for type dropsite | |
name_tooLong | ignored | content length is bigger than maxLength | |
metadataAlreadyExists | conflict | overwrite | Metadata already exists |
updatingMetadataFailed | error | Technical problem updating metadata | |
mediaContainerIsInTrash | error | e.g. MediaContainer is deleted |