Get an OTT syndication
Gets the configuration data for an OTT syndication.
Path parameters
ID of the account
ID of the syndication
Response
The specified syndication.
Id of this syndication
Name of this syndication
The syndication type. Cannot be changed after syndication creation time.
Specifies which OTT asset types to include in the generated feed. If unspecified, all types will be included. Valid values are [movie, series, season, episode].
The filename that should be used for the generated feed results for this syndication, including file extension (i.e. "result.csv", etc...) Should be a flat filename (no paths) using valid zip filename characters. Should not be the same as the filenames used for any other syndications that might have results included in the same job results. If not specified, a unique filename will be generated.
An URL that can be used as the prefix for generated universal link or catalog website locators. Currently only used by syndications of type umcAvailabilityCsv and googleVideoSitemapXml. Typically points to the root of the catalog website.
Whether to write generated feed results to a publicly accessible web location. Generated feed results are always written to a privately stored zip file, but if this property is true the feed results will also be written in unzipped form to a cloud storage location that can be accessed via a public CDN-backed URL. The public URL can be found in the stored job's public_results field.
For public feeds, content type header that the syndication's feed will be served with. If not specified, a default that is specific to the syndication type will be used.
Specifies whether assets should be filtered out of the generated feed based upon the set of permitted and denied locations in the asset's rights object(s). If set, rights objects are considered valid if at least one of the locations in the filter set is allowed by the rights object's permitted_locations set and is not excluded by the rights object's denied_locations set. Assets with no valid rights objects are excluded from the generated feed. For assets included in the feed, valid rights objects can be accessed by the feed template via a filtered_rights array field on the asset. Location filter values should be upper-cased ISO-3166 two-letter country codes (for example, "US").
Valid only for universal syndications. Specifies whether unpublished OTT assets should be included in set of assets used to generate the feed.
Valid only for universal syndications. Specifies whether OTT series and season assets that have no descendant episodes should be included in set of assets used to generate the feed.
Valid only for universal syndications. Specifies whether the CMS videos associated with OTT movie and episode assets should be fetched. If true, the CMS video objects will be available to the feed template in a "video" field for each applicable asset. Setting to true will result in slower feed generation times, only set if CMS video metadata is actually needed.
Valid only for universal syndications that have fetch_videos set to true. Specifies whether the dynamic rendition metadata for fetched CMS videos should also be fetched. If true, the dynamic rendition metadata be available to the feed template in a "video.dynamic_renditions" field for each applicable asset. Setting to true will result in slower feed generation times, only set if CMS dynamic rendition metadata is actually needed.
Valid only for universal syndications that have fetch_videos set to true. Specifies whether the audio track metadata for fetched CMS videos should also be fetched. If true, the audio track metadata be available to the feed template in a "video.audio_tracks" field for each applicable asset. Setting to true will result in slower feed generation times, only set if CMS audio track metadata is actually needed.
Valid only for universal syndications. Specifies whether assets should be filtered out of the generated feed based upon the start_date of the asset's rights object(s). If true, rights objects with start_date values after the current datetime are considered invalid and assets with no valid rights objects are excluded from the generated feed. For assets included in the feed, valid rights objects can be accessed by the feed template via a filtered_rights array field on the asset.
Valid only for universal syndications with the filter_on_start_date attribute set to true. Specifies a positive or negative number of hours to adjust a rights object's start_date by when evaluating the rights object's start date validity. Can be used for example to include assets in the feed that are not yet within their rights validity window but will be transitioning into that window within a specified future timespan.
Valid only for universal syndications. Specifies whether assets should be filtered out of the generated feed based upon the end_date of the asset's rights object(s). If true, rights objects with end_date values before the current datetime are considered invalid and assets with no valid rights objects are excluded from the generated feed. For assets included in the feed, valid rights objects can be accessed by the feed template via a filtered_rights array field on the asset.
Valid only for universal syndications with the filter_on_end_date attribute set to true. Specifies a positive or negative number of hours to adjust a rights object's end_date by when evaluating the rights object's end date validity. Can be used for example to include assets in the feed that have reached the end of their rights validity window within a specified timespan in the past.
Valid only for universal syndications. Specifies whether assets should be filtered out of the generated feed based upon the type of the asset's rights object(s). If set, rights objects with type values not in the specified filter set are considered invalid and assets with no valid rights objects are excluded from the generated feed. For assets included in the feed, valid rights objects can be accessed by the feed template via a filtered_rights array field on the asset.
Valid only for universal syndications. Specifies whether assets should be filtered out of the generated feed based upon the device set in the asset's rights object(s). If set, rights objects with no devices in the specified filter set are considered invalid and assets with no valid rights objects are excluded from the generated feed. For assets included in the feed, valid rights objects can be accessed by the feed template via a filtered_rights array field on the asset.
Valid only for universal syndications. Specifies whether the "assets" object that is accessible from the feed template should be a flat list of all fetched assets or a map of asset submaps keyed by OTT asset type. Each asset submap will contain assets of the specified type keyed by the asset id.