reservation_mgr_list_many
Back to SOAP Architecture Method Reference
Description
The reservation_mgr_list_many method lists details of specific campaigns on your domain.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| ids | A comma-delimited list of the unique ID#s of campaigns you want to list. | bstypes:ResourceId | R |
| domain_id | The unique ID# of your domain. | bstypes:ResourceId | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the campaign. | bstypes:ResourceId | R |
| name | The name of the campaign. | string | R |
| active | Indicates whether or not the resource is active. | boolean | R |
| container_id | The unique ID# of the container/folder. | bstypes:ResourceId | R |
| domain_id | The unique ID# of your domain. | bstypes:ResourceId | R |
| state | Indicates the status of the campaign:
|
bstypes:ReservationState | R |
| start_date | Start date of the campaign. | bstypes:SimpleDate | R |
| end_date | End date of the campaign. | bstypes:SimpleDate | R |
| start_time | Start time of the campaign. | bstypes:SimpleTime | R |
| end_time | End time of the campaign. | bstypes:SimpleTime | R |
| duration_msec | Duration in milliseconds of the campaign. | int | R |
| creation_user_id | The unique ID# of the user that created the campaign. | bstypes:ResourceId | R |
| creation_tm | Creation date and time of your campaign (in UTC). | bstypes:SimpleDateTime | R |
| promoter_user_id | The unique ID# of the user that promoted the campaign, that is, set the campaign to "live". | bstypes:ResourceId | R |
| promotion_time | The date and time of promotion of your campaign. | bstypes:SimpleDateTime | R |
| parent_id | The unique ID# of the customer that owns the campaign. | bstypes:ResourceId | R |
| estimated_reps | Estimated repetition of your campaign. | long | R |
| reps_calculated_on | Date and time the repetition was last calculated. | bstypes:SimpleDateTime | R |
| saturation | The saturation of your campaign. | double | R |
| default_schedule_id | The unique ID# of the default schedule of your campaign. | bstypes:ResourceId | R |
| media_package_id | The unique ID# of the media package associated with the campaign. | bstypes:ResourceId | R |
| default_category_id | The unique ID# of the category associated with the campaign. | bstypes:ResourceId | R |
| default_segment_category_id | The unique ID# of the segment associated with the campaign. | bstypes:ResourceId | R |
| default_bundle_weight | The default weight of each bundle inside the campaign. | int | R |
| default_trigger_category_id | The unique ID# of the trigger (in case of synchronization) associated to the campaign. | bstypes:ResourceId | R |
| default_fullscreen | Indicates whether or not the campaign will play in fullscreen. | boolean | R |
| default_interactivity_trigger_id | The unique ID# of the trigger (in case of interactivity) associated with the campaign. | bstypes:ResourceId | R |
| default_interactivity_timeout | Duration in milliseconds ot the timeout of an interactive action during the playback of the campaign. | int | R |
| day_of_week_mask | The number representation of the days in which this campaign is active. The value is the sum of the individual values of each day of the week, which are incrementing powers of 2, for example, Monday is 1 (2^0) and Sunday is 64 (2^6). | int | R |
| auto_synchronize_bundles | Indicates whether or not we choose to let the player synchronize the bundles automatically. | boolean | R |
| goal_amount | Number of actions (impressions, interactions or repetitions) the when reached will end the playback of the campaign. | unsignedLong | R |
| goal_unit | The type of action the goal_amount will be:
|
bstypes:ReservationGoalUnitType | R |
| has_goal | Indicates whether or not the campaign has a goal. | boolean | R |
| goal_reached_on_tm | The date and time when your campaign reached its goal. | bstypes:SimpleDateTime | R |
| default_attributes | The default attribute of the campaign. | string | R |
| default_secondary_sep_category_ids | The unique ID# of the secondary category associated to the campaign. | string | R |
| bmb_host_id | The unique ID# of the player that will be used to preview creator messages. | bstypes:ResourceId | R |
| booking_state | The booking state of the campaign:
|
bstypes:BookingState | R |
| booking_state_calculated_on | The date and time upon which the booking state of your campaign was calculated. | bstypes:SimpleDateTime | R |