The deepLink element represents a deeplink, that is, content that is played back through third-party applications. Its structure is shown in the following diagram:
Elements and attributes
| deepLink | |||
|---|---|---|---|
| XML Element | Type | Required | Description |
| Attribute: id | string | Optional | |
| Attribute: name | string | Required | Working name of the resource (used usually to identify a resource in the operator UI) |
| Attribute: profileIdSet | anySimpleType | Optional | Weak references to the ids of profiles characterizing the technical channel. This list is semicolon separated. If "profileId" and "profileIds" both present "profileIds" will be considered, as "profileId" is going to be deprecated |
| Attribute: resolutions | anySimpleType | Optional | |
| Attribute: isOriginal | anySimpleType | Optional | |
| Attribute: providerId | string | Required | id of the content provider |
| Attribute: providerResourceId | string | Required | id of the resource for this specific content provider |
| contentRef | [DeepLinkContentReferenceType]
|
Required | <dl><dt>id</dt><dd></dd><dt>type</dt><dd>Allows to specify the kind of resource that a content group is linked to (allowed values: editorialContent,contentGroup and event)</dd><dt>providerId</dt><dd>id of the content provider</dd><dt>providerResourceId</dt><dd>id of the resource for this specific content provider</dd></dl> |
| period | [PeriodWithOptionalStartEndType]
|
Optional | This period allow to specify the start and end date of the Content Group<dl><dt>start</dt><dd>Start date of the parent resource. A ISO 8601 compatible gmt datetime up to the second : yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against start will be true</dd><dt>end</dt><dd>End date of the parent resource. A ISO 8601 compatible gmt datetime up to the second: yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against end will be true.</dd></dl> |
| media | [DeepLinkUrlType]
|
Required | <dl><dt>type</dt><dd></dd><dt>action</dt><dd></dd><dt>url</dt><dd></dd></dl> |
| metadataSet | [MetadataSetType]
|
Optional | This element defines a specific set of metadata for a specific locale. Only one MetadataSet per locale is allowed. <dl><dt>locale</dt><dd>Language-country code in which the metadata set is written. It must be conformed to ISO-639 and ISO 3166-1. If the MetadataSet is not localised, the locale must be set to "none".</dd></dl> |
| MetadataSetType / metadata | [MetadataType]
|
Optional | Metadata editorial or not of the metadata owner. The different metadata allowed and their definition must be defined outside of the scheme<dl><dt>key</dt><dd>Metadata key. it must be unique for a specific resource and for a specific locale.</dd></dl> |
| playbackParams | string
|
Optional | |
| playbackOptions | [PlaybackOptionType]
|
Optional | <dl><dt>price</dt><dd></dd><dt>definition</dt><dd></dd><dt>currency</dt><dd></dd><dt>license</dt><dd></dd></dl> |
Complex child elements
The following complex child elements are described in their own pages: