product (technical-based)
Legend
Colour | Meaning |
---|---|
Mandatory for ingest, optional or not used for ION | |
Mandatory for ION, optional for ingest | |
Mandatory for both ingest and ION | |
Optional for ingest and optional or not used for ION |
cmsData - product
Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | |
---|---|---|---|---|---|---|---|---|
cmsData | ||||||||
product | ProductType | Optional | This element defines a product to create/update. | Not used | product | |||
providerId | string | Mandatory | GLOBAL | Unique identification of a parent node | Mandatory | |||
providerResourceId | string | Mandatory | TVOD_LEG_WALLEC2 | Unique resource identification of a parent node | Mandatory | |||
name | string | Mandatory | TVOD_LEG_WALLEC | Name of the product | Mandatory | |||
type | ProductEnumType | Mandatory | transactional | Type of the product, allowed values are subscription and transactional . Attribute is mandatory when used for creation. It cannot be updated. | Mandatory | type |
cmsData - product - metadataSet
Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | |||
---|---|---|---|---|---|---|---|---|---|---|
cmsData | ||||||||||
product | ||||||||||
metadataSet | MetadataSetType | Optional | Metadata editorial The different allowed metadata and their definitions must be defined outside of the scheme. | Not used | EpgDescription | |||||
locale | Mandatory | en_GB | Language/country code in which the metadata set is written. It must conform to ISO-639 and ISO 3166-1. If the metadata set is not localised, the locale must be set to "none" . | Mandatory | ||||||
metadata | MetadataType | Optional | Metadata value | Mandatory | EpgElement | |||||
key="TitleForProduct" | string | Optional | WALL-E | Title for product | Mandatory | privateMetadata | ||||
key="Rating" | string | Optional | Rating | Not used | ||||||
key="CMS4ProductType" | string | Optional | single | Specifies whether it is a CMS4ProductType or not. | Not used |
cmsData - product - period
Elements | Fields/attributes | Type | Required | Sample data | Description | ION | ||
---|---|---|---|---|---|---|---|---|
cmsData | ||||||||
product | ||||||||
period | PeriodWithOptionalStartEndType | Optional | Specifies the start and end date of the product. | Not used | ||||
start | gmtdatetime | Mandatory | 2018-11-20T13:12:27Z | Start date of the product | Mandatory | |||
end | gmtdatetime | Mandatory | 2018-11-20T13:12:27Z | End date of the product | Mandatory |
cmsData - product - nominalPrice
Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | ||
---|---|---|---|---|---|---|---|---|---|
cmsData | |||||||||
product |
| ||||||||
nominalPrice | Optional | The nominal price of the product including a currency and an amount of money expressed in that currency. The nominal price is optional, but if present both currency and amount are required. | Mandatory | price | |||||
amount | decimal | Mandatory | 100 | The base amount of money to pay to get access to the content sold by this product | Mandatory | value | |||
currency | string | Mandatory | EUR | The currency in which the price is defined for this product. It is a free string but it is recommended to use the ISO 4217 currency code. | Mandatory | currency |
cmsData - product - purchasablePeriod
Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | ||
---|---|---|---|---|---|---|---|---|---|
cmsData | |||||||||
product | |||||||||
purchasablePeriod | PeriodWithOptionalStartEndType | Optional | The period of time during which the product can be purchased by the end user. If the purchase period is not provided, the system will assume the product can be purchased without a time restriction. If the purchase start is not provided, the system will assume the product can be purchased without a start time restriction. If the purchase end is not provided, the system will assume the product can be purchased without an end time restriction. | Not used | |||||
start | gmtdatetime | Mandatory | 2018-11-20T13:12:27Z | Start date of the product purchase | Mandatory | startPurchase , price.startPurchase | |||
end | gmtdatetime | Mandatory | 2018-11-20T13:12:27Z | End date of the product purchase | Mandatory | endPurchase , price.endPurchase |
cmsData - product - rights
Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | ||
---|---|---|---|---|---|---|---|---|---|
cmsData | |||||||||
product | |||||||||
rights | Optional | The rights that could apply to consume this offer | Not used | ||||||
impulsive | boolean | Mandatory | true | If true, the product can be purchased by the end user through the client application or can be entitled by the operator. If false, the product can only be entitled by the operator. If the value is not provided, every system will assume the value as false. | Optional | impulsive | |||
rentalDuration | duration | Mandatory | PT5400S | The amount of time during which the content sold by this product can be accessed after the start of the licence (the start can be at purchase time in absolute mode or at first viewing time in relative mode). This applies only for transactional products. The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. Must be positive. | Optional | rentalDuration | |||
consumptionWindow | duration | Mandatory | P3Y6M4DT12H30M5S | The amount of time after purchase during which initial access to the content sold by this product can be attempted, then the rentalDuration applies. When set, this indicates Relative Mode usage rule calculations should apply. The field value indicates the range within which a relative product viewing can commence. A licence calculation agent determines the final end time of product viewing based on rental duration and its own configuration. When this value is omitted, it means absolute mode. This applies only for transactional products. The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. Must be positive. | Optional | consumptionWindow |
cmsData - product - billingModel
Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | ||
---|---|---|---|---|---|---|---|---|---|
cmsData | |||||||||
product | |||||||||
| Optional | The billing model that applies for subscription products. This element is ignored for other types. | Not used | ||||||
billingPeriod | Mandatory | The amount of time between two billings. The format is based on ISO 8601 with restricted allowed pattern: PnY or PnM or PnD (but not a mix). Must be positive. | Mandatory | billingPeriod |