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 プレイヤーコンポーネントのインスタンスID
※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。
labelname 受け付けるプレイリストの階層
1 : 1階層
2 : 2階層
※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。
labelname 場所名
※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。
labelvalue プレイリスト名
※APIサーバーからのレスポンスに含まれるだけであり、登録時には必要なし。
要素値(空文字) プレイリストID
※APIサーバーからのレスポンスに含まれるし、登録時にも必要。

例:

{"id_ad": {"labelname": "広告","labelvalue": "","": "0"},"id_adserver": {"labelname": "アドサーバー","labelvalue": "","": "0"},"id_player": {"labelname": "プレイヤー","labelvalue": "SinglePlayer","": 1},"id_playlist": [{"componentinstanceid": "i698284823","dimension": 1,"labelname": "screenのプレイリスト","": "0"}]}

GET : /tag/list

概要

埋め込みコード一覧を取得。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
type 取得するプレイヤータイプを指定
single : シングルプレイヤー
multi : マルチプレイヤー
player_subtype 取得するプレイヤーサブタイプを指定
video : 動画
pdf : PDF
player_design 取得するプレイヤーデザイン
video : player_subtype=videoのとき
audio : player_subtype=videoのとき
pdf : player_subtype=pdfのとき

出力

レスポンス内容

名前(要素名) 値(要素の内容)
tag 埋め込みコード(リスト)
id_tag 埋め込みコードID
name 埋め込みコード名
visible 公開設定
0 : 非公開
1 : 公開
type タイプ
single : シングル
multi : マルチ
player_subtype プレイヤーサブタイプ
video : 動画
pdf : PDF
player_design 取得するプレイヤーデザイン
video : player_subtype=videoのとき
audio : player_subtype=videoのとき
pdf : player_subtype=pdfのとき

ステータス

有効

 

POST : /tag/delete

概要

埋め込みコードを削除。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID

ステータス

有効

 

POST : /tag/modify

概要

埋め込みコードの基本情報を変更。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID
name 埋め込みコード名
visible 公開設定
0 : 非公開
1 : 公開

ステータス

有効

 

POST : /tag/modify_tagconfig

概要

埋め込みコードのtagconfigを変更。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID
tagconfig (required) 埋め込みコード設定(JSON)

説明

※tagconfigのid_playlistは、componentinstanceidと要素値だけが必要。

ステータス

有効

 

GET : /tag/get_default_tagconfig

概要

デフォルト状態の埋め込みコード設定JSONを取得。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_player (required) プレイヤーid

出力

レスポンス内容

名前(要素名) 値(要素の内容)
tagconfig 埋め込みコード設定(JSON)

ステータス

有効

 

POST : /tag/create

概要

埋め込みコードを作成。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
name (required) 埋め込みコード名
tagconfig (required) 埋め込みコード設定(JSON)

出力

レスポンス内容

名前(要素名) 値(要素の内容)
id_tag 埋め込みコードID

説明

※tagconfigのid_playlistは、componentinstanceidと要素値だけが必要。

ステータス

有効

 

GET : /tag/get_tag

概要

埋め込みコードの詳細情報を取得。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID
id_contents コンテンツID

出力

レスポンス内容

名前(要素名) 値(要素の内容)
embed 埋め込みコード
all 一括埋め込みコード
  tag タグ
   name 名前
   embed embedタグコード
   use_onetime ワンタイム設定
tagconfig 埋め込みコード設定(JSON)

ステータス

有効

 

GET : /tag/get_tag_details

概要

埋め込みコードの詳細情報を取得。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID

出力

レスポンス内容

名前(要素名) 値(要素の内容)
name 埋め込みコード名

ステータス

有効

 

GET : /tag/make_embedkey

概要

embedkeyを返す。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID
id_contents (required) 動画コンテンツのID

出力

レスポンス内容

名前(要素名) 値(要素の内容)
embedkey EMBEDKEY
(embedkeyを指定する場合、id_host,id_vhost,id_tag,id_contentsの指定は不要)

ステータス

有効

 

GET : /tag/public_html_url

概要

指定された埋め込みコードを設置したHTMLを発行します。

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID
id_contents 動画コンテンツのID
duration ミルビィワンタイムの有効期間の設定
未指定の場合はデフォルト1800秒です。
(ミルビィワンタイムが有効なアカウントで指定可能です)

出力

レスポンス内容

名前(要素名) 値(要素の内容)
url 発行されたHTMLのURL

ステータス

有効

 

GET : /tag/public_iframe_tag

概要

カテゴリ

埋め込みコード

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_tag (required) 埋め込みコードID

出力

レスポンス内容

名前(要素名) 値(要素の内容)
url 発行されたHTMLのURL

ステータス

有効

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています