Meride API - configuration - Read

This page explains how to read the content configuration.

Entity name: configuration.

GET http://API_DOMAIN/rest/configuration.{format}

Attributes

No parameter

Response

A collection / array of elements

Field	Value	Description
id	string	Object ID
title	string	Il titolo della configurazione
label	string	The label field associated with the configuration
context_rules	array	Set of context rules
data_inserimento	string	La data di inserimento che segue il formato Y-m-d H:i:s `Y(year)` `m(month)` `d(day)` `H(hours)` `i(minutes)` `s(seconds)`
skin	string	The skin of the player chosen during create
responsive	boolean	`1` if autoplay is responsive. `0` otherwise
background_color	string	The background color of the player in HEX code.
background_image	string	URL of the player's background image.
autoplay	boolean	`1` if the video is published in autoplay. `0` otherwise
controlbar_visible	boolean	`0` if the player's control bar is hidden. `0` otherwise
seekable	boolean	`0` if the player's scroll bar is disabled. `0` otherwise
wmode	string	The wmode property of the object/embed element on Flash player
skip_preroll	boolean	`1` if the user has the option to skip the preroll. `0` otherwise
skip_time	integer	The number of seconds after which the link to skip the preroll appears
setting_volume	string	Google DART volume. `-1` Predefined. `none` No check. `defaultOn` Volume active. `defaultOff` Volume disabled
adblock_policy	string	Anti-AdBlock policy
adblock_policy_ad_video	advideo	Advideo object to be used as a preroll for the anti-AdBLock policy
player_adv_manager	string	Player Ad Manager
ima_vpaid_mode	string	IMA Vpaid Mode
desktop_player	string	Player type for desktop users
preroll	advideo \| addart	Il preroll utilizzato nel player Flash per utenti desktop. Qual'ora sono associati più di un singolo preroll verrà restituito un array con tutti i preroll associati
postroll	advideo \| addart	Il postroll utilizzato nel player Flash per utenti desktop
overlay_initial	addart	L'overlay iniziale utilizzato nel player Flash per utenti desktop
overlay_main	addart	L'overlay principale utilizzato nel player Flash per utenti desktop
html5_preroll	addart	Il preroll utilizzato nel player HTML5 utilizzato per i dispositivi mobili. Qual'ora sono associati più di un singolo preroll verrà restituito un array con tutti i preroll associati
html5_postroll	addart	Il postroll utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
html5_overlay_initial	addart	L'overlay iniziale utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
html5_overlay_main	addart	L'overlay principale utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
watermark	string	URL to the image of the watermark
watermark_width	int	Watermark resize width
watermark_height	int	Watermark height resize
watermark_opacity	float	Watermark transparency level
watermark_displaytime	int	Watermark dwell time in seconds
watermark_hide	boolean	`1` If the watermark disappears together with the player controls. `0` otherwise
watermark_link	string	URL to redirect by clicking on the watermark.
watermark_bottom	string	Placement of the watermark from the bottom
watermark_right	string	Placement of the watermark from the right
watermark_top	string	Placement of the watermark from the top
watermark_left	string	Placement of the watermark from the left
webtrekk_account	webtrekk	The associated Webtrekk object
ama_configuration	ama	The associated Akamai Media Analytics object
comscore_account	comscore	The associated Comscore object
nielsen_account	nielsen	The associated Nielsen object

Agli oggetti preroll, postroll, overlay_initial e overlay_main (Flash e HTML5) verrà inserito un campo aggiuntivo tipo_adv che specifica la tipologia di advertising: dart per oggetti Google DART, video per contenuti Roll)

Example of a curl request

curl -i -H "Accept: application/json" -H "access-token: Fun94nBf4YiaL20hG5np2Ki8mHtm9OCn4R6lPamNM8mNn7YFDRUvZveSbB0n6T" -X GET http://API_DOMAIN/rest/configuration.json

Note Una singola chiamata GET può restituire al massimo 250 record. Utilizza i parametri di ricerca search_limit e search_offset per scaricare tutti i record se necessario. Puoi eventualmente utilizzare il parametro search_count per conoscere il numero di record generati da una singola query di ricerca.

Example of a JSON response

