目次
- init（埋め込みタグの基本情報を取得）
- get_playlist（2階層プレイリスト内の、1階層プレイリストのリストを取得）
- get_contents（動画の情報を取得）
- get_pdf_contents（PDFの情報を取得）
- get_info（動画コンテンツの各種情報を取得）
- socialmail（ソーシャルメールを送信）
init
概要
埋め込みタグの基本情報を取得。
カテゴリ
root
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID （embedkeyを指定しない場合、id_host,id_vhost,id_tagの指定は必須。id_contentsはオプション） |
| embedkey | EMBEDKEY この詳細についてはAPIドキュメント[tag/make_embedkey]を参照ください。 |
| flash | 端末にFlashPlayerがインストールされているかどうか。 1ならインストール済み。0なら入っていない。 |
| refererurl | 「リファラ用URL (refererurl):主にanalytics向けに使用するリファラー用URL。」を渡す。 |
| id_contents | 動画コンテンツのID （省略可。指定した場合、出力のid_contents項に値が返ります） |
出力
■通常
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| playerconfig | playerconfig （component要素内にid_playlistが追加で付与されている） |
| videotype | 動画表示部分にFlashPlayer(flash)を使うか、HTML5-Videoタグ(video)を使うか。 |
| flash_url | videotypeがflashの場合に、使用するswfのURL。 |
| flash_extraflashvars | videotypeがflashの場合に、flashvarsに追加で指定するべき情報。 |
| playertype | シングルプレイヤー(single)またはマルチプレイヤー(multi) |
| id_ad | 広告ID |
| adserver | 契約している外部アドサーバーの情報 |
| adserver.url | 外部アドサーバーURL |
| adserver.name | 外部アドサーバー名 |
| analytics_uniqueid | analytics-client向けユニークID |
| analytics_device | analytics-client向けdeviceコード (pc or sp) |
| device_info | 端末情報 |
| category | pc=PC、sp=スマートフォン |
| browser | ブラウザ情報 |
| unseekable | true:シーク不可/false:シーク可 |
| id_host | ホストのID |
| id_vhost | vhostのID |
| id_tag | 埋め込みコードID |
| id_contents | 動画コンテンツのID |
| host | hostcode |
■ドメイン制限時
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| block | ※block要素については下記「block要素」を参照ください |
| code | domain固定 |
| message | 日本語のエラーメッセージ |
■海外アクセス制限時
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| block | ※block要素については下記「block要素」を参照ください |
| code | external固定 |
| message | 日本語のエラーメッセージ |
block要素
- 埋め込みコード削除時、エラーメッセージを表示”この動画は管理者により削除されたため再生できません”
→ init時 block:{code:”tag_not_available”} - 埋め込みコード非公開時、エラーメッセージを表示 ”この動画は管理者の都合により再生できません”
→ init時 block:{code:”tag_not_available”} - コンテンツ管理から取得する埋め込みコード、非公開時はプレイヤーが表示されるがメッセージを表示
→ init時 block:{code:”tag_not_available”} - プレイリスト削除時、メッセージを表示
→ init時 block{code:”playlist_not_available”} ※一つでも削除されていたら
block表
- code:tag_not_availableinfo:removed
- code:tag_not_availableinfo:invisible
- code:tag_not_availableinfo:external
- code:tag_not_availableinfo:domain
- code:playlist_not_availableinfo:removed
- code:flash_is_requiredinfo:
ステータス
有効
get_playlist
概要
2階層プレイリスト内の、1階層プレイリストのリストを取得。
カテゴリ
root
入力
クエリー
| 名前 | 値 |
|---|---|
| id_playlist | プレイリストID |
| limit | (offset),(limit) 例） 0,10 => 1行目から10行分取得 limitを指定すると結果にresult要素が付きます。（省略可） |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| playlist | プレイリスト（複数） |
| id_playlist | プレイリストID |
| name | プレイリスト名 |
| result | 入力でlimitを指定することで含まれます。 |
| offset | (offset)の値 |
| limit | (limit)の値 |
| found | 全行数 |
| block | 特定条件下で出力されます。 ※block要素については下記「block要素」を参照ください |
| code | external固定 |
| message | 日本語のエラーメッセージ |
block要素
- プレイリスト削除時、メッセージを表示
→ get_playlist時 block{code:”playlist_not_available”} ※一つでも削除されていたら
block表
- code:playlist_not_availableinfo:removed
- code:contents_not_availableinfo:removed
- code:contents_not_availableinfo:invisible
ステータス
有効
get_contents
概要
動画の情報を取得。
カテゴリ
root
入力
クエリー
| 名前 | 値 |
|---|---|
| id_playlist | プレイリストID（省略可） |
| id_contents | 動画コンテンツID（省略可） |
| specialthumbnail | 中央部分がトリミングされたサムネイル画像を返します。（省略可） |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| contents | コンテンツ（複数） |
| id_contents | 動画コンテンツのID |
| duration | 尺 |
| name | タイトル |
| description | 説明文 |
| date | 更新日 |
| video_url | 動画のURL |
| thumbnail_url | サムネイルのURL |
| original_width | 元動画の幅 |
| original_height | 元動画の高さ |
| block | 特定条件下で出力されます。 ※block要素については下記「block要素」を参照ください |
| code | external固定 |
| message | 日本語のエラーメッセージ |
block要素
- プレイリスト削除時、メッセージを表示
→ get_contents時 block{code:”playlist_not_available”} ※一つでも削除されていたら - コンテンツが非公開時、メッセージを表示
→ get_contents時 block{code:”contents_not_available”}
block表
- code:contents_not_availableinfo:removed
- code:contents_not_availableinfo:invisible
ステータス
有効
get_pdf_contents
概要
PDFの情報を取得。
カテゴリ
root
入力
クエリー
| 名前 | 値 |
|---|---|
| id_contents | PDFコンテンツID ※get_contentsと異なり省略不可 |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| contents | コンテンツ |
| id_contents | PDFコンテンツID |
| name | タイトル |
| description | 説明文 |
| urls | PDF画像URL一覧カンマ区切り文字列 |
| param_chapter | チャプターパラメーター |
| block | 特定条件下で出力されます。 ※block要素については下記「block要素」を参照ください |
| code | external固定 |
| message | 日本語のエラーメッセージ |
block要素
- コンテンツ削除時、メッセージを表示
→ get_pdf_contents時 block{code:”contents_not_available”} - コンテンツ非公開時、メッセージを表示
→ get_pdf_contents時 block{code:”contents_not_available”} - コンテンツがドメイン制御において非公開時、メッセージを表示
→ get_pdf_contents時 block{code:”contents_not_available”}
block表
- code:contents_not_availableinfo:removed
- code:contents_not_availableinfo:invisible
- code:contents_not_availableinfo:domaincontrol
ステータス
有効
get_info
概要
動画コンテンツの各種情報を取得。
カテゴリ
root
入力
クエリー
| 名前 | 値 |
|---|---|
| host(required) | ホスト名(クライアントID) |
| id_vhost(required) | グループID |
| id_contents(required) | 動画コンテンツのID |
| videotype(required) | initで取得したvideotype |
| useragent | UserAgent（省略可） ※省略した場合はリクエストヘッダから取得。 |
| accesskey | accesskey文字列（省略可） |
| id_ad | (省略可) |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| url | 実動画URL |
| thumbnail_url | サムネイルURL |
| param_chapter | チャプターパラメーター |
| param_subtitle | 字幕パラメーター （そのままvideoplayer.swfのvideoplayer_initに渡す） |
| param_annotation | アノテーションパラメーター （そのままvideoplayer.swfのvideoplayer_initに渡す） |
| param_ad | 広告パラメーター （そのままvideoplayer.swfのvideoplayer_initに渡す） |
| param_basic | その他のパラメーター （そのままvideoplayer.swfのvideoplayer_initに渡す） |
| original_width | 元動画の幅 |
| original_height | 元動画の高さ |
| block | 特定条件下で出力されます。 ※block要素については下記「block要素」を参照ください |
| code | external固定 |
| message | 日本語のエラーメッセージ |
block要素
- コンテンツ非公開時、メッセージを表示
→ get_info,get_contents時 block{code:”contents_not_available”}
block表
- code:contents_not_availableinfo:removed
- code:contents_not_availableinfo:invisible
ステータス
有効
socialmail
概要
ソーシャルメールを送信。
カテゴリ
root
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
| from | FROM |
| to | TO |
| body | BODY |
| linkurl | 「リンク用URL」 |
ステータス
有効