playlist(プレイリスト)

 

目次

---

1. POST : /playlist/add_video（動画をプレイリストへ追加）
2. GET : /playlist/get_playlist_layout（全てのプレイリストをツリー構造化したデータを取得）
3. POST : /playlist/create_playlist1（1階層プレイリストを作成）
4. POST : /playlist/create_playlist2（2階層プレイリストを作成）
5. POST : /playlist/delete_playlist（プレイリストを削除）
6. GET : /playlist/get_playlist_sublist（プレイリストに含まれるサブリストの情報を取得）
7. POST : /playlist/modify_sublist_position（サブリストの順番を変更）
8. GET : /playlist/get_playlist_contents（プレイリストに含まれる動画の情報を取得）
9. POST : /playlist/delete_video（プレイリストから動画を削除）
10. POST : /playlist/modify_video_position（動画の順番を変更）
11. POST : /playlist/move_video（複数の動画を別のプレイリストへ移動）
12. POST : /playlist/modify_playlist（プレイリストの情報を変更）
13. GET : /playlist/get_playlist_info（プレイリストの情報を取得）

 

POST : /playlist/add_video

---

概要

動画をプレイリストへ追加。

カテゴリ

プレイリスト

入力

クエリ

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_contents (required)	追加するコンテンツのID
id_playlist (required)	プレイリストID

 

ステータス

有効

 

GET : /playlist/get_playlist_layout

---

概要

全てのプレイリストをツリー構造化したデータを取得。

カテゴリ

プレイリスト

入力

クエリ

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列

 

出力

レスポンス内容

名前(要素名)	値(要素の内容)
playlist	プレイリスト(ツリー)
dimension	階層 ・1 : 1階層 ・2 : 2階層
name	プレイリスト名
id_playlist	プレイリストID
playlist	2階層の場合、1階層のプレイリストのリストが含まれる。

 

ステータス

有効

 

POST : /playlist/create_playlist1

---

概要

1階層プレイリストを作成。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
name (required)	プレイリスト名
type (required)	コンテンツの追加方法 ・manual : 手動 ・auto : 自動
contents_type	コンテンツタイプ ・all : 全て ・video : 動画のみ ・audio : 音声のみ
parent_id_playlist	2階層プレイリストのサブリストとして作成する場合は、対象のプレイリストIDを指定
auto_tags	タグによるプレイリスト自動生成 type=auto時のみ
auto_latest	最新動画のプレイリスト type=auto時のみ
auto_sort	ソート ・play : 再生回数 ・date : 投稿日時 ・shuffle : シャッフル type=auto時のみ

 

出力

レスポンス内容

名前(要素名)	値(要素の内容)
id_playlist	プレイリストID

 

ステータス

有効

 

POST : /playlist/create_playlist2

---

概要

2階層プレイリストを作成。

カテゴリ

プレイリスト

入力

クエリ

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
name (required)	プレイリスト名

 

出力

レスポンス内容

名前(要素名)	値(要素の内容)
id_playlist	プレイリストID

 

ステータス

有効

 

POST : /playlist/delete_playlist

---

概要

プレイリストを削除。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_playlist (required)	プレイリストID

 

ステータス

有効

 

GET : /playlist/get_playlist_sublist

---

概要

プレイリストに含まれるサブリストの情報を取得。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_playlist (required)	プレイリストID

 

出力

レスポンス内容

名前(要素名)	値(要素の内容)
playlist	プレイリスト(ツリー)
id_playlist	プレイリストID
name	プレイリスト名
position	位置

 

ステータス

有効

 

POST : /playlist/modify_sublist_position

---

概要

サブリストの順番を変更。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_playlist (required)	プレイリストID
position (required)	プレイリスト内の絶対位置(1が一番上)

 

ステータス

有効

 

GET : /playlist/get_playlist_contents

---

概要

プレイリストに含まれる動画の情報を取得。

カテゴリ

プレイリスト

入力

クエリー

※limit, filters, order対応

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_playlist (required)	プレイリストID

 

出力

名前(要素名)	値(要素の内容)
contents	コンテンツ
id_contents	コンテンツID
category	コンテンツのカテゴリー ・video : 動画・音声 ・image : 画像 ・pdf : PDF ・broadcast : 配信
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 ※未指定時はnull
metatag	設定したmetatag ※未指定時は空文字
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
id_playlist	プレイリストID
id_playlist_contents	プレイリスト内のコンテンツに割り当てられたID id_playlistとid_playlist_contentsで一意
position	位置

 

ステータス

有効

 

POST : /playlist/delete_video

---

概要

プレイリストから動画を削除。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_playlist (required)	プレイリストID
id_playlist_contents (required)	プレイリスト内のコンテンツに割り当てられたID id_playlistとid_playlist_contentsで一意

 

ステータス

有効

 

POST : /playlist/modify_video_position

---

概要

動画の順番を変更。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_playlist (required)	プレイリストID
id_playlist_contents (required)	プレイリスト内のコンテンツに割り当てられたID id_playlistとid_playlist_contentsで一意
position (required)	プレイリスト内の絶対位置(1が一番上)

 

ステータス

有効

 

POST : /playlist/move_video

---

概要

複数の動画を別のプレイリストへ移動。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
from_id_playlist (required)	元プレイリストのID
to_id_playlist (required)	移動先のプレイリストのID
from_id_playlist_contents (required)	1つ以上のid_playlist_contents カンマ区切りで複数指定可能

 

ステータス

有効

 

POST : /playlist/modify_playlist

---

概要

プレイリストの情報を変更。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_playlist (required)	プレイリストID
name	プレイリスト名
type	コンテンツの追加方法 ・manual : 手動 ・auto : 自動 ※1階層プレイリスト時のみ
contents_type	コンテンツタイプ ・all : 全て ・video : 動画のみ ・audio : 音声のみ
auto_tags	タグによるプレイリスト自動生成 type=auto時のみ
auto_latest	最新動画のプレイリスト type=auto時のみ
auto_sort	ソート ・play : 再生回数 ・date : 投稿日時 ・shuffle : シャッフル type=auto時のみ

 

ステータス

有効

 

GET : /playlist/get_playlist_info

---

概要

プレイリストの情報を取得。

カテゴリ

プレイリスト

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列
id_playlist (required)	プレイリストID

 

出力

レスポンス内容

名前(要素名)	値(要素の内容)
playlist	プレイリスト
name	プレイリスト名
dimension	階層
type	コンテンツの追加方法 ・manual : 手動 ・auto : 自動 ※1階層プレイリスト時のみ
contents_type	コンテンツタイプ ・all : 全て ・video : 動画のみ ・audio : 音声のみ
auto_tags	タグによるプレイリスト自動生成 type=auto時のみ
auto_latest	最新動画のプレイリスト type=auto時のみ
auto_sort	ソート ・play : 再生回数 ・date : 投稿日時 ・shuffle : シャッフル type=auto時のみ

 

ステータス

有効