[
	...
{
    "id":"39",
    "titolo":"Configuration title",
    "label":"conf1",
    "context_rules":{
    	"0":"http:\/\/www.meride.tv*",
    	"1":"http:\/\/www.mosaicolab.com*"
    	},
    "skin":"default",
    "data_inserimento":"2012-09-24 09:12:49",
    "responsive":"0",
    "background_color":"000000",
    "background_image":"",
    "autoplay":"1",
    "controlbar_visible":"1",
    "seekable":"1",
    "wmode":"direct",
    "skip_preroll":"",
    "skip_time":"",
    "setting_volume" : "-1",
    "adblock_policy":"",
    "adblock_policy_ad_video_id":null,
    "player_adv_manager":"default",
    "ima_vpaid_mode":null,
    "desktop_player":"flash",
    "preroll":{
        "tipo_adv":"dart",
        "id":"2",
        "titolo":"Google dart",
        "url_sorgente":"http:\/\/googledarturl.com/advertising.xml",
        "tags":"lorem, ipsum",
        "descrizione":"Lorem ispum dolor sit amet",
        "data_inserimento":"2012-09-21 20:26:18"
    },
    "postroll":null,
    "overlay_initial":{
        "tipo_adv":"dart",
        "id":"59",
        "tipo":"non-linear",
        "titolo":"Overlay",
        "url_sorgente":"http:\/\/googledarturl.com/advertising2.xml",
        "descrizione":"",
        "data_inserimento":"2012-12-17 11:38:26",
        "stay_time":"15"
        "after_time":"0"
    },
    "overlay_main":null,
    "html5_preroll":{
        "tipo_adv":"dart",
        "id":"2",
        "titolo":"Google dart",
        "url_sorgente":"http:\/\/googledarturl.com/advertising.xml",
        "tags":"lorem, ipsum",
        "descrizione":"Lorem ispum dolor sit amet",
        "data_inserimento":"2012-09-21 20:26:18"
    },
    "html5_postroll":null,
    "html5_overlay_initial":null,
    "html5_overlay_main":{
        "tipo_adv":"dart",
        "id":"33",
        "tipo":"non-linear",
        "titolo":"Overlay",
        "url_sorgente":"http:\/\/googledarturl.com/advertising3.xml",
        "descrizione":"",
        "data_inserimento":"2012-05-23 18:26:20",
        "fixed":"0",
        "after_time":"0"
        "stay_time":"15",
        "delay_time":"20",
        "max_width":"728",
        "max_height":"90"
    },
    "watermark":null,
    "watermark_width":null,
    "watermark_height":null,
    "watermark_opacity":null,
    "watermark_displaytime":null,
    "watermark_hide":null,
    "watermark_link":null,
    "watermark_bottom":null,
    "watermark_right":null,
    "watermark_top":null,
    "watermark_left":null,
    "webtrekk_account":null,
    "ama_configuration":null,
    "comscore_account" : {
        "id":"1",
        "titolo":"Comscore title",
        "clientid":"14267511",
        "predefinito":"1",
        "descrizione":null,
        "data_inserimento":"2013-02-06 17:11:03"
    },
    "nielsen_account" : null
}
	...
]

GET http://API_DOMAIN/rest/configuration/{resource-id}.{format}

{resource-id}: the object ID

Attributes

No parameter

Response

