Meride API - configuration - Update

This page explains how to update elements configuration.

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

{resource-id}: the object ID

Attributes

Attribute Value Mandatory Default
title A non-empty string NO  
label A non-empty string. A non-empty string. Specifica in questo campo un'etichetta di riconoscimento della configurazione. Questo campo sarà utilizzato per un'eventuale parametrizzazione del codice embed.

Aggiungendo l'attributo data-bulk-label='mylabel' al tag div del codice embed si forzerà l'embed a prendere le proprietà della configurazione indipendentemente dalla pagina che sta erogando

L'etichetta deve essere scelta univocamente per tutte le configurazioni inserite.

Non è possibile modificarne il valore una volta che la configurazione è stata associata ad uno o più embed
NO  
context_rules Regole di contesto della configurazione separate da carattere |.
By context rule we mean a rule on domains where the configuration will take effect.
Specifying the * character as the context rule means that the configuration will take effect in any domain. Each context rule, with the exception of the * rule, must start with the http or https protocol, followed by the domain name and ending with the * character indicating that the configuration takes effect on every page of the specified domain.

Ex:
- http://domain.com*
the configuration will take effect in all the URL's in the domain "domain.com"

- *
The configuration always takes effect

It is not possible to differentiate the context rules within the same domain
NO  
skin Il nome della skin del player. Le opzioni disponibili sono visualizzabili nel pannello Meride CMS NO default
responsive 1 if you want the player to be responsive. 0 otherwise NO 0
autoplay 1 if you want the video of the player to start in autoplay. 0 otherwise NO 0
controlbar_visible 0 if you want to hide the control bar in the player. 1 otherwise NO 1
seekable 0 if you want to disable the player scrolling forward. 1 otherwise NO 1
wmode The wmode property of the object / embed element on Flash player. Possible values:direct, window, opaque, transparent, gpu NO direct
skip_preroll 1 and if you want to bring up the link to skip the preroll. 0 otherwise NO 0
skip_time Integer. Specify the number of seconds after which the link appears to skip the preroll NO 5
setting_volume Google DART volume.
-1 Predefined. none No check. defaultOn Volume active. defaultOff Volume disabled
NO -1
preroll_id L'ID del preroll da utilizzare (rispetto al tipo di preroll) nel player Flash per utenti desktop. Qual'ora si vogliano associare più di un preroll passare una stringa della forma id1|id2|id3 con i 3 id dei preroll che si vogliono associare. E' possibile associare più di un singolo preroll solo di adv di tipo dart linear NO  
preroll_tipo Il tipo di preroll da utilizzare. (dart per oggetti Google DART, mast per oggetti MAST, vast per oggetti VAST, video per contenuti Roll) NO  
postroll_id L'ID dell'postroll da utilizzare (rispetto al tipo di endroll) nel player Flash per utenti desktop. NO  
postroll_tipo Il tipo di postroll da utilizzare. (dart per oggetti Google DART, vast per oggetti VAST, video per contenuti Roll) NO  
overlay_initial_id L'ID dell'overlay iniziale da associare nel player Flash per utenti desktop. Possono essere assegnati come overlay solo adv dart non-linear. Se l'overlay iniziale è specificato bisogna obbligatoriamente settare anche i campi overlay_initial_stay_time e overlay_initial_after_time NO  
overlay_initial_after_time Intero che esprime in secondi il delay di entrata dell'overlay iniziale. NO  
overlay_initial_stay_time Intero che esprime in secondi il tempo di permanenza dell'overlay iniziale. Il tempo di permamenza deve essere di minimo 15 secondi NO  
overlay_main_id L'ID dell'overlay principale da associare nel player Flash per utenti desktop. Possono essere assegnati come overlay solo adv dart non-linear. Se l'overlay principale è specificato bisogna obbligatoriamente settare anche i campi overlay_initial_fixed, overlay_initial_after_time, overlay_main_max_width e overlay_main_max_height NO  
overlay_main_after_time Intero che esprime in secondi il delay di entrata dell'overlay principale. NO  
overlay_main_fixed 1 If you want the main overlay to remain fixed throughout the duration of the embed. 0 Se si vuole temporizzare le chiamate all'overlay principale. Se viene scelta la modalità temporizzata bisogna obbligatoriamente specificare un valore anche per i campi overlay_main_stay_time e overlay_main_delay_time NO  
overlay_main_stay_time Intero che esprime in secondi il tempo di permanenza della singola chiamata all'overlay principale. Il tempo di permamenza deve essere di minimo 15 secondi. Il valore per questo campo va specificato solo se l'overlay non è fisso NO  
overlay_main_delay_time Intero che esprime in secondi l'intervallo di tempo tra una chiamata e l'altra all'overlay principale. Il valore per questo campo va specificato solo se l'overlay non è fisso NO  
overlay_main_max_width Intero che esprime la dimensione massima in pixel della larghezza dell'overlay principale. -1 Se si vuole lasciare libera la dimensione.

La coppia larghezza e altezza dell'overlay deve essere una tra le seguenti: 300x250180x150160x600728x90300x600550x480
NO  
overlay_main_max_height Intero che esprime la dimensione massima in pixel dell'altezza dell'overlay principale. -1 Se si vuole lasciare libera la dimensione.

