bundle_mgr_add

Back to SOAP Architecture Method Reference

Description

The bundle_mgr_add method adds a bundle to your domain, that will hold your content (or ad copies).

Parameters

Parameter	Description	Type	Required (R) or Optional (O)
domain_id	The unique ID# of your domain.	bstypes:ResourceId	R
name	The bundle's name.	string	R
parent_id	The unique ID# of the schedule resource.	bstypes:ResourceId	R
active	Whether or not the bundle is in an active state.	Boolean	O
allow_custom_duration	Whether or not you want to allow custom duration of the bundle.	bstypes:NullableBool	O
attributes	The bundle's attributes. Use this option to specify non-full-screen custom geometry. Note: If you use this option, set the fullscreen parameter to "false".	string	O
auto_synchronized	Whether or not the bundle will auto-synchronize.	Boolean	O
category_id	The unique ID# of the separation category associated with the bundle.	bstypes:ResourceId	O
fullscreen	Whether or not the bundle will appear fullscreen. A custom geometry shortcut that avoids having to specify exact screen dimensions. Note: If you use this option, you will not need to specify anything in the attributes parameter.	bstypes:NullableBool	O
interactivity_timeout	The point at which an interactive bundle will time out.	int	O
interactivity_trigger_id	The unique ID# of the trigger associated with the bundle.	bstypes:ResourceId	O
loop_category_id	The unique ID# of the segmentation category associated with the bundle.	bstypes:ResourceId	O
loop_weight	The weight of the segmentation category associated with the bundle.	bstypes:NullableInt	O
max_duration_msec	The maximum duration of the bundle in milliseconds.	bstypes:NullableInt	O
position	The bundle's position in the loop.	int	O
secondary_sep_category_ids	The unique ID# or #s of the secondary separation categories associated with the bundle.	string	O
trigger_category_id	The unique ID# of the trigger category.	bstypes:ResourceId	O

Return Values

Value	Description	Type	Required (R) or Optional (O)
id	The unique ID# of the bundle added.	bstypes:ResourceId	R