Meride API - Bulk - Read

This page explains how to read Bulk elements.

Entity name: bulk.

GET http://API_DOMAIN/rest/v2/bulk.{format}

Attributes

No parameter

Response

A collection / array of elements

Field Value Description
id string Object ID
title string The title of the video
label string The label field associated with the configuration
context_rules array Set of context rules
skin string The skin of the player chosen during create
created_at 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)
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.
player_color string The color of the player in HEX code.
autoplay boolean 1 if the video is published in autoplay. 0 otherwise
mute boolean 1 if the video is published in mute mode. 0 otherwise
controlbar_visible boolean 0 if the player's control bar is hidden. 1 otherwise
controlbar_auto_hide boolean 1 if the player’s control bar becomes hidden automatically. 0 otherwise
seekable boolean 0 if the player's scroll bar is disabled. 0 otherwise
preload boolean 1 if preload video is active. 0 otherwise
pip boolean 1 if Picture in Picture mode is active. 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
desktop_player string Player type for desktop users
scrollmode_enabled boolean 1 If "Scroll Mode" is active. 0 otherwise
scrollmode_mute_on_mouse_over boolean 1 If within "Scroll Mode" the video becomes mute on mouse over. 0 otherwise
scrollmode_destroy_on json array List of events where the player is expected to be destroyed
preroll advideo | addart Object that describes all the desktop prerolls associated with the embed and its configurations
midroll addart Object that describes all the desktop midrolls associated with the embed and its configurations
postroll advideo | addart Object describing the desktop postroll associated with the embed
overlay_initial addart Object that describes the initial desktop overlay associated with the embed
overlay_main addart Object that describes the main desktop overlay associated with the embed and its configuration
mobile_preroll advideo | addart Object that describes all the mobile prerolls associated with the embed and its configurations
mobile_midroll addart Object that describes all the mobile midrolls associated with the embed and its configurations
mobile_postroll advideo | addart Object describing the mobile postroll associated with the embed
mobile_overlay_initial addart Object describing the initial mobile overlay associated with the embed
mobile_overlay_main addart Object that describes the main mobile overlay associated with the embed and its configuration
player_adv_manager string Player Ad Manager
ima_vpaid_mode string IMA Vpaid Mode
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 request

curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET  http://API_DOMAIN/rest/v2/bulk.json
            

Example of a JSON response