La coppia larghezza e altezza dell'overlay deve essere una tra le seguenti: 300x250180x150160x600728x90300x600550x480
NO  
html5_preroll_id L'ID del preroll da utilizzare (rispetto al tipo di preroll) nel player HTML5 utilizzato per i dispositivi mobili. Qual'ora si vogliano associare più di un preroll passare una stringa della forma id1|id2|id3 con i 3 id dei preroll che si vogliono associare. Solo adv di tipo dart sono supportati dal player HTML5 NO  
html5_preroll_tipo Il tipo di preroll da utilizzare. (dart per oggetti Google DART) NO  
html5_postroll_id L'ID dell'postroll da utilizzare (rispetto al tipo di endroll) nel player HTML5 utilizzato per i dispositivi mobili. Solo adv di tipo dart sono supportati dal player HTML5 NO  
html5_postroll_tipo Il tipo di postroll da utilizzare. (dart per oggetti Google DART) NO  
html5_overlay_initial_id L'ID dell'overlay iniziale da associare nel player HTML5 utilizzato per i dispositivi mobili. Possono essere assegnati come overlay solo adv dart non-linear. Se l'overlay iniziale è specificato bisogna obbligatoriamente settare anche i campi html5_overlay_initial_stay_time e html5_overlay_initial_after_time NO  
html5_overlay_initial_after_time Intero che esprime in secondi il delay di entrata dell'overlay iniziale per i dispositivi mobili. NO  
html5_overlay_initial_stay_time Intero che esprime in secondi il tempo di permanenza dell'overlay iniziale. Il tempo di permamenza deve essere di minimo 15 secondi NO  
html5_overlay_main_id L'ID dell'overlay principale da associare nel player HTML5 utilizzato per i dispositivi mobili. Possono essere assegnati come overlay solo adv dart non-linear. Se l'overlay principale è specificato bisogna obbligatoriamente settare anche i campi html5_overlay_initial_fixed, html5_overlay_initial_after_time, html5_overlay_main_max_width e html5_overlay_main_max_height NO  
html5_overlay_main_after_time Intero che esprime in secondi il delay di entrata dell'overlay principale per i dispositivi mobili. NO  
html5_overlay_main_fixed 1 If you want the main overlay to remain fixed throughout the duration of the embed. 0 Se si vuole temporizzare le chiamate all'overlay principale. Se viene scelta la modalità temporizzata bisogna obbligatoriamente specificare un valore anche per i campi html5_overlay_main_stay_time e html5_overlay_main_delay_time NO  
html5_overlay_main_stay_time Intero che esprime in secondi il tempo di permanenza della singola chiamata all'overlay principale. Il tempo di permamenza deve essere di minimo 15 secondi. Il valore per questo campo va specificato solo se l'overlay non è fisso NO  
html5_overlay_main_delay_time Intero che esprime in secondi l'intervallo di tempo tra una chiamata e l'altra all'overlay principale. Il valore per questo campo va specificato solo se l'overlay non è fisso NO  
html5_overlay_main_max_width Intero che esprime la dimensione massima in pixel della larghezza dell'overlay principale. -1 Se si vuole lasciare libera la dimensione.

La coppia larghezza e altezza dell'overlay deve essere una tra le seguenti: 300x250180x150160x600728x90300x600550x480
NO  
html5_overlay_main_max_height Intero che esprime la dimensione massima in pixel dell'altezza dell'overlay principale. -1 Se si vuole lasciare libera la dimensione.

La coppia larghezza e altezza dell'overlay deve essere una tra le seguenti: 300x250180x150160x600728x90300x600550x480
NO  
ama_configuration_id L'ID di Meride della configurazione Akamai Media Analytics da utilizzare. Se non specificato viene automaticamente associata la configurazione predefinita se esiste. Passare stringa vuota se non si vuole associare alcuna configurazione NO  
comscore_account_id L'ID di Meride dell'account Comscore da utilizzare. Se non specificato viene automaticamente associato l'account Comscore predefinito se esiste. Passare stringa vuota se non si vuole associare alcun account NO  
nielsen_account_id L'ID di Meride dell'account Nielsen da utilizzare. Se non specificato viene automaticamente associato l'account Nielsen predefinito se esiste. Passare stringa vuota se non si vuole associare alcun account NO  

Note The advertisements associated with a single configuration must all be of the same type

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
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
preroll advideo | advast | addart | admast 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 | advast | 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.
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, mast per oggetti MAST, vast per oggetti VAST, video per contenuti Roll)

Example of a curl request

curl -i -H "Accept: application/json" -H "access_token: Zuqk4nX6SfiaL20cO6np2i29Xyhn6NCW8T636UZPZ8QA0GDFDRUvZNuNbB08ft" -H "X-HTTP-Method-Override: PUT" -X POST -d "titolo=Titolo updated configuration" http://API_DOMAIN/rest/configuration/39.json

Example of a JSON response

{
    "id":"39",
    "titolo":"Titolo updated configuration",
    "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",
    "autoplay":"1",
    "controlbar_visible":"1",
    "seekable":"1",
    "wmode":"direct",
    "skip_preroll":"",
    "skip_time":"",
    "setting_volume" : "-1",
    "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"
    },
    "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
}
		    

Note The updated object will be returned as a response

Note The PUT method is not supported by all systems. In case of problems, add the parameter to the Header of the callX-HTTP-Method-Override: PUT ed utilizzare il metodo POST come default