Page Comparison

Table of Contents

...

Code Block

In [1]: tag = springserve.supply_tags.get(28852)

In [2]: tag.name = "I want to change the name"

In [3]: changed = tag.save()


In [4]: changed.ok
Out [4]: True

In [5]: print changed.name

"I want to change the name"

Note that when enabling post_imp_detection, you must also set at least one of post_imp_percentage_whiteops, post_imp_percentage_moat, post_imp_percentage_ias to >0 before saving your changes.

REST API

PUT /api/v0/supply_tags/<id>

...

NOTE: Enabling Open Market in the API without specifying bidders will add all eligible bidders.

Adding Event Pixels to a Supply Tag

SDK

Code Block

In [1]: import springserve

In [2]: tag = springserve.supply_tags.get(123456)

In [3]: tag.tag_pixels = [{'pixel_type':'AdImpression', 'pixel_url':'https://springserve.com/', 
		'pixel_format':'image'}]

In [4]: saved_tag = tag.save()

In [5]: print saved_tag.ok, saved_tag.tag_pixels
True, [{'id': 244, 'pixel_type': 'AdImpression', 'pixel_url': 'https://springserve.com/', 
		'pixel_format': 'image', 'created_at': '2021-03-19T14:30:06.675Z'}]

...

Code Block

{    
"id": 123456, 
"account_id": 1,
	... 
     
"pod": {        
	"id": 345,        
	"max_duration": 200,        
	"custom_ad_slot_duration": true,        
	"unfilled_slot_opt_out_enabled": false,        
	"max_unfilled_slots": null,        
	"ad_slots": [            
		{                
			"id": 764,                
			"position": 1,                
			"min_duration": null,                
			"max_duration": null            
		},            
		{                
			"id": 763,                
			"position": 2,                
			"min_duration": null,                
			"max_duration": null            
		},            
		{                
			"id": 762,                
			"position": 3,                
			"min_duration": 40,                
			"max_duration": 60            
		}]    
	}
}

Object Descriptions

