bundle_mgr_list
Back to SOAP Architecture Method Reference
Description
The bundle_mgr_list method lists all bundles on 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 |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the bundle. | bstypes:ResourceId | R |
| name | The name of the bundle. | string | R |
| active | Indicates whether or not the resource is active. | boolean | R |
| container_id | The unique ID# of the bundle's parent folder. | bstypes:ResourceId | R |
| domain_id | The unique ID# of your domain. | bstypes:ResourceId | R |
| max_duration_msec | The maximum duration of the bundle in milliseconds. | bstypes:NullableInt | R |
| category_id | The unique ID# of the separation category associated with the bundle. | bstypes:ResourceId | R |
| allow_custom_duration | Whether or not you want to allow custom duration of the bundle. | bstypes:NullableBool | R |
| loop_category_id | The unique ID# of the segmentation category associated with the bundle. | bstypes:ResourceId | R |
| loop_weight | The weight of the segmentation category associated with the bundle. | bstypes:NullableInt | R |
| 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 | R |
| parent_id | The unique ID# of the schedule resource. | bstypes:ResourceId | R |
| trigger_category_id | The unique ID# of the trigger category. | bstypes:ResourceId | R |
| loop_positions | string | R | |
| interactivity_trigger_id | The unique ID# of the trigger associated with the bundle. | bstypes:ResourceId | R |
| interactivity_timeout | The point at which an interactive bundle will time out. | int | R |
| auto_synchronized | Whether or not the bundle will auto-synchronize. | Boolean | R |
| 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 | R |
| position | The bundle's position in the loop. | int | R |
| secondary_sep_category_ids | The unique ID# or #s of the secondary separation categories associated with the bundle. | string | R |