{
	"current_page": 1,
	"data": [
	{
	    "id": "2",
	    "title": "Bulk Configuration title",
	    "label": "bulk_label",
	    "context_rules": [
	        "*"
	    ],
	    "skin": "default",
	    "created_at": "2018-05-03 18:41:34",
	    "responsive": "1",
	    "background_color":"000000",
	    "background_image":"",	
	    "player_color":"FFCE3E",
	    "autoplay": "0",
	    "mute": "0",
	    "controlbar_visible": "1",
	    "controlbar_auto_hide": "1",
	    "seekable": "1",
	    "preload": "1",
	    "pip": "0",
	    "wmode": "direct",
	    "skip_preroll": "0",
	    "skip_time": "5",
	    "setting_volume": "-1",
	    "desktop_player": "html5",
	    "scrollmode_enabled": "0",
	    "scrollmode_mute_on_mouse_over": "1",
	    "scrollmode_destroy_on": [],
	    "preroll": [
	        {
		    "adv_type": "dart",
		    "id": "2",
		    "type": "linear",
		    "title": "DART title",
		    "source_url": "http://tag_dart.com",
		    "replace_rules": [
		        {
		            "subject": "[random-number]",
		            "value": "random-number"
		        },
		        {
		            "subject": "[url]",
		            "value": "url-video"
		        }
		    ],
		    "description": "description",
		    "created_at": "2018-06-11 15:51:54"
		},
	        {
		    "adv_type": "dart",
		    "id": "2",
		    "type": "linear",
		    "title": "DART title",
		    "source_url": "http://tag_dart.com",
		    "replace_rules": [
		        {
		            "subject": "[random-number]",
		            "value": "random-number"
		        },
		        {
		            "subject": "[url]",
		            "value": "url-video"
		        }
		    ],
		    "description": "description",
		    "created_at": "2018-06-11 15:51:54"
		},
	    ],
	    "midroll": null,
	    "postroll": null,
	    "overlay_initial": {
	        "adv_type": "dart",
	        "id": "3",
	        "type": "non-linear",
	        "title": "Google example non-linear",
	        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
	        "replace_rules": [],
	        "description": "",
	        "created_at": "2017-08-02 18:31:10",
	        "after_time": 60,
	        "stay_time": 30
	    },
	    "overlay_main": {
	        "adv_type": "dart",
	        "id": "3",
	        "type": "non-linear",
	        "title": "Google example non-linear",
	        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
	        "replace_rules": [],
	        "description": "",
	        "created_at": "2017-08-02 18:31:10",
	        "fixed": 0,
	        "after_time": 10,
	        "stay_time": 20,
	        "delay_time": 60,
	        "max_width": "300",
	        "max_height": "250"
	    },
	    "mobile_preroll": [
	        {
		    "adv_type": "dart",
		    "id": "2",
		    "type": "linear",
		    "title": "DART title",
		    "source_url": "http://tag_dart.com",
		    "replace_rules": [
		        {
		            "subject": "[random-number]",
		            "value": "random-number"
		        },
		        {
		            "subject": "[url]",
		            "value": "url-video"
		        }
		    ],
		    "description": "description",
		    "created_at": "2018-06-11 15:51:54"
		},
	        {
		    "adv_type": "dart",
		    "id": "2",
		    "type": "linear",
		    "title": "DART title",
		    "source_url": "http://tag_dart.com",
		    "replace_rules": [
		        {
		            "subject": "[random-number]",
		            "value": "random-number"
		        },
		        {
		            "subject": "[url]",
		            "value": "url-video"
		        }
		    ],
		    "description": "description",
		    "created_at": "2018-06-11 15:51:54"
		},
	    ],
	    "mobile_midroll": null,
	    "mobile_postroll": null,
	    "mobile_overlay_initial": {
	        "adv_type": "dart",
	        "id": "3",
	        "type": "non-linear",
	        "title": "Google example non-linear",
	        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
	        "replace_rules": [],
	        "description": "",
	        "created_at": "2017-08-02 18:31:10",
	        "after_time": 60,
	        "stay_time": 30
	    },
	    "mobile_overlay_main": {
	        "adv_type": "dart",
	        "id": "3",
	        "type": "non-linear",
	        "title": "Google example non-linear",
	        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
	        "replace_rules": [],
	        "description": "",
	        "created_at": "2017-08-02 18:31:10",
	        "fixed": 0,
	        "after_time": 10,
	        "stay_time": 20,
	        "delay_time": 60,
	        "max_width": "300",
	        "max_height": "250"
	    },
	
	    "player_adv_manager": "ima",
	    "ima_vpaid_mode": "ENABLED",
	    "watermark": null,
	    "watermark_width": null,
	    "watermark_height": null,
	    "watermark_opacity": null,
	    "watermark_displaytime": null,
	    "watermark_hide": "0",
	    "watermark_link": null,
	    "watermark_bottom": null,
	    "watermark_right": null,
	    "watermark_top": null,
	    "watermark_left": null,
	    "webtrekk_account": {
		    "id":"2",
		    "title":"Webtrekk title",
		    "track_id":"track_id",
		    "track_domain":"track_domain",
		    "mg":null,
		    "description":null,
		    "default":"1",
		    "created_at":"2013-02-06 18:12:03"
		},
	    "ama_configuration": {
		    "id":"2",
		    "title":"Ama title",
		    "default":"1",
		    "description":null,
		    "url_beacon":"http://example.com/beacon.xml",
		    "created_at":"2013-05-18 17:00:37"
		},
	    "comscore_account": {
			"id":"2",
			"title":"Comscore title",
			"clientid":"14267511",
			"adtrack_start":"",
			"adtrack_complete":"",
			"adtrack_standard":"",
			"default":"1",
			"description":null,
			"created_at":"2013-02-06 17:11:03",
		},
	    "nielsen_account": {
		    "id":"2",
		    "title":"Nielsen title",
		    "clientid":"clientid",
		    "vcid":"vcid",
		    "cisuffix":"",
		    "sfcode":"it",
		    "prod":"prod",
		    "description":null,
		    "default":"1",
		    "created_at":"2013-02-06 18:12:03"
		}}],
	"first_page_url": "http://API_DOMAIN/rest/v2/bulk.json?search_page=1&search_for_page=100",
	"from": 1,
	"last_page": 1,
	"last_page_url": "http://API_DOMAIN/rest/v2/bulk.json?search_page=1&search_for_page=100",
	"next_page_url": null,
	"path": "http://API_DOMAIN/rest/v2/bulk.json",
	"per_page": 100,
	"prev_page_url": null,
	"to": 1,
	"total": 1
}            
PHP SDK documentation
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->all('bulk');
            

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

{resource-id}: the object ID

Attributes

No parameter

Response

A collection / array of elements

Field Value Description
id string Object ID
title string The title of the video
label string The label field associated with the configuration
context_rules array Set of context rules
skin string The skin of the player chosen during create
created_at 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)
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.
player_color string The color of the player in HEX code.
autoplay boolean 1 if the video is published in autoplay. 0 otherwise
mute boolean 1 if the video is published in mute mode. 0 otherwise
controlbar_visible boolean 0 if the player's control bar is hidden. 1 otherwise
controlbar_auto_hide boolean 1 if the player’s control bar becomes hidden automatically. 0 otherwise
seekable boolean 0 if the player's scroll bar is disabled. 0 otherwise
preload boolean 1 if preload video is active. 0 otherwise
pip boolean 1 if Picture in Picture mode is active. 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
desktop_player string Player type for desktop users
scrollmode_enabled boolean 1 If "Scroll Mode" is active. 0 otherwise
scrollmode_mute_on_mouse_over boolean 1 If within "Scroll Mode" the video becomes mute on mouse over. 0 otherwise
scrollmode_destroy_on json array List of events where the player is expected to be destroyed
preroll advideo | addart Object that describes all the desktop prerolls associated with the embed and its configurations
midroll addart Object that describes all the desktop midrolls associated with the embed and its configurations
postroll advideo | addart Object describing the desktop postroll associated with the embed
overlay_initial addart Object that describes the initial desktop overlay associated with the embed
overlay_main addart Object that describes the main desktop overlay associated with the embed and its configuration
mobile_preroll advideo | addart Object that describes all the mobile prerolls associated with the embed and its configurations
mobile_midroll addart Object that describes all the mobile midrolls associated with the embed and its configurations
mobile_postroll advideo | addart Object describing the mobile postroll associated with the embed
mobile_overlay_initial addart Object describing the initial mobile overlay associated with the embed
mobile_overlay_main addart Object that describes the main mobile overlay associated with the embed and its configuration
player_adv_manager string Player Ad Manager
ima_vpaid_mode string IMA Vpaid Mode
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 request

curl -i -H "Accept: application/json" -H "access-token: [your-access-token]" -X GET  http://API_DOMAIN/rest/v2/bulk/2.json
            

Example of a JSON response

