media_package_mgr_list

Back to SOAP Architecture Method Reference

Description

The media_package_mgr_list method list details of the designated Media Packages.

Parameters

Parameter Description Type Required (R) or Optional (O)
domain_id The unique ID# of the domain. bstypes:ResourceId R

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the Media Package. bstypes:ResourceId R
name The name of this Media Package. string R
active Whether this Media Package is active. boolean R
container_id The ID# of the folder containing this Media Package. bstypes:ResourceId R
domain_id The unique ID# of the domain. bstypes:ResourceId R
flight_type Indicates the unit of measurement for the duration of the flight, for example days, weeks or months. bstypes:FlightType R
flight Indicates the number of flights per unit of measurement, for example, “2 flights per week” or “10 flights per month”. unsignedInt R
start_time The start time of the flight. bstypes:SimpleTime R
end_time The end time of the flight. bstypes:SimpleTime R
saturation Indicates the saturation of this Media Package. double R
duration The duration of the flight. unsignedInt R
pricing_type Indicates the pricing type: cost per repetition, cost per screen, cost per thousand impressions or fixed cost. bstypes:PriceType R
du_and_criteria_resource_id The unique ID# of the Display Unit “Matching All Of” Criteria associated to the Media Package. bstypes:ResourceId R
du_or_criteria_resource_id The unique ID# of the Display Unit “Matching Any Of” Criteria associated to the Media Package. bstypes:ResourceId R
du_not_criteria_resource_id The unique ID# of the Display Unit “Doesn’t Match” Criteria associated to the Media Package. bstypes:ResourceId R
frame_and_criteria_resource_id The unique ID# of the Frame “Matching All Of” Criteria associated to the Media Package. bstypes:ResourceId R
frame_or_criteria_resource_id The unique ID# of the Frame “Matching Any Of” Criteria associated to the Media Package. bstypes:ResourceId R
frame_not_criteria_resource_id The unique ID# of the Frame “Doesn’t Match” Criteria associated to the Media Package. bstypes:ResourceId R
default_category_id Indicates the unique ID number of the campaign’s default category, if applicable. bstypes:ResourceId R
default_segment_category_id Indicates the unique ID number of the campaign’s segment category, if applicable. bstypes:ResourceId R
default_bundle_weight Indicates the weight of the default bundle, if applicable. int R
default_trigger_category_id Indicates the unique ID number of the campaign’s default trigger category, if applicable. bstypes:ResourceId R
default_fullscreen Indicates whether the you have set the custom geometry of the campaign as full screen or not. boolean R
default_priority The default priority of the preemptible campaign, if applicable. int R
auto_synchronized Indicates whether or not we choose to let the Player Synchronize the Bundles in the Media Package automatically. bstypes:AutoSynchronizedType R
default_interactivity_trigger_id Indicates the unique ID number of the campaign’s interactivity trigger, if applicable. bstypes:ResourceId R
default_interactivity_timeout Indicates the timeout value, if the campaign is interactive. int R
day_of_week_mask Indicates the days of the week for which you have scheduled the campaign to appear. int R
auto_saturation_airtime The saturation air time of the campaign, if applicable. unsignedInt R
auto_saturation_per_total_time The saturation per total time of the campaign, if applicable. unsignedInt R
default_attributes The default attributes of the campaign, if applicable. (height, unit, width, x, y, z) string R
default_secondary_sep_category_ids The secondary separation categories associated with the campaign, if applicable. string R