Field	Value	Description
id	string	Object ID
title	string	Il titolo della configurazione
label	string	The label field associated with the configuration
context_rules	array	Set of context rules
data_inserimento	string	La data di inserimento che segue il formato Y-m-d H:i:s `Y(year)` `m(month)` `d(day)` `H(hours)` `i(minutes)` `s(seconds)`
skin	string	The skin of the player chosen during create
responsive	boolean	`1` if autoplay is responsive. `0` otherwise
background_color	string	The background color of the player in HEX code.
background_image	string	URL of the player's background image.
autoplay	boolean	`1` if the video is published in autoplay. `0` otherwise
controlbar_visible	boolean	`0` if the player's control bar is hidden. `0` otherwise
seekable	boolean	`0` if the player's scroll bar is disabled. `0` otherwise
wmode	string	The wmode property of the object/embed element on Flash player
skip_preroll	boolean	`1` if the user has the option to skip the preroll. `0` otherwise
skip_time	integer	The number of seconds after which the link to skip the preroll appears
setting_volume	string	Google DART volume. `-1` Predefined. `none` No check. `defaultOn` Volume active. `defaultOff` Volume disabled
adblock_policy	string	Anti-AdBlock policy
adblock_policy_ad_video	advideo	Advideo object to be used as a preroll for the anti-AdBLock policy
player_adv_manager	string	Player Ad Manager
ima_vpaid_mode	string	IMA Vpaid Mode
desktop_player	string	Player type for desktop users
preroll	advideo \| addart	Il preroll utilizzato nel player Flash per utenti desktop. Qual'ora sono associati più di un singolo preroll verrà restituito un array con tutti i preroll associati
postroll	advideo \| addart	Il postroll utilizzato nel player Flash per utenti desktop
overlay_initial	addart	L'overlay iniziale utilizzato nel player Flash per utenti desktop
overlay_main	addart	L'overlay principale utilizzato nel player Flash per utenti desktop
html5_preroll	addart	Il preroll utilizzato nel player HTML5 utilizzato per i dispositivi mobili. Qual'ora sono associati più di un singolo preroll verrà restituito un array con tutti i preroll associati
html5_postroll	addart	Il postroll utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
html5_overlay_initial	addart	L'overlay iniziale utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
html5_overlay_main	addart	L'overlay principale utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
watermark	string	URL to the image of the watermark
watermark_width	int	Watermark resize width
watermark_height	int	Watermark height resize
watermark_opacity	float	Watermark transparency level
watermark_displaytime	int	Watermark dwell time in seconds
watermark_hide	boolean	`1` If the watermark disappears together with the player controls. `0` otherwise
watermark_link	string	URL to redirect by clicking on the watermark.
watermark_bottom	string	Placement of the watermark from the bottom
watermark_right	string	Placement of the watermark from the right
watermark_top	string	Placement of the watermark from the top
watermark_left	string	Placement of the watermark from the left
webtrekk_account	webtrekk	The associated Webtrekk object
ama_configuration	ama	The associated Akamai Media Analytics object
comscore_account	comscore	The associated Comscore object
nielsen_account	nielsen	The associated Nielsen object

Example of a curl request

curl -i -H "Accept: application/json" -H "access-token: Fun94nBf4YiaL20hG5np2Ki8mHtm9OCn4R6lPamNM8mNn7YFDRUvZveSbB0n6T" -X GET http://API_DOMAIN/rest/configuration/39.json

Example of a JSON response

{
    "id":"39",
    "titolo":"Configuration title",
    "label":"conf1",
    "context_rules":{
    	"0":"http:\/\/www.meride.tv*",
    	"1":"http:\/\/www.mosaicolab.com*"
    	},
    "skin":"default",
    "data_inserimento":"2012-09-24 09:12:49",
    "responsive":"0",
    "background_color":"000000",
    "background_image":"",
    "autoplay":"1",
    "controlbar_visible":"1",
    "seekable":"1",
    "wmode":"direct",
    "skip_preroll":"",
    "skip_time":"",
    "setting_volume" : "-1",
    "adblock_policy":"",
    "adblock_policy_ad_video_id":null,
    "player_adv_manager":"default",
    "ima_vpaid_mode":null,
    "desktop_player":"flash",
    "preroll":{
        "tipo_adv":"dart",
        "id":"2",
        "titolo":"Google dart",
        "url_sorgente":"http:\/\/googledarturl.com/advertising.xml",
        "tags":"lorem, ipsum",
        "descrizione":"Lorem ispum dolor sit amet",
        "data_inserimento":"2012-09-21 20:26:18"
    },
    "postroll":null,
    "overlay_initial":{
        "tipo_adv":"dart",
        "id":"59",
        "tipo":"non-linear",
        "titolo":"Overlay",
        "url_sorgente":"http:\/\/googledarturl.com/advertising2.xml",
        "descrizione":"",
        "data_inserimento":"2012-12-17 11:38:26",
        "stay_time":"15"
        "after_time":"0"
    },
    "overlay_main":null,
    "html5_preroll":{
        "tipo_adv":"dart",
        "id":"2",
        "titolo":"Google dart",
        "url_sorgente":"http:\/\/googledarturl.com/advertising.xml",
        "tags":"lorem, ipsum",
        "descrizione":"Lorem ispum dolor sit amet",
        "data_inserimento":"2012-09-21 20:26:18"
    },
    "html5_postroll":null,
    "html5_overlay_initial":null,
    "html5_overlay_main":{
        "tipo_adv":"dart",
        "id":"33",
        "tipo":"non-linear",
        "titolo":"Overlay",
        "url_sorgente":"http:\/\/googledarturl.com/advertising3.xml",
        "descrizione":"",
        "data_inserimento":"2012-05-23 18:26:20",
        "fixed":"0",
        "after_time":"0"
        "stay_time":"15",
        "delay_time":"20",
        "max_width":"728",
        "max_height":"90"
    },
    "watermark":null,
    "watermark_width":null,
    "watermark_height":null,
    "watermark_opacity":null,
    "watermark_displaytime":null,
    "watermark_hide":null,
    "watermark_link":null,
    "watermark_bottom":null,
    "watermark_right":null,
    "watermark_top":null,
    "watermark_left":null,
    "webtrekk_account":null,
    "ama_configuration":null,
    "comscore_account" : {
        "id":"1",
        "titolo":"Comscore title",
        "clientid":"14267511",
        "predefinito":"1",
        "descrizione":null,
        "data_inserimento":"2013-02-06 17:11:03"
    },
    "nielsen_account" : null
}

