Syndications

A syndication consists of a list of content and a destination to which you want to
syndicate the content.

Description

The feed type determines which streams will be used in the syndication (e.g. an mp4 stream or
a source file stream) and the output format (e.g. plain MRSS, or sending the files to YouTube).
Ooyala currently supports the following content destinations:

Syndication Type Description
3GP feed three_gp MRSS feed containing URLs to 3GP container files
Advanced feed advanced TubeMogul's extension to MRSS
Boxee feed boxee Feed formatted according to Boxee's extension to MRSS
Google feed google Google Sitemap feed
MP4 feed mp4 MRSS feed containing URLs to the MP4 container file
Player feed feed MRSS feed containing player embed snippets
Podcast (iTunes) itunes Feed formatted according to iTunes extension to MRSS
Roku feed roku Roku compatible MRSS feed
Source source MRSS feed containing URLs to the source file.
Universal universal Feed using the Universal Syndication Template Language
YouTube youtube Syndication that pushes assets and their metadata to YouTube
iPad Adaptive Bitrate feed ipad_abr iPad (Adaptive Bitrate) compatible Feed
iPad Feed ipad iPad compatible MRSS feed
iPhone Adaptive Bitrate feed iphone_abr iPhone (Adaptive Bitrate) compatible MRSS feed
iPhone feed iphone iPhone compatible MRSS feed

Syndicatable asset types

Any type of asset except audio assets can be syndicated
via universal syndication and the API requests described here.

Add New Syndication

To add a new syndication, you specify the name and type parameters:

[POST] /v2/syndications 
{
  properties 
}   
   

List Syndications

To list all the syndications in your account:

[GET] /v2/syndications
   

Get Syndication

To get a syndication:

[GET] /v2/syndications/syndication_id
   

Upload a USTL Template

To upload a USTL template to an advanced syndication, you include the template in the body of
the request:

[PUT] /v2/syndications/syndication_id/template
<template>
   

Turn on Access Keys

To turn on access keys for a syndication, use a PATCH request to set "require_access_key" to
"true" for the syndication.

[PATCH] /v2/syndications/syndication_id
{ "require_access_key": true}    
Note: If "require_access_key" is set to true, navigating to the feed's syndication_url will no
longer work. To access the feed, an "access_key=..." query string parameter must be added to
the syndication_url, e.g.:
http://api.ooyala.com/v2/syndications/syndication_id/feed?
pcode=yourPcode&access_key=accessKey

Create Access Key for a Syndication

To create an access key for a syndication:

[POST] /v2/syndications/syndication_id/access_keys
{
  "name": "yourAccessKeyName"
}    

List Access Keys

To list the access key associated with a syndication:

  [GET] /v2/syndications/syndication_id/access_keys

Remove an Access Key

To remove an access key from a syndication:

  [DELETE] /v2/syndications/syndication_id/access_keysaccess_key

Route Attributes

The following table describes all attributes that can be expressed through the route.

Route Attribute Description
access_key

The ID of the access key. To get a list of access keys associated with a syndication,
perform a get against the /syndications/syndication_id/access_keys route.

Type: String

Default: None

Example: /syndications/syndication_id/access_keys/12345678-abcd-abcd-12ab-12345678

syndication_id

The ID of the syndication. To get a list of syndications, perform a get against the
/syndications route.

Type: String

Default: None

Example: /syndications/d4fe34fe44ea4e648fd07d4509123254

Syndication URL Parameters

The following table describes all parameters that can be expressed when accessing the URL of
the syndication.

Note: These cannot be specified in the route used to create syndications and modify their
settings.
Parameter Description Required?
limit

The maximum number of results to return. If there are more results than the value you
specify, you can get the next page of results by specifying a page_token.

Type: String

Default: 20

Valid Values: 1-500

Example:
http://api.ooyala.com/v2/syndications/6b6e72dd71bd4fa5/feed?pcode=Y4cG06...

No
paging_token

or

page_token

URL to the next page of results.
Note: If the number of results for a given page is
divisible by the value of limit, the service returns a 404 response.

Type: String

Default: None

Example: [GET]
/v2/syndications?limit=5&page_token=W1siY29sdW1uIiwiMzRTYUun1yJdLFsiaW5kZXgiLDEwXSxbInZhbHVlIiwxXV0=

No
redirect_content

By default, the syndications contain redirect URLs. To get the direct URL, specify
false.

Type: String

Default: true

Example:
http://api.ooyala.com/v2/syndications/6b6e72dd71bd4fa5/feed?pcode=Y4cG06...

No
updated_after

Type: DateTime

Default: Returns all results

Example:
http://api.ooyala.com/v2/syndications/6b6e72dd71bd4fa5/feed?pcode=Y4cG06...

No

Properties

The following table describes all properties that can be associated with a syndication.

Property Description Required?
album_art_url

URL to album art for the content. Apple recommends a 300x300 JPG for best results.

Type: String

Default: None

Example: "http://mywebsite.com/myartwork.jpg"

Syndication Types: Podcast (iTunes)

No
asset_defaults Container element for other settings. No
asset_type

The type of assets to syndicate.

Type: String

Valid Values: video | ad |
remote_asset | live_stream

Default: None

Example: "live_stream"

Syndication Types: All

No
author

The author for content within the syndication.

Type: String

Default: None

Example: "Various"

