deepLink (editorial-based) | NAGRAVISION Documentation Portal

Colour	Meaning
	Mandatory
	Optional

Elements		Fields/attributes	Type	Required	Description
`cmsData`
	`deepLink`			Optional
		`name`	String	Optional	Deep link name
		`isOriginal`	Boolean	Optional	Indicates whether the content is original or not (that is, typically only available from that content provider).
		`profileIdSet`	String	Optional	Weak references to the IDs of profiles characterising the deep link content. This list is semicolon separated.
		`id`	String	Optional	Either `id` or both `providerId` and `providerResourceId` must be specified.
		`providerId`	String	Optional	Either `id` or both `providerId` and `providerResourceId` must be specified.
		`providerResourceId`	String	Optional	Either `id` or both `providerId` and `providerResourceId` must be specified.
		`resolutions`	String	Optional	The resolution(s) in which the content is available (e.g., HD or UHD).

Elements			Fields/attributes	Required	Sample data	Description
`cmsData`
	`deepLink`
		`contentRef`		Mandatory
			`id`	Optional		Either `id` or both `providerId` and `providerResourceId` must be specified.
			`providerResourceId`	Optional		Either `id` or both `providerId` and `providerResourceId` must be specified.
			`providerId`	Optional		Either `id` or both `providerId` and `providerResourceId` must be specified.
			`type`	Mandatory	`editorialContent`	The type of the linked content. One of: `editorialContent` `contentGroup` `event`

Elements			Fields/attributes	Required	Description
`cmsData`
	`deepLink`
		`period`		Mandatory	The availability period of the deep link content
			`start`	Mandatory	Availability period start date/time in ISO 8601 format
			`end`	Mandatory	Availability period end date/time in ISO 8601 format

Elements			Fields/attributes	Type	Required	Description
`cmsData`
	`deepLink`
		`media`			Optional	Specifies the location of the deep-linked content
			`action`	String	Mandatory	The action the client should take when the user clicks/taps on the deep-linked content. For example: `playmedia` – play back the media directly in the third-party provider's app. `details` – go to the media page of the content in the third-party provider's app.
			`type`	String	Mandatory	The type of device that the deep link is applicable for. This allows you to target different deep links to different device types. Deep links can also be universal (that is, applicable for all device types).
			`url`	URI	Mandatory	The URL of the content/media page in the third-party app

Elements				Fields/attributes	Type	Required	Sample data	Description
`cmsData`
	`deepLink`
		`metadataSet`				Optional		Metadata set
				`locale`	String	Optional	`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"`.
			`metadata`		MetadataType	Optional		Metadata value. Each such element represents a key/value pair, where the name of the key is the value of the `key` attribute and the value is the element's value.
				`key`	String	Optional		The name of the key

Elements

Fields/attributes

Type

Required

Sample data

Description

cmsData

deepLink

params

Optional

{\"key\": \"page\", \"value\": \"movie_details\"}, {\"key\": \"id\", \"value\": \"5JIB4odrBDXw\"}]

Playback parameters. These are passed to the third-party app as part of the URL.

The value is a JSON array of elements in the following format:

{\"key\": \"key_name\", \"value\": \"corresponding_value\"}

Elements			Fields/attributes	Required	Description
`cmsData`
	`deepLink`
		`playbackOptions`		Optional	Playback options
			`currency`	Mandatory	The currency in which `price` is expressed
			`definition`	Optional	Definition (e.g, `HD`)
			`license`	Optional	License
			`price`	Mandatory	The price of the content (for purchase or rental items)