contents(共通要素)はこちらを参照してください。
目次
- GET : /contents/get_all_items(全ての動画・音声・画像・PDFを取得)
- POST : /contents/move_contents(コンテンツを別のフォルダへ移動)
- POST : /contents/delete_contents(コンテンツを削除)
- GET : /contents/search_contents(コンテンツの検索)
GET : /contents/get_all_items
概要
全ての動画・音声・画像・PDFを取得
カテゴリ
コンテンツ
入力
クエリ ※limit,filters,order対応
| 名前 | 値 |
| ticket (required) | loginメソッドで取得できるチケット文字列 |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
| 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 | イメージ画像 ・ 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 |
ステータス
有効