共通の出力要素
- コンテンツ要素(contents)
- USERMETA形式
- DATE,DATE形式
- PROCESS_STATUS形式
- encodeconfig
- ケータイ動画・音声のencoding_quality
- 元動画・元音声・元画像のexif情報
コンテンツ要素(contents)
名前(要素名) | 値(要素の内容) |
---|---|
id_contents | コンテンツID |
category | カテゴリー ・ folder : フォルダ・ broadcast : 配信・ video : 動画・ image : 画像・ pdf : PDF |
type | タイプ ・ folder : フォルダ・ video : 動画・ audio : 音声・ image : 画像・ pdf : PDF |
name | コンテンツ名 |
description | コンテンツ説明文 |
folder_name | フォルダ名 |
parent_id_contents | 親フォルダのコンテンツID |
create_date | 投稿日時YYYY-MM-DD HH:II:SS |
image | イメージ画像 ・ type=video : サムネイル画像・ type=audio : カバー画像・ type=image : 画像本体・ type=pdf : 1枚目の画像 |
contents_visible | コンテンツに設定された公開設定 ・ 0 : 非公開・ 1 : 公開 |
id_recipe | エンコード設定のID /settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。 画像などの変換設定が存在しないコンテンツの場合NULLが返ります。 |
process_status | コンテンツ登録ステータス |
video_common_process_status | PC⁄スマホ動画・音声登録ステータスtype=video ,type=audio のみ。未作成時は空。 |
video_keitai_process_status | keitai動画・音声登録ステータスtype=video ,type=audio のみ。未作成時は空。 |
video_youtube_process_status | youtube動画・音声登録ステータスtype=video ,type=audio のみ。未作成時は空。 |
gid | コンテンツユニークID |
usermeta | USERMETA 未指定時は空文字 |
USERMETA形式
名前(要素名) | 値(要素の内容) |
---|---|
usermeta | キー及び値が文字列型である1次元連想配列データ(JSON) |
DATE,DATE形式
名前(要素名) | 値(要素の内容) |
---|---|
visible | YYYY-MM-DD HH:II:SS もしくはYYYY-MM-DD どちらかを省略可能 例) 2011-12-15 ,2011-12-15 16:00:00 => 12/15の0時から16時まで公開。 ,2011-12-15 => 12/15まで公開。2011-12-15, => 12/15から公開。 |
PROCESS_STATUS形式
名前(要素名) | 値(要素の内容) |
---|---|
PROCESS_STATUS | 変換状況 ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
encodeconfig
値 | 要素の内容 |
---|---|
encodeconfig | エンコード設定 |
option | オプション |
secure | 暗号化の有無 ・ 0 : なし・ 1 : 暗号化 |
onetime | ワンタイムの有無 ・ 0 : なし・ 1 : ワンタイム |
rtmp | RTMPでの動画 ・ 0 : なし・ 1 : RTMP(Flash) |
hls | RTMPでの動画 ・ 0 : なし・ 1 : HTTP Live Streaming |
http | 暗号化の有無 ・ 0 : なし・ 1 : HTTP Progressive |
video | 映像設定 |
format | フォーマット |
codec | 映像コーデック |
bitrate | 映像ビットレート |
pixel | 解像度 |
width | 幅 |
height | 高さ |
fps | フレームレート |
audiocodec | 音声コーデック |
audiobitrate | 音声ビットレート |
ケータイ動画・音声のencoding_quality
値 | 要素の内容 |
---|---|
1 |
最高 |
2 |
高 |
3 |
中 |
4 |
低 |
5 |
最低 |
元動画・元音声・元画像のexif情報
値 | 要素の内容 |
---|---|
gps_latitude | 緯度 |
gps_longitude | 経度 |
gps_altitude | 高度 |
create_date/date_time/content_create_date | 作成日時※前方一致になります |
GET
: /contents/get_all_items
概要
全ての動画・音声・画像・PDFを取得
カテゴリ
コンテンツ
入力
クエリ
※limit,filters,order対応
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
contents | コンテンツ |
id_contents | コンテンツID |
category | コンテンツのカテゴリー ・ video : 動画・音声・ broadcast : 配信・ image : 画像・ pdf : PDF |
type | コンテンツのタイプ ・ video : 動画・ audio : 音声・ image : 画像・ pdf : PDF |
name | コンテンツ名 |
description | 説明文 |
folder_name | フォルダー名 |
parent_id_contents | 親フォルダのコンテンツID |
create_date | 投稿日時YYYY-MM-DD HH:II:SS |
gid | コンテンツユニークID |
usermeta | USERMETA ※未指定時は空文字 |
metatag | 設定したmetatag ※未指定時は null |
flag_replace | コンテンツ変換フラグ ・ 0 : 変換済み・ 1 : 変換中 |
disuse_thumbnail | 音声コンテンツのサムネイル ・ 0 : 設定なし・ 1 : 設定済み |
duration | コンテンツの秒数 ※image、pdfは null |
image | イメージ画像 ・ type=video : サムネイル画像・ type=audio : カバー画像・ type=image : 画像本体・ type=pdf : 1枚目の画像 |
original_format | オリジナルのファイルフォーマット |
contents_visible | コンテンツの公開設定 ・ 0 : 非公開・ 1 : 公開 |
process_status | コンテンツ登録ステータス ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_common_process_status | PC⁄スマホ動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_keitai_process_status | keitai動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_youtube_process_status | youtube動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
id_recipe | エンコード設定のID |
ステータス
有効
GET
: /contents/get_folder_layout
概要
全てのフォルダをツリー構造化したデータを取得。
カテゴリ
コンテンツ
入力
クエリ
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
contents | フォルダ(ツリー) |
name | フォルダ名 |
id_contents | フォルダのコンテンツID |
contents | サブフォルダのリスト(ツリー) |
ステータス
有効
POST
: /contents/create_folder
概要
フォルダを作成。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
id_contents (required) | 親フォルダのコンテンツID |
name (required) | フォルダ名 |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
id_contents | 作成したフォルダのコンテンツID |
ステータス
有効
GET
: /contents/get_folder_contents
概要
フォルダに含まれる、全てのコンテンツの情報を取得。
カテゴリ
コンテンツ
入力
※limit,filters,order対応
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
id_contents (required) | 親フォルダのコンテンツID |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
contents | コンテンツ |
id_contents | コンテンツID |
category | コンテンツのカテゴリー ・ video : 動画・音声・ image : 画像・ pdf : PDF・ broadcast : 配信・ folder : フォルダ |
type | コンテンツのタイプ ・ video : 動画・ audio : 音声・ image : 画像・ pdf : PDF・ folder : フォルダ |
name | コンテンツ名 |
description | 説明文 |
folder_name | フォルダー名 |
parent_id_contents | 親フォルダのコンテンツID |
create_date | 投稿日時YYYY-MM-DD HH:II:SS |
gid | コンテンツユニークID |
usermeta | USERMETA ※未指定時は空文字 |
metatag | 設定したmetatag ※未指定時は null |
flag_replace | コンテンツ変換フラグ ・ 0 : 変換済み・ 1 : 変換中 |
disuse_thumbnail | 音声コンテンツのサムネイル ・ 0 : 設定なし・ 1 : 設定済み |
duration | コンテンツの秒数 ※image、pdfは null |
image | イメージ画像 ・ type=video : サムネイル画像・ type=audio : カバー画像・ type=image : 画像本体・ type=pdf : 1枚目の画像 |
original_format | オリジナルのファイルフォーマット |
contents_visible | コンテンツの公開設定 ・ 0 : 非公開・ 1 : 公開 |
process_status | コンテンツ登録ステータス ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_common_process_status | PC⁄スマホ動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_keitai_process_status | keitai動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_youtube_process_status | youtube動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
id_recipe | エンコード設定のID |
ステータス
有効
POST
: /contents/move_contents
概要
コンテンツを別のフォルダへ移動。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
id_contents (required) | 移動させるコンテンツのID |
parent_id_contents (required) | 移動先のフォルダのコンテンツID |
ステータス
有効
POST
: /contents/delete_contents
概要
コンテンツを削除。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
id_contents (required) | 削除するコンテンツのID |
autocommit | 削除後に自動公開処理 ・ 0 : 無効・ 1 : 有効 |
説明
対象がフォルダの場合は、フォルダの中身が空でないと削除に失敗する。
ステータス
有効
GET
: /contents/search_contents
概要
アイテムを検索。
カテゴリ
コンテンツ
入力
※limit,filters,order対応
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
freeword (required) | 検索する文字列 (freeword、usermetaいずれか、または両方を指定) |
usermeta (required) | USERMETA (freeword、usermetaいずれか、または両方を指定) |
type (required) | 検索するコンテンツタイプ ・ video : 動画・ audio : 音声・ image : 画像・ pdf : PDF・ folder : フォルダ |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
contents | コンテンツ |
id_contents | コンテンツID |
category | コンテンツのカテゴリー ・ video : 動画・音声・ image : 画像・ pdf : PDF・ broadcast : 配信・ folder : フォルダ |
type | コンテンツのタイプ ・ video : 動画・ audio : 音声・ image : 画像・ pdf : PDF・ folder : フォルダ |
name | コンテンツ名 |
description | 説明文 |
folder_name | フォルダー名 |
parent_id_contents | 親フォルダのコンテンツID |
create_date | 投稿日時YYYY-MM-DD HH:II:SS |
gid | コンテンツユニークID |
usermeta | USERMETA ※未指定時は空文字 |
metatag | 設定したmetatag ※未指定時は null |
flag_replace | コンテンツ変換フラグ ・ 0 : 変換済み・ 1 : 変換中 |
disuse_thumbnail | 音声コンテンツのサムネイル ・ 0 : 設定なし・ 1 : 設定済み |
duration | コンテンツの秒数 ※image、pdfは null |
image | イメージ画像URL ・ type=video : サムネイル画像・ type=audio : カバー画像・ type=image : 画像本体・ type=pdf : 1枚目の画像 |
original_format | オリジナルのファイルフォーマット |
contents_visible | コンテンツの公開設定 ・ 0 : 非公開・ 1 : 公開 |
process_status | コンテンツ登録ステータス ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_common_process_status | PC⁄スマホ動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_keitai_process_status | keitai動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
video_youtube_process_status | youtube動画・音声登録ステータス (type=video,audioのみ) ・ idle ,processing : 変換中・ done : 変換完了・ failure : 変換失敗・ "" : 未作成 |
id_recipe | エンコード設定のID |
ステータス
有効
POST
: /contents/create_video
概要
動画・音声を登録。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
filekey (required) | 登録する動画・音声のファイルキー |
name | コンテンツ名ー |
type | コンテンツタイプ ・ video : 動画(省略可)・ audio : 音声音声ファイルを登録する場合はtype=audioを指定する必要がある。 |
disuse_thumbnail | 音声コンテンツのサムネイル設定 ・ 0 : サムネイル有り変換(黒画像)・ 1 : サムネイル無し |
parent_id_contents | 親フォルダのコンテンツID |
description | 説明文 |
metatag | タグ |
visible | 公開設定 ・ 0 : 非公開・ 1 : 公開・ DATE,DATE : 期間公開 |
meta_url | 関連画像に付属するURL |
update_date | 更新日(省略可)※未使用 |
common_create | 配信用動画・音声を作成。1で固定。 |
common_id_recipe | エンコード設定のID settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。 |
autocommit | 自動公開設定 ・ 0 : 手動で公開・ 1 : 自動公開 |
usermeta | USERMETA |
common_pc_nt (非推奨) | 1を指定した場合、PC向け配信用動画として元動画をそのまま利用します(元動画がmp4/flv/f4vファイルのときのみ) ※ ただしflv,f4vはhtml5プレイヤーに対応しておりません。 ※【注意】エンコードがされていない動画に関しましてはサポートしかねます |
common_sp_nt (非推奨) | 1を指定した場合、SP向け配信用動画として元動画をそのまま利用します(元動画がmp4ファイルのときのみ) ※【注意】エンコードがされていない動画に関しましてはサポートしかねます |
keitai_create | ケータイ動画の作成 ・ 0 : 作成しない(デフォルト)・ 1 : ケータイ動画・音声を作成 |
keitai_keitaimeta_name | ケータイ動画の名前 |
keitai_keitaimeta_description | 説明文 |
keitai_keitaimeta_author | 作成者 |
keitai_keitaimeta_copyright | コピーライト |
keitai_encoding_quality | 品質 |
keitai_thumbnailattime | サムネイル画像とする時間を正の整数で秒指定が可能(デフォルト値3) |
youtube_create | YouTube動画生成設定 ・ 0 : 作成しない(デフォルト)・ 1 : YouTube動画・音声を作成 |
youtube_youtubemeta_name | 名前 |
youtube_youtubemeta_description | 説明文 |
youtube_youtube_privacy_status | YouTube公開ステータス ・ public : 公開・ unlisted : 限定公開・ private : 非公開 |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
id_contents | コンテンツID |
ステータス
有効
POST
: /contents/create_image
概要
画像を登録。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
filekey (required) | 登録する動画・音声のファイルキー |
name | コンテンツ名 |
parent_id_contents | 親フォルダのコンテンツID |
description | 説明文 |
visible | 公開設定 ・ 0 : 非公開・ 1 : 公開・ DATE,DATE : 期間公開 |
autocommit | 自動公開設定 ・ 0 : 手動で公開・ 1 : 自動公開 |
meta_url | メタURL |
metatag | タグ |
usermeta | USERMETA ※未指定時は空文字 |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
id_contents | コンテンツID |
ステータス
有効
POST
: /contents/create_thumbnail
概要
サムネイルを登録。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
filekey (required) | 登録する動画・音声のファイルキー |
id_contents (required) | コンテンツID |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
id_video_thumbnail | サムネイルID |
url | URL |
ステータス
有効
POST
: /contents/create_thumbnail_attime
概要
動画の時間を指定してサムネイルを登録。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
id_contents (required) | コンテンツのID |
time (required) | 時間(秒) |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
id_video_thumbnail | サムネイルID |
url | URL |
ステータス
有効
POST
: /contents/create_pdf
概要
PDFを登録。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
filekey (required) | 登録するPDFのファイルキー |
name | コンテンツ名 |
type | pdf=PDF(省略時:pdf) |
parent_id_contents | 親フォルダのコンテンツID |
description | 説明文 |
visible | 公開設定 ・ 0 : 非公開・ 1 : 公開・ DATE,DATE : 期間公開 |
autocommit | 自動公開設定 ・ 0 : 手動で公開・ 1 : 自動公開 |
meta_url | メタURL |
metatag | タグ |
usermeta | USERMETA |
domaincontrol | ドメイン制御 |
update_date | 更新日(省略可)※未使用 |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
id_contents | コンテンツID |
ステータス
有効
POST
: /contents/create_video_keitai
概要
ケータイ動画・音声を作成。
カテゴリ
コンテンツ
入力
クエリー
名前 | 値 |
---|---|
ticket (required) | loginメソッドで取得できるチケット文字列 |
id_contents (required) | コンテンツID |
keitaimeta_name (required) | 名前 |
encoding_quality (required) | 品質(ケータイ) ケータイ動画・音声のencoding_quality参照 |
keitaimeta_description | 説明文 |
keitaimeta_author | 作成者 |
keitaimeta_copyright | コピーライト |
keitai_thumbnailattime | サムネイル画像とする時間を正の整数で秒指定が可能(デフォルト値3) |
autocommit | 自動公開設定 ・ 0 : 手動で公開・ 1 : 自動公開 |
ステータス
有効