launch_video

Launch a user's uploaded video to a supported video site.
NOTE: Title, tags, description and category are requested again in case the video has been edited since the first upload.

Explorer

Explore this method

Request URL

http://api.tubemogul.com/api/v3/

HTTP method

GET or POST

Arguments

NOTE: Unless otherwise denoted, strings are limited to 256 UTF-8 encoded characters.

upload_id (integer) - Required

The ID of the uploaded video. This value is returned by list_uploads and upload_video.

title (string) - Required

The title of the video.

tags (comma-delimited string) - Required

The tags of the video.

description (string) - Required

The description of the video. (3000 character limit.)

category (integer) - Required

The category ID of the video. The available values are returned by list_categories.

site_id (integer) - Required

The ID of the video site to upload to. The available values are returned by list_available_sites.

Example Response

Note that the response status here indicates only the success or failure of sending the launch command. To see the actual status of the launch to the video site, call the getVideoStatus method.

<?xml version="1.0" encoding="utf-8" ?>
<response stat="ok">
  <status>Success</status>
</response>

Error Codes

Standard error codes plus:

10 : One or more required fields are empty

20 : There must be two or more non-identical tags

30 : The category ID is invalid

40 : Invalid siteid (no credentials, not enabled or already launched)

50 : Uploadid is invalid or does not belong to the user

60 : The video duration is too long for the requested video site

70 : Must apply for locked video sites; see http://www.tubemogul.com/tiering

80 : The user has reached their monthly video deployments limit

Example Code

<?
# Your user token
$user_token = '';

# Your partner ID
$partner_id = '';

# Your secret key
$secret_key = '';

# Required uploadid
$upload_id = '';

$method = 'launchVideo';

$now = time();

$apihost = 'http://api-upload.tubemogul.com/index.php';

$title = 'Sample Title';

$tags = 'some, sample, tags';

$description = 'And a sample description.';

#
# valid values come from listCategories
#
$category = '';

#
# valid values come from listAvailableSites
#
$site_id = '';

$poststring = "date=".$now.
              "&userToken=".urlencode($user_token).
              "&partnerID=".urlencode($partner_id).
              "&uploadid=".$upload_id.
              "&title=".urlencode($title).
              "&tags=".urlencode($tags).
              "&description=".urlencode($description).
              "&category=".$category.
              "&siteid=".$site_id.
              "&method=".$method;

$hash = sha1($secret_key.$poststring);

$poststring .= "&hash=".$hash;

echo $poststring;
?>

<br /><br />
<form action='<? echo $apihost; ?>' method='post'>
<input type='hidden' name='date' value='<? echo $now; ?>' />
<input type='hidden' name='userToken' value='<? echo $user_token; ?>' />
<input type='hidden' name='partnerID' value='<? echo $partner_id; ?>' />
<input type='hidden' name='uploadid' value='<? echo $upload_id; ?>' />
<input type='hidden' name='title' value='<? echo $title; ?>' />
<input type='hidden' name='tags' value='<? echo $tags; ?>' />
<input type='hidden' name='description' value='<? echo $description; ?>' />
<input type='hidden' name='category' value='<? echo $category; ?>' />
<input type='hidden' name='siteid' value='<? echo $site_id; ?>' />
<input type='hidden' name='method' value='<? echo $method; ?>' />
<input type='hidden' name='hash' value='<? echo $hash; ?>' />
<input type='submit' value='submit!' />
</form>