The productLink element represents a link between a product and an item (a “marketable”, for example, a content, channel, content group, and so on) that is part of that product. Its structure is shown in the following diagram:
The legacy updateCms4ProductLink element is of the same type (AddProductLinkType) as the productLink element.
Elements and attributes
| productLink | |||
|---|---|---|---|
| XML Element | Type | Required | Description |
| Attribute: published | boolean | Optional | This element allows the Operator to make a decision to publish (or display) respective resources to end user. |
| productRef | [BaseResourceType]
|
Required | Reference to the linked product<dl><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> |
| marketableRef | [MarketableResourceType]
|
Required | Reference to the linked marketable<dl><dt>type</dt><dd>Allows to specify the kind of marketable that a product is linked to (allowed values: EditorialChannel,event,node,EditorialContent)</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> |
| validityPeriodSet |
|
Optional | Set of periods during which the marketable sold by the specified product is authorised to be played. If no validityPeriod are set, the authorisation is based on the validity period of the marketable sold by the specified product. |
| validityPeriod | [PeriodWithOptionalStartEndType]
|
Optional | Period of time during which the marketable sold by the specified product is authorised to be played. <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> |
| 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> |
Complex child elements
The following complex child elements are described in their own pages: