Meride API - Embed - Update

This page explains how to update elements Embed.

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

{resource-id}: the object ID

Attributes

Attribute Value Mandatory Default
title A non-empty string NO  
descrizione_breve A string NO  
description A string NO  
tags A string where each tag has the character , as a divider NO  
skin Il nome della skin del player. Le opzioni disponibili sono visualizzabili nel pannello Meride CMS NO default
width The width of the player NO 540
height The height of the player NO 302
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
primary_url A valid URL. This field is used for the DART tag replace rules NO  
secondary_url A valid URL. This field is used for the DART tag replace rules NO  
tertiary_url A valid URL. This field is used for the DART tag replace rules NO  
preroll_id L'ID del preroll da utilizzare (rispetto al tipo di preroll) nel player Flash per utenti desktop. Passare come valore una stringa vuota se si intende cancellare il preroll. 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. Passare come valore una stringa vuota se si intende cancellare il postroll. 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. Passare come valore una stringa vuota se si intende cancellare l'overlay iniziale. 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. Passare come valore una stringa vuota se si intende cancellare l'overlay principale. 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. Passare come valore una stringa vuota se si intende cancellare il preroll. 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. Passare come valore una stringa vuota se si intende cancellare il postroll. 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. Passare come valore una stringa vuota se si intende cancellare l'overlay iniziale. 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. Passare come valore una stringa vuota se si intende cancellare l'overlay principale. 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  
enable_subtitles_flash 1If you want to enable subtitle support in the flash version of the player. 0 otherwise NO 0
subtitles_flash_default the language code that will be used as default for the subtitles in the flash version of the player NO  
subtitles_bgcolor_flash the HEX code of the color you want for the subtitle background NO #000000
subtitles_textcolor_flash the HEX code of the color you want for the subtitle text NO #FFFFFF
subtitles_transparency_flash the transparency level of the subtitles. The possible values are: 0.8, 0.9, 1 NO 0.8
subtitles_fontsize_flash The size of the subtitle font NO 17
subtitles_fontfamily_flash The type of font to use for the subtitle text NO Arial, sans-serif
subtitles_marginbottom_flash The distance from the bottom of the player to the subtitle box NO 60
subtitle_file_flash_[lan] A reference to the location of the subtitle file on your disk. Accepted formats: vtt
A file will be loaded using the correct parameter for each language. For example, for Italian we will use the parameter subtitle_file_flash_it. List of supported languages
NO  
enable_subtitles_html5 1If you want to enable subtitle support in the HTML5 version of the player. 0 otherwise NO 0
subtitles_html5_default the language code that will be used as default for the subtitles in the HTML5 version of the player NO  
subtitles_bgcolor_html5 the HEX code of the color you want for the subtitle background NO #000000
subtitles_textcolor_html5 the HEX code of the color you want for the subtitle text NO #FFFFFF
subtitles_transparency_html5 the transparency level of the subtitles. The possible values are: 0.8, 0.9, 1 NO 0.8
subtitles_fontsize_html5 The size of the subtitle font NO 17
subtitles_fontfamily_html5 The type of font to use for the subtitle text NO Arial, sans-serif
subtitles_marginbottom_html5 The distance from the bottom of the player to the subtitle box NO 60
subtitle_file_html5_[lan] A reference to the location of the subtitle file on your disk. Accepted formats: vtt
A file will be loaded using the correct parameter for each language. For example, for Italian we will use the parameter subtitle_file_flash_it. List of supported languages
NO  
categoria_id L'ID delle categorie da associare separate dal carattere | NO  
application_published 1If you want to also publish the embed in applications. 0 otherwise NO 1
configuration_id L'ID delle configurazioni da associare separate dal carattere | NO  
ama_configuration_id L'ID di Meride della configurazione Akamai Media Analytics da utilizzare. Passare stringa vuota se si vuole cancellare l'eventuale configurazione associata NO  
comscore_account_id L'ID di Meride dell'account Comscore da utilizzare. Passare stringa vuota se si vuole cancellare l'eventuale account associato NO  
nielsen_account_id L'ID di Meride dell'account Nielsen da utilizzare. Passare stringa vuota se si vuole cancellare l'eventuale account associato NO  
Non è possibile modificare il video associato all'embed

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

Response