{
    "id": "2",
    "title": "Bulk Configuration title",
    "label": "bulk_label",
    "context_rules": [
        "*"
    ],
    "skin": "default",
    "created_at": "2018-05-03 18:41:34",
    "responsive": "1",
    "background_color":"000000",
    "background_image":"",	
    "player_color":"FFCE3E",
    "autoplay": "0",
    "mute": "0",
    "controlbar_visible": "1",
    "controlbar_auto_hide": "1",
    "seekable": "1",
    "preload": "1",
    "pip": "0",
    "wmode": "direct",
    "skip_preroll": "0",
    "skip_time": "5",
    "setting_volume": "-1",
    "desktop_player": "html5",
    "scrollmode_enabled": "0",
    "scrollmode_mute_on_mouse_over": "1",
    "scrollmode_destroy_on": [],
    "preroll": [
        {
	    "adv_type": "dart",
	    "id": "2",
	    "type": "linear",
	    "title": "DART title",
	    "source_url": "http://tag_dart.com",
	    "replace_rules": [
	        {
	            "subject": "[random-number]",
	            "value": "random-number"
	        },
	        {
	            "subject": "[url]",
	            "value": "url-video"
	        }
	    ],
	    "description": "description",
	    "created_at": "2018-06-11 15:51:54"
	},
        {
	    "adv_type": "dart",
	    "id": "2",
	    "type": "linear",
	    "title": "DART title",
	    "source_url": "http://tag_dart.com",
	    "replace_rules": [
	        {
	            "subject": "[random-number]",
	            "value": "random-number"
	        },
	        {
	            "subject": "[url]",
	            "value": "url-video"
	        }
	    ],
	    "description": "description",
	    "created_at": "2018-06-11 15:51:54"
	},
    ],
    "midroll": null,
    "postroll": null,
    "overlay_initial": {
        "adv_type": "dart",
        "id": "3",
        "type": "non-linear",
        "title": "Google example non-linear",
        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
        "replace_rules": [],
        "description": "",
        "created_at": "2017-08-02 18:31:10",
        "after_time": 60,
        "stay_time": 30
    },
    "overlay_main": {
        "adv_type": "dart",
        "id": "3",
        "type": "non-linear",
        "title": "Google example non-linear",
        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
        "replace_rules": [],
        "description": "",
        "created_at": "2017-08-02 18:31:10",
        "fixed": 0,
        "after_time": 10,
        "stay_time": 20,
        "delay_time": 60,
        "max_width": "300",
        "max_height": "250"
    },
    "mobile_preroll": [
        {
	    "adv_type": "dart",
	    "id": "2",
	    "type": "linear",
	    "title": "DART title",
	    "source_url": "http://tag_dart.com",
	    "replace_rules": [
	        {
	            "subject": "[random-number]",
	            "value": "random-number"
	        },
	        {
	            "subject": "[url]",
	            "value": "url-video"
	        }
	    ],
	    "description": "description",
	    "created_at": "2018-06-11 15:51:54"
	},
        {
	    "adv_type": "dart",
	    "id": "2",
	    "type": "linear",
	    "title": "DART title",
	    "source_url": "http://tag_dart.com",
	    "replace_rules": [
	        {
	            "subject": "[random-number]",
	            "value": "random-number"
	        },
	        {
	            "subject": "[url]",
	            "value": "url-video"
	        }
	    ],
	    "description": "description",
	    "created_at": "2018-06-11 15:51:54"
	},
    ],
    "mobile_midroll": null,
    "mobile_postroll": null,
    "mobile_overlay_initial": {
        "adv_type": "dart",
        "id": "3",
        "type": "non-linear",
        "title": "Google example non-linear",
        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
        "replace_rules": [],
        "description": "",
        "created_at": "2017-08-02 18:31:10",
        "after_time": 60,
        "stay_time": 30
    },
    "mobile_overlay_main": {
        "adv_type": "dart",
        "id": "3",
        "type": "non-linear",
        "title": "Google example non-linear",
        "source_url": "http://pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dimageoverlay&adtest=on",
        "replace_rules": [],
        "description": "",
        "created_at": "2017-08-02 18:31:10",
        "fixed": 0,
        "after_time": 10,
        "stay_time": 20,
        "delay_time": 60,
        "max_width": "300",
        "max_height": "250"
    },

    "player_adv_manager": "ima",
    "ima_vpaid_mode": "ENABLED",
    "watermark": null,
    "watermark_width": null,
    "watermark_height": null,
    "watermark_opacity": null,
    "watermark_displaytime": null,
    "watermark_hide": "0",
    "watermark_link": null,
    "watermark_bottom": null,
    "watermark_right": null,
    "watermark_top": null,
    "watermark_left": null,
    "webtrekk_account": {
	    "id":"2",
	    "title":"Webtrekk title",
	    "track_id":"track_id",
	    "track_domain":"track_domain",
	    "mg":null,
	    "description":null,
	    "default":"1",
	    "created_at":"2013-02-06 18:12:03"
	},
    "ama_configuration": {
	    "id":"2",
	    "title":"Ama title",
	    "default":"1",
	    "description":null,
	    "url_beacon":"http://example.com/beacon.xml",
	    "created_at":"2013-05-18 17:00:37"
	},
    "comscore_account": {
		"id":"2",
		"title":"Comscore title",
		"clientid":"14267511",
		"adtrack_start":"",
		"adtrack_complete":"",
		"adtrack_standard":"",
		"default":"1",
		"description":null,
		"created_at":"2013-02-06 17:11:03",
	},
    "nielsen_account": {
	    "id":"2",
	    "title":"Nielsen title",
	    "clientid":"clientid",
	    "vcid":"vcid",
	    "cisuffix":"",
	    "sfcode":"it",
	    "prod":"prod",
	    "description":null,
	    "default":"1",
	    "created_at":"2013-02-06 18:12:03"
	}}            
PHP SDK documentation
$merideApi = new Meride\Api('[your-auth-code]', 'http://API_DOMAIN/', 'v2');
$response = $merideApi->read('bulk', 2);