Object Name	Value Type	Object Description	Example	Notes
id	integer	supply tag ID	25530
account_id	integer	account ID	391
name	string	supply tag name	"API Example Router"
active	boolean	status of supply tag	true / false
rate	integer	rate	70 / 10.2	See "payment_terms" CPM - CPM rate paid for inventory. CPM Rev Share - rate at which you pay revenue share for inventory. % Dynamic - margin added to demand. %
payment_terms	string	payment terms	"Rev-Share" / "CPM" / "Dynamic"	Dynamic - Pricing will be passed via the {{PRICE_PAID}} macro. Please make sure this macro is implemented in your exported tag. Price must be a CPM value.
environment	string	supply device environment type	"desktop" / "mobile_web" / "in_app" / "ctv"
domain_targeting	string	domain targeting type	"All" / "Allowlist" / "Blocklist"	use for environment "desktop" or "mobile_web". use in conjunction with domain_list_ids
domain_list_ids	array integer	ID of domain lists	[211852, 123456]	created under targeting tab in UI. use in conjunction with domain_targeting
app_name__targeting	string	app name targeting type	"All" / "Allowlist" / "Blocklist"	use for environment "in_app" or "ctv". use in conjunction with app_name_list_ids
app_name_list_ids	array	ID of app name lists	[527, 5352]	created under targeting tab in UI. use in conjunction with app_name_targeting
app_bundle_targeting	string	app bundle targeting active	"All" / "Allowlist" / "Blocklist"	use for environment "in_app" or "ctv". use in conjunction with app_bundle_list_ids
app_bundle_list_ids	array integer	ID of app bundle lists	[250761, 247375]	created under targeting tab in UI. use in conjunction with app_bundle_targeting
ip_targeting	string	IP targeting active	"All" / "Allowlist" / "Blocklist"	use in conjunction with ip_list_ids
ip_list_ids	array integer	ID of IP lists	[164, 907]	created under targeting tab in UI. use in conjunction with ip_targeting
advertiser_domain_targeting	string	advertiser domain targeting type	"All" / "Allowlist" / "Blocklist"	use in conjunction with advertiser_domain_list_ids
advertiser_domain_list_ids	array integer	ID of advertiser domain lists	[433, 484]	created under targeting tab in UI. use in conjunction with advertiser_domain_targeting
blocking_unknown_advertiser_domains	boolean	toggle to block unknown advertiser domains	true / false	Blocks all SSHB and Open Market demand tags that don't return an Advertiser Domain in the VAST response
post_imp_detection_enabled	boolean	post impression detection active	true / false	specify the portion of impressions on which to run verification. sampling rates are independant per verification provider. use in conjunction with below post_imp_percentage fields
post_imp_percentage_whiteops	integer	post impression percentage Whiteops (HUMAN)	0 - 100	use in conjunction with below post_imp_detection_enabled
post_imp_percentage_ias	integer	post impression percentage IAS	0 - 100	use in conjunction with below post_imp_detection_enabled
post_imp_percentage_moat	integer	post impression percentage MOAT	0 - 100	use in conjunction with below post_imp_detection_enabled
post_imp_percentage_protected	integer	post impression percentage Protected	0 - 100	use in conjunction with below post_imp_detection_enabled
post_imp_percentage_forensiq	integer	post impression percentage ForensIQ	0 - 100	use in conjunction with below post_imp_detection_enabled
pre_bid_blocking_enabled	boolean	pre-bid filtering active	true / false
pre_bid_blocking_components	array string	pre-bid filtering providers	["springserve", "whiteops", "protected"]	specify percentages using post_imp_percentage for providers
key_ids	array integer	KVPs included in reporting	[2102, 3124]	max 15 reporting keys per router
note	string	notes	"notes about router"
min_aspect_ratio	string	min aspect ratio as float	"0.563"	9:16 (0.56)
max_aspect_ratio	string	max aspect ratio as float	"1.777"	16:9 (1.78)
format	string	ad format type	"video" / "tile" / "audio"
third_party_overrides	boolean			n/a
player_sizes	array integer	player size targeting	["xs", "s", "m", "l", "xl", "u"]	X-Small (< 250px) Small (250-349) Med (350-500) Large (501-799) X-Large (≥ 800) Unknown
user_agent_devices	array string	allowed device targeting	["Computer", "Mobile Web", "Mobile In-app", "Tablet Web", "Tablet In-app", "Games Console", "CTV", "Set-top Box", "Other"]	[] - empty array targets all devices
user_agent_brands	array string	allowed device brand targeting	["Samsung", "Philips", "Panasonic", "Hisense", "Vizio", "Sanyo", "Magnavox", "Android TV", "LG", "Comcast", "Other Connected TV", "Apple TV", "Roku", "Fire TV", "Chromecast", "Smartcast by Vizio"]	[] - empty array targets all brands
user_agent_operating_systems	array string	allowed OS targeting	["Android", "iOS", "Linux", "Windows", "Mac OS X", "Chrome OS", "Fire OS", "Xbox OS", "VIZIO SmartCast", "Tizen", "Roku OS", "webOS TV", "Other"]	[] - empty array targets all operating systems
user_agent_browsers	array string	allow browser targeting	["Chrome", "Edge", "Firefox", "Safari", "IE", "Chromium", "Chrome Mobile", "WebView", "Android", "Samsung Browser", "Facebook on Android", "Facebook on iOS", "Mobile Safari", "Roku App"]	[] - empty array targets all browsers
segment_targeting_enabled	boolean	audience segment targeting active	true / false	use in conjunction with segment_groups
segment_groups	array object	audience segment targeting groups and types	[ { "id": 28839, "group": "1", "white_list": true, "segment_group_type": "segments", "segment_ids": [ 10869, 10004 ], "partner_segment_ids": [] } ]	use multiple groups for OR targeting and same group for AND targeting. "whitelist": true/false, for allow or block user segments
media_file_mime_type_targeting	boolean	mime type targeting	true / false
media_file_mime_types	array string	allowed mime types	["application/dash+xml", "application/javascript", "application/json", "application/octet-stream", "application/vnd.apple.mpegurl", "application/x-mpegURL", "application/x-shockwave-flash", "video/3gpp", "video/hls", "video/m3u8", "video/mov", "video/mp4", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/wmv", "video/x-flv", "video/x-m4v", "video/x-ms-wmv"]
blocking_unknown_media_file_mime_type	boolean	block unknown mime types	true / false
media_file_duration_targeting	boolean	media file targeting active	true / false	set media_file_min_duration and media_file_max_duration to null for all durations when false. specify min and max durations for true
media_file_min_duration	integer	media file targeting min duration	10 / null	unit:seconds
media_file_max_duration	integer	media file targeting max duration	30 / null	unit:seconds
blocking_unknown_media_file_duration	boolean	block unknown durations toggle	true / false
media_file_bit_rate_targeting	boolean	media file bitrate targeting active	true / false	set media_file_min_bit_rate and media_file_max_bit_rate to null for all bitrates when false. specify min and max bitrates for true
media_file_min_bit_rate	integer	media file bitrate targeting min bitrate	1000 / null	unit:kbps
media_file_max_bit_rate	integer	media file bitrate targeting max bitrate	5000 / null	unit:kbps
blocking_unknown_media_file_bit_rate	boolean	block unknown bitrates toggle	true / false
targeted_macros_enabled	boolean	content attribute targeting active	true / false
targeted_macros	array	content attribute targeting	[ { "id": 20135, "macro_param": "{{CHANNEL_NAME}}", "list_type": "white_list", "source_type": "values", "targeted_values": [ "12345" ], "parameter_list_ids": [], "param_required": false, "created_at": "2023-07-18T11:41:40.835Z" } ]	"source_type": "values" / "lists" for lists use "parameter_list_ids" to specify id's
blocking_unknown_media_containers	boolean	block unknown media containers	true / false
media_file_media_container_targeting	boolean	allowed media containers targeting active	true / false
media_file_media_containers	array string	allowed media containers	[ "MPEG-41", "MPEG-42" ]
media_file_audio_volume_targeting	boolean	media file audio volume targeting active	true / false
media_file_audio_volume_mean	integer	media file audio volume targeting mean volume	-17	unit: dBs
blocking_unknown_media_file_audio_volume	boolean	block unknown media file audio volume	true / false
blocking_vast_containing_companion_ads	boolean	block vast containing companion ads	true / false
removing_companion_ads_from_vast	boolean	remove companion ads from vast containing companion ads	true / false	blocking_vast_containing_companion_ads supersedes removing_companion_ads_from_vast
country_source	string	country targeting source	"list" / "values"	use in conjunction with either country_list_ids if value is "lists" or country_codes if value is "values"
country_list_ids	array integer	ID of country lists	[184]	use in conjunction with country_source with value "lists".
country_white_list	boolean	country targeting include / exclude	true / false	true - include false - exclude
country_codes	array string	country code	["UK", "US", "IT"]	ISO 3166 Alpha-2 codes
dma_source	string	DMA targeting source	"list" / "values"	use in conjunction with either country_list_ids if value is "lists" or country_codes if value is "values"
dma_list_ids	array integer	ID of DMA lists	[199]	use in conjunction with country_source with value "lists".
dma_white_list	boolean	DMA targeting include / exclude	true / false	true - include false - exclude
dma_codes	array integer	DMA ID	[525]
postal_code_targeting	string	postal code targeting type	"All" / "Include" / "Exclude"
postal_codes	array string	postal code values	"10001", "GB:SW1A", "FR:75001", "AR:B1228"
postal_code_source	string	postal code source	"values" / "lists"	use "values" for "postal_codes" or "lists" with "postal_code_list_ids"
postal_code_list_ids	array integer	postal code list	[1235]
creative_language_allow_list	boolean	creative language targeting type	" " / true / false	" " - all true - allowlist false - blocklist
creative_language_codes	array string	creative language targeting list	["en-GB", "en-US", "fr-FR"]
creative_language_block_unknown	boolean	block unknown creative language	true / false
supply_partner_id	integer	ID of supply partner assigned	66463
supply_label_ids	array integer	supply label ID's	[1051]	Found on settings tab → More Info → Labels:
supply_type	string	supply type	"null" / "Outstream"	"null" - instream "outstream" - outstream
tracking_player_cost	boolean	track player costs based on player loads and not impressions	true / false	see "supply_type" for outstream specific setting
direct_connect	boolean	direct connect status	true / false	see "supply_class" object
supply_class	integer	supply class	1 / 2 / 3	1 - tag 2 - direct connect 3 - bidlink for 2 see "direct_connect" object
targeted_iab_category_white_list	boolean	IAB tier 1 targeting active	true (allowlist) / false (blocklist) / null (all categories)
targeted_iab_categories	array string	IAB tier 1 category name	["Automotive"]	IAB content taxonomy download
targeted_iab_tier2_categories_white_list	boolean	IAB tier 2 targeting active	true (allowlist) / false (blocklist) / null (all categories)
targeted_iab_tier2_category	array string	IAB tier 2 category name	["Auto Body Styles", "Automotive"]	IAB content taxonomy download
dnt_values	array string	DNT (do not track) targeting	["true", "false", "empty"]
dnt_param_required	boolean	DNT (do not track) parameter required	true / false
lmt_values	array string	LMT (limit tracking) targeting	["true", "false", "empty"]
lmt_param_required	boolean	LMT (limit tracking) parameter required	["true", "false", "empty"]
us_privacy_supply_white_list	boolean	US privacy targeting active	true / false
us_privacy_param_required	boolean	US privacy parameter required	true / false
us_privacy_values	array string	US privacy values	["1yyy"]
gdpr_supply_param_required	boolean	supply from GDPR country flag required	true / false
gdpr_supply_values	array string	supply from GDPR country flag targeting values	["true", "false", "empty"]
gdpr_consent_param_required	boolean	GDPR consent string parameter required	true / false
gdpr_consent_string_values	array string	GDPR consent string targeting	["valid", "invalid", "empty"]	valid - valid consent string invalid - invalid consent string
coppa_values	array string	allowed COPPA values	["true", "false", "empty"]
coppa_param_required	boolean	COPPA parameter required	true / false
audited_creative_statuses	array string	allowed audited creative statuses	["pending", "approved", "rejected"]

Versions Compared

Old Version 41

New Version 42

Key

REST API

Adding Event Pixels to a Supply Tag

SDK

Object Descriptions