Field Value Description
id string Object ID
title string The title of the video
descrizione_breve string The associated short description
description string The associated complete description
tags string List of tags separated by commas
data_creazione string The create date that follows the format 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
width string The default width of the player
height string The default height of the player
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
primary_url string Un URL valido
secondary_url string Un URL valido
tertiary_url string Un URL valido
code string The embed code to insert in your HTML pages
video video The video source used by the embed
live live The live source used by the embed
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.
enable_subtitles_flash boolean 1 If support for subtitles in the flash player is active. 0 otherwise
subtitles_flash_default string The default language code for the subtitles of the flash player
subtitles_bgcolor_flash string The background color for the subtitles of the flash player
subtitles_textcolor_flash string The text color for the subtitles of the flash player
subtitles_transparency_flash float The transparency of the subtitles of the flash player
subtitles_fontsize_flash int The size of the subtitle font of the flash player
subtitles_fontfamily_flash string The type of subtitle font of the flash player
subtitles_marginbottom_flash string The bottom edge of the subtitles of the flash player
subtitles_files_flash array Set of subtitle files of the flash player
enable_subtitles_html5 boolean 1 If support for subtitles in the HTML5 player is active. 0 otherwise
subtitles_html5_default string The default language code for the subtitles of the HTML5 player
subtitles_bgcolor_html5 string The background color for the subtitles of the HTML5 player
subtitles_textcolor_html5 string The text color for the subtitles of the HTML5 player
subtitles_transparency_html5 float The transparency of the subtitles of the HTML5 player
subtitles_fontsize_html5 int The size of the subtitle font of the HTML5 player
subtitles_fontfamily_html5 string The font type of the subtitles of the HTML5 player
subtitles_marginbottom_html5 string The bottom edge of the subtitles of the HTML5 player
subtitles_files_html5 array Set of subtitle files of the HTML5 player
categorie categoria The set of category objects associated with the embed
application_published boolean 1 If the embed is published in applications. 0 otherwise
configurations configuration L'insieme degli oggetti configuration associati all'embed
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 embed" http://API_DOMAIN/rest/embed/39.json

Example of a JSON response

{
    "id":"39",
    "titolo":"Embed title",
    "descrizione_breve":"",
    "descrizione":"Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod",
    "tags":"",
    "skin":"default",
    "data_creazione":"2012-09-24 09:12:49",
    "width":"540",
    "height":"302",
    "responsive":"0",
    "autoplay":"1",
    "controlbar_visible":"1",
    "seekable":"1",
    "wmode":"direct",
    "skip_preroll":"",
    "skip_time":"",
    "setting_volume" : "-1",
    "primary_url":null,
    "secondary_url":null,
    "tertiary_url":null,
    "code":"<div class=\"meride-video-container\" id=\"meride-video-container\" data-embed=\"39\" data-customer=\"_customerid\" data-nfs=\"_customernfs\" data-width=\"540\" data-height=\"302\" data-autoplay=\"true\"><\/div>\r\n<script src=\"http:\/\/origin-mediawebink.meride.tv\/scripts\/0.1\/embed.js\"><\/script>",
    "video":{
        "id":"107",
        "titolo":"Super Mario",
        "descrizione_breve":"Super Mario Bros. System",
        "descrizione":"Lorem ipsum dolor sit amet, consectetur",
        "tags":"Nintendo, Arcade",
        "video_disponibile":"1",
        "data_inserimento":"2012-09-21 18:01:16",
        "preview_image":"http:\/\/example.com\/meride\/video\/images\/folder1\/28\/super_mario.jpg"
    },
    "live":null,
    "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"
    },
    "enable_subtitles_flash":0,
    "subtitles_flash_default":null,
    "subtitles_bgcolor_flash":"#000000",
    "subtitles_textcolor_flash":"#FFFFFF",
    "subtitles_transparency_flash":0.8,
    "subtitles_fontsize_flash":17,
    "subtitles_fontfamily_flash":"Arial, sans-serif",
    "subtitles_marginbottom_flash":60,
    "subtitles_files_flash":null,
    "enable_subtitles_html5":0,
    "subtitles_html5_default":null,
    "subtitles_bgcolor_html5":"#000000",
    "subtitles_textcolor_html5":"#FFFFFF",
    "subtitles_transparency_html5":0.8,
    "subtitles_fontsize_html5":17,
    "subtitles_fontfamily_html5":"Arial, sans-serif",
    "subtitles_marginbottom_html5":60,
    "subtitles_files_html5":null,
    "categorie":null,
    "application_published":1,
    "configurations":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
}
		    

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