When using the Brightcove Player in your app, it is possible to promote the Video Display Advertisement via a feed URL, which is then parsed by the DSP into a JSON format, which is legible to the Applicaster systems.
In order to use the Brightcove API that pulls the data from Brightcove via the Feed URL, it is required to have the following 3 credentials, and one of 3 handlers.
Crendentials -
The vital credentials that must for part of the feed URL, are:
- account_id - Brightcove account id, can be obtained from the VideoCloud console.
- For example:
- For example:
- client_id - can be obtained by following these instructions
- client_secret - can be obtained by following these instructions
All feed urls should contain these parameters as follows:
&client_id=<your client id>&client_secret=<client_secret>&account_id=<account ID>
Handlers -
The Feed URL must contain one of the following handlers, which allow to perform the actual query within the relevant account:
- Playlist - Insert the Playlist ID. The ID can be located below the Playlist name, within the Playlist section /OR/ in the URL of the Playlist, once opened:
Url example: brightcove://fetchData?type=playlist&id=5654175333001&client_id=fb1e489c-aeb3-2dd8-5b56-51dfb4d7031c&client_secret=ByH5ciaSx89748Qu4md2dcCl4IO1UGKlKiuHzebqg-dTDLat_43V6lHVQEY0YAZh-oLer60xsXOPAwgXQ&account_id=5439817827001
- Folder - Insert the Folder ID. The ID can be located in the Header of the Folder selected, within the Playlist section /OR/ in the URL of the Folder, once opened:
Url example: brightcove://fetchData?type=folder&id=5654175333001&client_id=fb1e489c-aeb3-2dd8-5b56-51dfb4d7031c&client_secret=ByH5ciaSx89748Qu4md2dcCl4IO1UGKlKiuHzebqg-dTDLat_43V6lHVQEY0YAZh-oLer60xsXOPAwgXQ&account_id=5439817827001
- Search - It is based Based on the Search API of Brightcove, and contains 4 parameters, as you need to specify what you are searching for. These are the parameters:
- query (Required) - Insert here the actual query (eg: query=comedy)
- item_type - You can specify whether to query for playlists/videos (eg: item_type=playlist)
- limit - Here you can set a limit on the amount of results you want the query to retrieve
- sort_by - There are several options for this parameter. These are vary whether you are conducting a Video Search Vs. a Playlist Search:
- Video Search sort_by fields:
- name
- reference_id
- created_at
- published_at
- updated_at
- schedule.starts_at
- schedule.ends_at
- state
- plays_total
- plays_trailing_week
- Playlist Search sort_by fields:
- name
- updated_at
- Video Search sort_by fields:
The general structure of the Feed would be:
brightcove://fetchData?type=search&item_type=playlists&sort_by=name&client_id=<your client id>&client_secret=<client_secret>&account_id=<account ID>
Url example:
brightcove://fetchData?type=search&item_type=playlists&sort_by=published_at&client_id=fb1e489c-aeb3-2dd8-5b56-51dfb4d7031c&client_secret=ByH5ciaSx89748Qu4md2dcCl4IO1UGKlKiuHzebqg-dTDLat_43V6lHVQEY0YAZh-oLer60xsXOPAwgXQ&account_id=5439817827001
* For more technical details on the Search function, please consult the Github Zapp Pipes DSP Repository, found here or the Brightcove Playback API Search documentation, found here.
Examples of Feed Promotion in the UI Builder
Inserting the Feed in the UI Builder
When promoting the Feed within the UI builder, you will go by the following process:
1) Go to the "Feeds" section in the UI builder and click on "Create New", in order to create a new Feed.
2) In the Popup screen that opens:
- Insert the Feed Name
- Select the Data Type: Scroll down to the "Brightcove Data Source" and select one of the Three options:
- Playlist
- Folder
- Search
For example:
3) Insert the Feed with the Relevant Parameters, starting with a "?" question mark, following this scheme:
?id=<playlist id>&client_id=<your client id>&client_secret <client_secret>&account_id=<account ID>
For example:
?id=5718416512001&client_id=85b52601-796e-4c8a-9f27-cb4a6f9da3ce&client_secret=EpIl_7Jc70KVkpqRxZpD2HfnR7NhMv3bk7NMkzPeoIyQNoWHd3e1LsXvuZ0OQq2hQcdqPDnN9gJYM06RedgOog&account_id=5675788000001
This Example Feed, after passing through the Brightcove DSP, will be parsed to the following output, that the Applicaster UI Builder can read:
Custom Fields (appearing as Feed Extensions)
For information on the Custom Fields that can be configured in the Brightcove feeds and be parsed via the Brightcove DSP plugin into an Output that is valid and legible by the Applicaster Zapp and UI builder, please consult the following documentation here.
Comments
0 comments
Please sign in to leave a comment.