Enabling guest entitlements for a channel
Overview
There are several things you must do to enable the guest entitlements feature for an editorial channel:
Add custom
WatchParty
metadata field to the channelAdd the capability to the channel’s
clientControls
These can all be done:
In OpCon
By making an API call
At ingest (XML)
These are explained in detail below.
Enabling guest entitlements for a channel in OpCon
To enable guest entitlements for a channel in OpCon, in Editorial Information for the channel, click EDIT CHANNEL, then:
In, Non-locale Custom Fields:
Find the WatchPartyRef field.
Add the IDs of the guest entitlements capability product(s).
In Capabilities:
Click ADD PROPERTY.
Select WATCHPARTY from the list.
Click SAVE CHANGES.
See Managing Live channels for more information.
Enabling guest entitlements for a channel through an API call
You can enable guest entitlements for a channel through an API call:
When creating the channel
Follow the instructions for creating an editorial channel, ensuring that the relevant fields are set, as explained below.By updating the channel
Refer to the Content and Product Manager (CPM) API documentation: content v1 for thePUT /editorialChannels/{editorialChannelId}
endpoint, ensuring that the relevant fields are set, as explained below.
The following fields must be set correctly on the editorial channel to enable the guest entitlements feature for that channel:
Add a
WatchPartyRef
capability product reference to the"locale": "none"
metadata block. This contains a comma-delimited list of guest entitlement capability products:JSON... "metadataSet": [ { "locale": "none", "metadata": [ { "key": "WatchPartyRef", "value": "<id_of_capability_product>[,...]" }, ... ] } ], ...
Add the
WATCHPARTY
capability to theclientControls
block:JSON... "clientControls": [ { "key": "WATCHPARTY", "value": true }, ... ], ...
Enabling guest entitlements for a channel at ingest
To enable guest entitlements for a channel at ingest, make sure that the following are added to each editorialChannel
for which the feature is to be enabled:
In
cmsData
>editorialChannel
>metadataSet
, add a newmetadata
element (for the “none”locale
):NONE<metadataSet locale="none"> ... <metadata key="WatchPartyRef"> <id_of_capability_product>[,...] </metadata> ... </metadataSet>
In
cmsData
>editorialChannel
>clientControls
, add a new key/value pair, where the key is"WATCHPARTY"
and the value istrue
.