tagの共通要素
埋め込みコード設定JSON – tagconfig
| 値 | 要素の内容 |
|---|---|
| id_player | ★プレイヤー |
| labelname | “プレイヤー”で固定 ※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。 |
| labelvalue | プレイヤー名 ※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。 |
| 要素値(空文字) | プレイヤーID(id_player) |
| id_ad | ★広告 |
| labelname | “広告”で固定 ※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。 |
| labelvalue | 広告名 ※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。 |
| 要素値(空文字) | 広告ID(id_ad) |
| id_playlist | ★プレイリストID（※プレイヤーが持つリストの分だけ複数） |
| componentinstanceid | プレイヤーコンポーネントのインスタンスID ※APIサーバーからのレスポンスに含まれるし、登録時にも必要。 |
| dimension | 受け付けるプレイリストの階層（1 or 2） ※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。 |
| labelname | 場所名 ※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。 |
| labelvalue | プレイリスト名 ※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。 |
| 要素値(空文字) | プレイリストID ※APIサーバーからのレスポンスに含まれるし、登録時にも必要。 |
tag/list
概要
埋め込みコード一覧を取得。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| type | 取得するプレイヤータイプを指定。シングル(single)またはマルチ(multi) |
| player_subtype | 取得するプレイヤーサブタイプを指定。video、またはpdf |
| player_design | 取得するプレイヤーデザインを指定。 player_subtype=videoのときvideoまたはaudio、player_subtype=pdfのときpdf |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| tag | 埋め込みコード（※リスト） |
| id_tag | 埋め込みコードID |
| name | 埋め込みコード名 |
| visible | 1:公開 0:非公開 |
| type | プレイヤータイプ。シングル(single)またはマルチ(multi) |
| player_subtype | プレイヤーサブタイプ。video、またはpdf |
| player_design | プレイヤーデザイン。 player_subtype=videoのときvideoまたはaudio、player_subtype=pdfのときpdf |
ステータス
有効
tag/delete
概要
埋め込みコードを削除。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
ステータス
有効
tag/modify
概要
埋め込みコードの基本情報を変更。
カテゴリ
埋め込みコード
入力
| クエリー | |
|---|---|
| 名前 | 値 |
| id_tag | 埋め込みコードID |
| name | 埋め込みコード名（省略可） |
| visible | 公開:1 非公開:0 （省略可） |
ステータス
有効
tag/modify_tagconfig
概要
埋め込みコードのtagconfigを変更。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
| tagconfig | 埋め込みコード設定JSON（省略可） |
説明
※tagconfigのid_playlistは、componentinstanceidと要素値だけが必要。
ステータス
有効
tag/get_default_tagconfig
概要
デフォルト状態の埋め込みコード設定JSONを取得。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_player | プレイヤーid |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| tagconfig | 埋め込みコード設定JSON |
ステータス
有効
tag/create
概要
埋め込みコードを作成。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| name | 埋め込みコード名 |
| tagconfig | 埋め込みコード設定JSON |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| id_tag | 埋め込みコードID |
説明
※tagconfigのid_playlistは、componentinstanceidと要素値だけが必要。
ステータス
有効
tag/get_tag
概要
埋め込みコードの詳細情報を取得。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
| id_contents | コンテンツID(※省略可) |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| embed | 埋め込みコード |
| all | 一括埋め込みコード |
| tag | タグ |
| name | 名前 |
| embed | embedタグコード |
| tagconfig | 埋め込みコード設定JSON |
ステータス
有効
tag/get_tag_details
概要
埋め込みコードの詳細情報を取得。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| name | 埋め込みコード名 |
ステータス
有効
tag/make_embedkey
概要
embedkeyを返す。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
| id_contents | 動画コンテンツのID （省略可。指定した場合、出力のid_contents項に値が返ります） |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| embedkey | EMBEDKEY (embedkeyを指定する場合、id_host,id_vhost,id_tag,id_contentsの指定は不要） |
ステータス
有効
tag/public_html_url
概要
指定された埋め込みコードを設置したHTMLを発行します。
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
| id_contents | 動画コンテンツのID （省略可） |
| duration | ミルビィワンタイムの有効期間を秒指定できます。 未指定の場合はデフォルト1800秒です。 （ミルビィワンタイムが有効なアカウントで指定可能です） |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| url | 発行されたHTMLのURL |
ステータス
有効
tag/public_iframe_tag
概要
カテゴリ
埋め込みコード
入力
クエリー
| 名前 | 値 |
|---|---|
| id_tag | 埋め込みコードID |
| id_contents | 動画コンテンツのID （省略可） |
| duration | ミルビィワンタイムの有効期間を秒指定できます。 未指定の場合はデフォルト1800秒です。 （ミルビィワンタイムが有効なアカウントで指定可能です） |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| url | 発行されたiframeのHTMLタグ |
ステータス
有効