id |
The unique ID# of your campaign. |
bstypes:ResourceId |
R |
name |
The name of your campaign. |
string |
R |
active |
Indicates whether the resource is in an active or inactive state. |
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:
- 0 = Held
- 1 = Active
- 2 = Cancelled
- 3 = Held Cancelled
- 4 = Goal Reached.
|
bstypes:ReservationState |
R |
start_date |
Start date of your campaign. |
bstypes:SimpleDate |
R |
end_date |
End date of your campaign. |
bstypes:SimpleDate |
R |
start_time |
Start time of your campaign. |
bstypes:SimpleTime |
R |
end_time |
End time of your campaign. |
bstypes:SimpleTime |
R |
duration_msec |
Duration in milliseconds of your 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, i.e., set it 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 have been evaluated last. |
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 to the campaign. |
bstypes:ResourceId |
R |
default_category_id |
The unique ID# of the category associated to the campaign. |
bstypes:ResourceId |
R |
default_segment_category_id |
The unique ID# of the segment associated to the campaign. |
bstypes:ResourceId |
R |
default_bundle_weight |
The default with 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 to 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 |
Mask the define the days this campaign is set to play. |
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) that, when reached, will end the playback of the campaign. |
unsignedLong |
R |
goal_unit |
This define the the action used to measure goal_amount :
- 0 = Repetitions
- 1 = Impressions
- 2 = Interactions
|
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 the goal of your campaign had been reached. |
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 Broadsign Creator messages. |
bstypes:ResourceId |
R |
booking_state |
The booking state of the campaign:
- 1 = Fully
- 2 = Partially
- 3 = Empty
|
bstypes:BookingState |
R |
booking_state_calculated_on |
The date and time on which the booking state of your campaign was calculated. |
bstypes:SimpleDateTime |
R |