GET http://API_DOMAIN/rest/configuration.{format}

Note The option must be specified -G in the call with the curl command so that the search parameters are passed correctly

Attributes

Attribute	Value	Mandatory
search_string	A non-empty string that will be searched for in the title	NO
search_in_tags	`1` if you want to also search in tags. `0` otherwise	NO
search_in_description	`1` if you want to also search in the description. `0` otherwise	NO
search_date_min	Format DATETIME `aaaa-mm-gg`. Cerca tutti le configurazioni a partire dalla data specificata	NO
search_date_max	Format DATETIME `aaaa-mm-gg`. Cerca tutti le configurazioni fino alla data specificata	NO
search_limit	Intero maggiore di 0. Restituisce n configurazioni per la ricerca specificata.	NO
search_offset	Intero maggiore di 0. Restituisce le configurazioni a partire dal numero specificato.	NO
search_count	`1` se si vuole recuperare il dato sul numero di record trovati per la query effettuata. `0` otherwise	NO

Response

A collection / array of elements

Field	Value	Description
id	string	Object ID
title	string	Il titolo della configurazione
label	string	The label field associated with the configuration
context_rules	array	Set of context rules
data_inserimento	string	La data di inserimento che segue il formato Y-m-d H:i:s `Y(year)` `m(month)` `d(day)` `H(hours)` `i(minutes)` `s(seconds)`
skin	string	The skin of the player chosen during create
responsive	boolean	`1` if autoplay is responsive. `0` otherwise
background_color	string	The background color of the player in HEX code.
background_image	string	URL of the player's background image.
autoplay	boolean	`1` if the video is published in autoplay. `0` otherwise
controlbar_visible	boolean	`0` if the player's control bar is hidden. `0` otherwise
seekable	boolean	`0` if the player's scroll bar is disabled. `0` otherwise
wmode	string	The wmode property of the object/embed element on Flash player
skip_preroll	boolean	`1` if the user has the option to skip the preroll. `0` otherwise
skip_time	integer	The number of seconds after which the link to skip the preroll appears
setting_volume	string	Google DART volume. `-1` Predefined. `none` No check. `defaultOn` Volume active. `defaultOff` Volume disabled
adblock_policy	string	Anti-AdBlock policy
adblock_policy_ad_video	advideo	Advideo object to be used as a preroll for the anti-AdBLock policy
player_adv_manager	string	Player Ad Manager
ima_vpaid_mode	string	IMA Vpaid Mode
desktop_player	string	Player type for desktop users
preroll	advideo \| addart	Il preroll utilizzato nel player Flash per utenti desktop. Qual'ora sono associati più di un singolo preroll verrà restituito un array con tutti i preroll associati
postroll	advideo \| addart	Il postroll utilizzato nel player Flash per utenti desktop
overlay_initial	addart	L'overlay iniziale utilizzato nel player Flash per utenti desktop
overlay_main	addart	L'overlay principale utilizzato nel player Flash per utenti desktop
html5_preroll	addart	Il preroll utilizzato nel player HTML5 utilizzato per i dispositivi mobili. Qual'ora sono associati più di un singolo preroll verrà restituito un array con tutti i preroll associati
html5_postroll	addart	Il postroll utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
html5_overlay_initial	addart	L'overlay iniziale utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
html5_overlay_main	addart	L'overlay principale utilizzato nel player HTML5 utilizzato per i dispositivi mobili.
watermark	string	URL to the image of the watermark
watermark_width	int	Watermark resize width
watermark_height	int	Watermark height resize
watermark_opacity	float	Watermark transparency level
watermark_displaytime	int	Watermark dwell time in seconds
watermark_hide	boolean	`1` If the watermark disappears together with the player controls. `0` otherwise
watermark_link	string	URL to redirect by clicking on the watermark.
watermark_bottom	string	Placement of the watermark from the bottom
watermark_right	string	Placement of the watermark from the right
watermark_top	string	Placement of the watermark from the top
watermark_left	string	Placement of the watermark from the left
webtrekk_account	webtrekk	The associated Webtrekk object
ama_configuration	ama	The associated Akamai Media Analytics object
comscore_account	comscore	The associated Comscore object
nielsen_account	nielsen	The associated Nielsen object

