The purpose of this document is to describe how the TVPage platform ingests video content from a data feed on a periodic basis.

Data file ingestion options and scheduling

In order to bulk ingest video content, the TVPage Platform must have access to a data feed file so that it can be ingested. The following methods are available for this process:

  1. Place the file on the TVPage provided FTP/SFTP server.
  2. Make the file available to TVPage via HTTP/HTTPS.

The TVPage Platform will ingest the file from either location. Note that if using option 2, only Basic HTTP Authorization is available, sending custom headers or tokens for authorization purposes is not available.

First you must configure a feed import mapping. From the dropdown in the dashboard in the upper right, select "Feed Mapping". Then click "New Mapping".

Enter a name, select "Video Import" as the mapping type.

You can use this as a mapping reference, but depending on the format of your feed file, this will likely need to be adjusted.

Sample Feed Mapping

{
"type": "UPLOAD",
"delimiter": "TAB",
"mapping": {
"referenceId": 0,
"title": 1,
"description": 2,
"tags": 3,
"url": 4,
"transcriptUrl": 5,
"srt": 6,
"productIds": 7,
"srt_de": 9,
"srt_fr": 8,
"srt_jp": 10,
"thumbnailUrl": 11
}
}

Configuration of this can be done via the Schedule Manager in the management dashboard. From the “Add Schedule” button, select Video Feed Import and complete the form.

  1. Title your video feed import.
  2. Enter the Video Feed URL (can be direct HTTP/HTTPS or via the TVPage FTP/SFTP)
  3. Select a field mapping ("Video Import" type mapping must already exist).
  4. Select a destination video feed for the video content ("Upload" type video feed must already exist).
  5. Select a schedule for import (every X days). Defaults to every 1 day.
  6. If you want your video content to automatically be published, enable "Auto-Publish Imported Video".
  7. Activate the feed import.
  8. If your file contains a header row, enable "Skip first row".
  9. Finally, click “Save” and your video feed schedule is done!

Data file format

The following describes the requirements for the data file format and specific requirements for the data file itself.

Sample File

The format of the file must be TSV -- “Tab” separated values. This reduces the potential for errors/issues when generating or reading the file.

File Data Column Reference:

Column: Reference ID (Field Name: referenceId)

Format: Maximum 40 alpha-numeric characters

Description: A unique ID assigned to a video. This ID must not be duplicated, otherwise it will cause an UPDATE to occur and not the intended INSERT.

Column: Title (Field Name: title)

Format: Maximum 255 characters

Description: The title of the video as you wish it to appear in the platform and on your TVPage video commerce experiences.

Column: Description (Field Name: description)

Format: Maximum 5000 characters

Description: The description of the video as you wish it to appear in the platform and on your TVPage video commerce experiences. Note: Do not supply HTML content in this column as this tends to cause problems with the CSV file format.

Column: Tags (Field Name: tags)

Format: Maximum 255 characters

Description: A set of keywords or tags related to the video.

Column: Asset URL (Field Name: url)

Format: Maximum 1024 characters, must be a valid URL.

Description: This is a direct link to the asset via HTTP/HTTPS URL. The recommended format for this is MP4. Other formats are available, refer to this article for more information.

Note: Currently the Apple ProRes codec is not supported, but support for this is coming soon.

Note: The maximum size of a file that can be imported is 5GB.

Column: Transcript URL (Field Name: transcriptUrl)

Format: Maximum 1024 characters, must be a valid URL.

Description: This is a direct link to the transcript text via HTTP/HTTPS URL.

Column: Closed Caption SRT URL (Field Name: srt)

Format: Maximum 1024 characters, must be a valid URL.

Description: This is a direct link to the closed caption SRT via HTTP/HTTPS URL. Currently only the SRT file format is supported for import.

Additional SRT files can be specified for additional languages using the following column mappings:

srt (default language) - this is the default language you with to use for closed captions

srt_ar (arabic)

srt_ca (catalan)

srt_cs (czech)

srt_da (danish)

srt_nl (dutch)

srt_en (english)

srt_fi (finnish)

srt_fr (french)

srt_de (german)

srt_el (greek)

srt_he (hebrew)

srt_hi (hindi)

srt_hu (hungarian)

srt_is (icelandic)

srt_id (indonesian)

srt_it (italian)

srt_jp (japanese)

srt_ko (korean)

srt_ms (malay)

srt_pl (polish)

srt_pt (portuguese)

srt_pa (punjabi)

srt_ro (romainian)

srt_sr (serbian)

srt_es (spanish)

srt_sv (swedish)

srt_th (thai)

srt_tr (turkey)

srt_uk (ukrainian)

srt_vi (vietnamese)

Column: Products (Field Name: productIds)

Format: Comma separated list.

Description: This is a comma separated list of products (referenceId) that are to be matched to the video.

Custom fields

Sending custom fields as part of the video feed import process can be done and must be initially configured by TVPage. This allows you to provide additional metadata with your video asset beyond the columns specified above.

Processing a video import feed

When our system processes your video import feed, it will iterate through each line in the file and either INSERT or UPDATE the video as appropriate. This effectively allows you to change the content that you send to TVPage automatically without having to manually update information within the dashboard.

The video feed import process can be coordinated with TVPage to ensure an early pickup and ingestion of the data file on a daily, weekly or monthly basis.

If for any reason, the import process fails, this will be logged in the Job Manager within your TVPage account.

Did this answer your question?