support Contact Support | system status System Status
Page Contents

    Backlot and Video Cloud: Video and Playlist Fields

    This topic shows how Ooyala video and playlist data is mapped to the Video Cloud fields when they are imported.

    Ad Set Endpoints

    Video Cloud does not have the concept of an ad_set, but ad set data associated with a video will be migrated to cue_points, and the ad_set_id will be stored in a custom field of that name to allow us to identify videos that were associated with an ad set.

    See Migrating to Video Cloud: Ad Sets for more information on how ad set data is mapped to cuepoints for different ad sources.

    The table below shows what Backlot API ad_sets operations are supported.

    ad_sets Endpoints
    Backlot API Endpoint Method Supported? Notes
    v2/ad_sets GET Yes
    • Video Cloud does not have the concept of ad sets; Some information associated with each ad set is migrated as cuepoint data for the videos the ad set was associated with - see Ad Sets for more information
    POST No
    • Video Cloud does not have the concept of ad sets, so attempting to create an ad set will fail
    v2/ad_sets/{set_id} GET Yes
    • Video Cloud does not have the concept of ad sets; Some information associated with each ad set is migrated as cuepoint data for the videos the ad set was associated with - see Ad Sets for more information
    PATCH Yes
    • This request will update cuepoint data for the relevant videos
    DELETE Yes
    • This request will delete cuepoint data for the relevant videos
    v2/ad_sets/{set_id}ads POST Yes
    • Adds a cuepoint to relevant videos
    DELETE Yes
    • Removes a cuepoint from relevant videos

    Asset Endpoints

    The table below shows what Backlot API asset operations are supported.

    Asset Endpoints
    Backlot API Endpoint Method Supported? Notes
    /v2/assets GET Yes
    • ad type videos will be regular videos in Video Cloud with the tag ooyala_my_ads
    • youtube type videos will not be migrated to Video Cloud
    • external_id is being migrated to Video Cloud, but will be a read-only field available to the Playback API (for Ooyala players delivering Video Cloud content)
    • Recurring time restrictions and IP restrictions are not being migrated to Video Cloud
    POST Yes
    • See Ingestion Using the Backlot API for more details
    • Video Cloud ingestion requires that the chunk_size be 5MB or greater (except for the last chunk) - an error will be returned if the chunk_size is set to lower value
    • Since youtube type videos are not supported in Video Cloud, attempting to create videos of these types will return an error. ad type videos can be created as regular videos having the tag ooyala_my_ads.
    • youtube type videos will not be migrated to Video Cloud
    /v2/assets/{asset_id} GET Yes
    • ad type videos will be regular videos in Video Cloud with the tag ooyala_my_ads
    • youtube type videos will not be migrated to Video Cloud
    POST No
    • Only updating properties via PATCH
    PATCH Yes
    • Only properties that are migrated to Video Cloud can be updated
    DELETE Yes  
    /v2/assets/{asset_id}/ad_set GET Yes
    • Ad sets will be migrated to Video Cloud as cuepoints
    /v2/assets/{asset_id}/closed_captions GET Yes
    • This request will return an HTTP 302 response with the location set to the captions content
    PUT Yes
    • Replace the existing WebVTT text track; note that you can upload WebVTT or DFXP captions - DFXP will be converted to WebVTT
    DELETE Yes  
    /v2/assets/{asset_id}/drm_attributes/{drm_type} GET No
    • DRM in Video Cloud is applied to all videos in a DRM-enabled account unless they are flagged not to be packaged with a drm_disabled field
    PATCH No
    • DRM in Video Cloud is applied to all videos in a DRM-enabled account unless they are flagged not to be packaged with a drm_disabled field
    /v2/assets/{asset_id}/generated_preview_images GET No
    • Video Cloud does not store multiple thumbnail images
    /v2/assets/{asset_id}/labels GET Yes
    • All labels will be migrated to tags, so this request will return the video tags
    POST Yes
    • All labels will be migrated to tags, so this request will add a video tag. Note that updating labels directly in Video Cloud is not supported.
    /v2/assets/{asset_id}/labels/{label_id} PUT Yes
    • This will replace the label (a tag) in Video Cloud. Note that updating labels directly in Video Cloud is not supported.
    DELETE Yes
    • This will delete the label (a tag) in Video Cloud. Note that updating labels directly in Video Cloud is not supported.
    /v2/assets/{asset_id}/metadata GET Yes
    • metadata items will be migrated to tags in the form meta:;:{key}:;:{value}. Note that overall length of each tag is limited to 128 single-byte characters.
    PUT Yes
    • metadata items will be migrated to tags in the form meta:;:{key}:;:{value} - this request will add or replace tags in that format. Note that overall length of each tag is limited to 128 single-byte characters.
    PATCH Yes
    • metadata items will be migrated to tags in the form meta:;:{key}:;:{value} - this request will modify tags in that format
    DELETE Yes
    • metadata items will be migrated to tags in the form meta:;:{key}:;:{value} - this request will delete all tags in that format
    /v2/assets/{asset_id}/movie_urls GET Yes
    • movie_urls are sources in Video Cloud
    POST Yes
    • Works the same way in Video Cloud - this request will add a remote rendition (and therefore source) to the video
    /v2/assets/{asset_id}/movie_urls/{type} DELETE Yes
    • This request delete only remote renditions of the specified type
    /v2/assets/{asset_id}/player GET Yes
    • This request will return the default Ooyala player construct, because Video Cloud does not associate players with videos; instead, any video can be associated with any player instance by its video id. You can get Video Cloud players via the Player Management API
    /v2/assets/{asset_id}/player/{player_id} GET No
    • Video Cloud does not associate players with videos; instead, any video can be associated with any player instance by its video id. You can get Video Cloud players via the Player Management API
    /v2/assets/{asset_id}/preview_image_urls GET Yes
    • Video Cloud does not store multiple thumbnail images, so this request will return the poster image
    POST Yes
    • Video Cloud does not store multiple thumbnail images, so this request will set the poster image using the first image in the list
    PUT Yes
    • Video Cloud does not store multiple thumbnail images, so this request will set the poster image using the first image in the list
    DELETE No
    • Video Cloud stores only a single poster image, and you can replace, but not delete it
    /v2/assets/{asset_id}/preview_image_files/{image_id} DELETE No
    • Video Cloud stores only a single poster image, and you can replace, but not delete it
    /v2/assets/{asset_id}/preview_image_files GET Yes
    • Video Cloud does not store multiple thumbnail images, so this request will return the poster image URL
    POST Yes
    • Video Cloud does not store multiple thumbnail images, so this request will set the poster image using the first image URL in the list as a remote asset
    PUT Yes
    • Video Cloud does not store multiple thumbnail images, so this request will set the poster image using the first image in the list URL in the list as a remote asset
    DELETE No
    • Video Cloud stores only a single poster image, and you can replace, but not delete it
    /v2/assets/{asset_id}/primary_preview_image GET No
    • Video Cloud stores only a single poster image, so this request will return that
    /v2/assets/{asset_id}/publishing_rule GET Yes
    • Only geo-restrictions and scheduling will be returned, because Video Cloud sets other playback restrictions on players rather than videos
    /v2/assets/{asset_id}/publishing_rule/{rule_id} PUT Yes
    • Video Cloud does not have the concept of a publishing rule. Only geo-restrictions and scheduling properties for the video can be updated. The publishing rule id will be stored in a custom field with the name publishing_rule_id
    /v2/assets/{asset_id}/source_file_info GET No  
    /v2/assets/{asset_id}/streams GET Yes
    • Will return Video Cloud sources
    /v2/assets/{asset_id}/uploading_urls GET Yes
    /v2/assets/{asset_id}/upload_status PUT Yes
    /v2/assets/{asset_id}/youtube GET No
    PUT No
    PATCH No
    /v2/assets/{asset_id}/lineup GET No  
    PUT No  
    /v2/assets/lineup/{asset_id} PUT No  
    DELETE No  
    /v2/assets/{asset_id}/closed_captions GET Yes
    • Will return the default text_track for the video. Migrated videos will have only one text_track - additional ones can be added through Video Cloud. If you add more text tracks, set the default one to have it returned for this request.
    PUT Yes
    • Will replace the default text_track for the video - ingested captions can be in WebVTT or DFXP format; DFXP will be converted to WebVTT
    DELETE Yes
    • Will remove the default text_track for the video

    DRM policies

    DRM policies endpoints are not supported.

    Delete Assets endpoint

    The Deleted Asset endpoint is not supported.

    Labels endpoints

    Labels will be migrated to Video Cloud as tags. Unlike labels, tags are set on individual videos - there is no account-level "tag set", and tags are not hierarchical.

    Apart from those differences, tags can be used in many of the ways that labels are, for example:

    • searching for videos that have some, all, or none of a set of tags
    • Selecting videos for a "smart" playlist at runtime

    The table below shows what Backlot API labels endpoints are supported.

    Backlot API Labels Endpoints
    Backlot API Endpoint Method Supported? Notes
    /v2/labels GET Yes Labels will appear as tags in Video Cloud
    /v2/labels POST Yes Labels will appear as tags in Video Cloud
    /v2/labels/by_full_path/{paths} GET Yes Labels will appear as tags in Video Cloud
    /v2/labels/by_full_path/{paths} POST Yes Labels will appear as tags in Video Cloud
    /v2/labels/{label_id} GET Yes Labels will appear as tags in Video Cloud
    /v2/labels/{label_id} PATCH Yes Labels will appear as tags in Video Cloud
    /v2/labels/{label_id} DELETE Yes Labels will appear as tags in Video Cloud
    /v2/labels/{label_id}/children GET Yes Labels will appear as tags in Video Cloud
    /v2/labels/{label_id}/assets GET Yes Labels will appear as tags in Video Cloud

    Packages endpoint

    Packages endpoints are not supported.

    Players endpoints

    The table below shows what Backlot API players operations are supported.

    Backlot API Players endpoints
    Backlot API Endpoint Method Supported? Notes
    /v2/players GET Yes  
    POST No  
    /v2/players/{player_id} GET No  
    PATCH No  
    DELETE No  
    /v2/players/{player_id}/metadata GET No  
    PATCH No  
    PUT No  
    DELETE No  
    /v2/players/{player_id}/scrubber_image PUT No  
    /v2/players/{player_id}/watermark PUT No  
    /v2/players/{player_id}/third_party_modules/{module_id} GET No  
    PUT No  
    PATCH No  
    DELETE No  

    Playlists endpoints

    The table below shows what Backlot API playlists operations are supported.

    Backlot API Playlists Endpoints
    Backlot API Endpoint Method Supported? Notes
    /v2/playlists GET Yes  
    POST Yes  
    /v2/playlists/{playlist_id} GET Yes  
    PUT Yes  
    PATCH Yes  
    DELETE Yes  

    Processing Profiles endpoint

    The table below shows what Backlot API playlists operations are not supported. Also see Ingest Profiles API Managing Ingest Profiles for a better understanding of how Video Cloud ingest profiles work - your account is a Dynamic Delivery account, so you need not pay attention to the documentation on the legacy ingest system.

    Provider-Level DRM Policies endpoints

    Provider-Level DRM Policies endpoints are not supported.

    Providers endpoints

    Providers endpoints are not supported.

    Publishing Rules endpoints

    The playback restrictions implemented through publishing rules are applied to individual assets in Video Cloud. Domain restrictions are not migrated, because in Video Cloud these are set on players, not videos.

    On video assets
    • geo-restrictions
    • scheduling (start and end date-times)

    Ooyala publishing rules properties relating to geo-restrictions and scheduling will be applied to videos associated with the publishing rule, and the id will be stored in a custom field with the name publishing_rule_id. The Backlot API publishing rule operations will work on all videos associated with the publishing rule, but only scheduling or geo-restrictions will be returned.

    Backlot API Processing Profiles Endpoints
    Backlot API Endpoint Method Supported? Notes
    /v2/processing_profiles GET Yes  
    /v2/processing_profiles/{profile_id} GET Yes  

    Resellers endpoints

    Resellers endpoints are not supported.

    Statistics endpoints

    Statistics endpoints are not supported.

    Syndications endpoints

    Syndications endpoints are not supported. However, Brightcove Global Services can build syndication services to match your Ooyala ones. Contact your Account Manager for details.

    Third-Party Modules endpoints

    Statistics endpoints are not supported.


    Page last updated on 28 Sep 2020