Example of a curl request

curl -i -G -H "Accept: application/json" -H "access-token: Fun94nBf4YiaL20hG5np2Ki8mHtm9OCn4R6lPamNM8mNn7YFDRUvZveSbB0n6T" -X GET -d "search_string=title&search_limit=5" http://API_DOMAIN/rest/configuration.json

Example of a JSON response

[
	...
{
    "id":"39",
    "titolo":"Configuration title",
    "label":"conf1",
    "context_rules":{
    	"0":"http:\/\/www.meride.tv*",
    	"1":"http:\/\/www.mosaicolab.com*"
    	},
    "skin":"default",
    "data_inserimento":"2012-09-24 09:12:49",
    "responsive":"0",
    "background_color":"000000",
    "background_image":"",
    "autoplay":"1",
    "controlbar_visible":"1",
    "seekable":"1",
    "wmode":"direct",
    "skip_preroll":"",
    "skip_time":"",
    "setting_volume" : "-1",
    "adblock_policy":"",
    "adblock_policy_ad_video_id":null,
    "player_adv_manager":"default",
    "ima_vpaid_mode":null,
    "desktop_player":"flash",
    "preroll":{
        "tipo_adv":"dart",
        "id":"2",
        "titolo":"Google dart",
        "url_sorgente":"http:\/\/googledarturl.com/advertising.xml",
        "tags":"lorem, ipsum",
        "descrizione":"Lorem ispum dolor sit amet",
        "data_inserimento":"2012-09-21 20:26:18"
    },
    "postroll":null,
    "overlay_initial":{
        "tipo_adv":"dart",
        "id":"59",
        "tipo":"non-linear",
        "titolo":"Overlay",
        "url_sorgente":"http:\/\/googledarturl.com/advertising2.xml",
        "descrizione":"",
        "data_inserimento":"2012-12-17 11:38:26",
        "stay_time":"15"
        "after_time":"0"
    },
    "overlay_main":null,
    "html5_preroll":{
        "tipo_adv":"dart",
        "id":"2",
        "titolo":"Google dart",
        "url_sorgente":"http:\/\/googledarturl.com/advertising.xml",
        "tags":"lorem, ipsum",
        "descrizione":"Lorem ispum dolor sit amet",
        "data_inserimento":"2012-09-21 20:26:18"
    },
    "html5_postroll":null,
    "html5_overlay_initial":null,
    "html5_overlay_main":{
        "tipo_adv":"dart",
        "id":"33",
        "tipo":"non-linear",
        "titolo":"Overlay",
        "url_sorgente":"http:\/\/googledarturl.com/advertising3.xml",
        "descrizione":"",
        "data_inserimento":"2012-05-23 18:26:20",
        "fixed":"0",
        "after_time":"0"
        "stay_time":"15",
        "delay_time":"20",
        "max_width":"728",
        "max_height":"90"
    },
    "watermark":null,
    "watermark_width":null,
    "watermark_height":null,
    "watermark_opacity":null,
    "watermark_displaytime":null,
    "watermark_hide":null,
    "watermark_link":null,
    "watermark_bottom":null,
    "watermark_right":null,
    "watermark_top":null,
    "watermark_left":null,
    "webtrekk_account":null,
    "ama_configuration":null,
    "comscore_account" : {
        "id":"1",
        "titolo":"Comscore title",
        "clientid":"14267511",
        "predefinito":"1",
        "descrizione":null,
        "data_inserimento":"2013-02-06 17:11:03"
    },
    "nielsen_account" : null
}
	...
]