Syndication Types: Podcast (iTunes)

No
category

The category to which the syndication belongs.

Type: String

Default: None

Example: "comedy"

Syndication Types: Advanced, Podcast (iTunes)

No
description

Description of the syndication.

Type: String

Default: None

Example: "Contains viewer-submitted demo reels."

Syndication Types: Advanced, Boxee, iPhone, iPhone (Adaptive Bitrate), iPad, MP4, Roku,
Source

No
destination_url

Read only. The URL to the syndication.

Type: String

Default: None

Example:
"http://backlot.ooyala.com/syndication/advanced?id=fd25caa0-977e-4dbd-bba..."

Syndication Types: Advanced, Boxee, iPhone, iPhone (Adaptive Bitrate), iPad, MP4, Roku,
Source

No
include_all_content

Specifies whether to syndicate all content associated with the account. When set to
false, Ooyala syndicates content specified by
include_labels.

Type: Boolean

Valid Values: true | false

Default: false

Conditions: Required if no labels are specified in include_labels.

Example: "true"

Syndication Types: All

Conditional
include_labels

Specifies labels to associate with the syndication. Any asset that is assigned to one of
the specified labels is automatically included with this syndication.

Type: Array of Strings

Default: None

Conditions: Required when include_all_content is set to false.

Example: ["/label1", "/label2", "/label3"]

Syndication Types: All

Conditional
keywords

Keywords for the syndication.

Type: Array of Strings

Default: None

Example: ["exciting", "compelling", "insomnia"]

Syndication Types: Podcast (iTunes)

No
name

Name of the syndication.

Type: String

Example: "YouTube Advertising Content"

Syndication Types: All

Parent: syndications

Yes
name

Name of the access key. This property is only needed when you are creating a new access
key.

Type: String

Example: "iPhone Access Key"

Parent: access_keys

Yes (if you are creating an access key)
password

Username for the account.

Type: String

Default: None

Conditions: Required for YouTube syndications.

Example: "myyoutubepassword"

Syndication Types: YouTube

Conditional
private

Indicates privacy for syndication with YouTube and other services. When set to true, the
asset is private.

Type: String

Valid Values: true | false

Default: false

Example: true

No
require_access_key

Specifies if a syndication requires an access key. When set to true, the syndication
requires an access key.

Type: Boolean

Default: false

Example: "require_access_key": true

Parent: access_keys

No
should_create_youtube_videos

Automatically creates YouTube videos added to the syndication.

Type: Boolean

Valid Values: true | false

Default: true

Example: true

Syndication Types: YouTube

No
should_delete_youtube_videos

Automatically deletes YouTube videos when removed from the syndication.

Type: String

Valid Values: true | false

Default: None

Example: true

Syndication Types: YouTube

No
subtitle

The subtitle for the syndication.

Type: String

Default: None

Example: "Full length and unedited"

Syndication Types: Podcast (iTunes)

No
title

Title of the syndication.

Type: String

Default: None

Example: "Best of Homemade Reality TV"

Syndication Types: Advanced, Boxee, iPhone, iPhone (Adaptive Bitrate), iPad, MP4, Roku,
Source

No
type

The type of syndication.

Type: String

Valid Values: Refer to the table at the start of this section.

Default: None

Example: "boxee"

Syndication Types: All

Yes
unrestricted_youtube_account

When set to true, enables you to upload videos longer than 15 minutes.

Type: String

Valid Values: true | false

Default: false

Example: false

Syndication Types: YouTube

Note: Make sure your YouTube account is enabled to allow longer videos. Otherwise, the
syndication might fail. For more information, contact YouTube.
No
username

Username for the account.

Type: String

Default: None

Conditions: Required for YouTube syndications.

Example: "myyoutubeaccount"

Syndication Types: YouTube

Conditional

Examples

This example API gets the syndication with embed code ODUzYWNiZGJiZ?:

[GET] /v2/syndications/ODUzYWNiZGJiZ
    

and returns this response:

{
  "author": null, 
  "category": null, 
  "description": "", 
  "destination_url": "", 
  "id": "ODUzYWNiZGJiZ", 
  "include_all_content": true, 
  "include_labels": [], 
  "keywords": null, 
  "name": "Source MRSS", 
  "should_create_youtube_videos": null, 
  "should_delete_youtube_videos": null, 
  "subtitle": null, 
  "syndication_url": "http://api.ooyala.com/syndications/ODUzYWNiZ/feed", 
  "title": "", 
  "type": "source", 
  "yt_username": null
	}     
    

Sorting Try it

This example modifies a syndication:

[PATCH] /v2/syndications/ODUzYWNiZGJiZ
{
		title: "MY BOLD NEW TITLE", 
		description: "Isn't the new title great?"
}
    
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For
information about using the Scratchpad see:

The Scratchpad

This example deletes a syndication:

[DELETE] /v2/syndications/ODUzYWNiZGJiZ
    

Sorting Try it

This example displays results 11-20 of the ODUzYWNiZGJiZ syndication:

http://api.ooyala.com/v2/syndications/ODUzYWNiZGJiZ/feed?pcode=Y4cG06BlqYMLIjPGy&limit=10
    

This example makes the assets of the 982147856bouiguhwfoihw syndication
public:

[PATCH /v2/syndications/982147856bouiguhwfoihw
{
    "assets_default": {
        "private" : false
}