Overview
The Ad Creative Scheduling API V4 allows users to view and modify scheduling information for creatives attached to placements' ads, including the ability to configure creative rotation.
Use the Ad Creative Scheduling API V4 to:
- Get scheduling methods for creatives attached to placements' ads
- Update scheduling information for creatives attached to placements' ads
Uniform Resource Identifiers (URI)
| Environment | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v4/ads/{ad_id}/scheduling |
| Staging | https://api.stg.freewheel.tv/services/v4/ads/{ad_id}/scheduling |
Attributes
The following attributes are used when updating an ad's creatives scheduling. For an interactive example, see Update an Ad's Creatives Scheduling.
Path Parameters
| Name | Type | Description |
|---|---|---|
| ad_id | FW_ID | The current network's assigned Ad Unit Node ID |
Body Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| scheduling_method | string | The scheduling method. The following options are supported EQUAL_WEIGHTING, PERCENTAGE_WEIGHTING, AB_TESTING, SEQUENCE, FLIGHTING, FLIGHTING_AND_WEIGHTING, AUDIENCE_TARGETING, or ADVANCED_FLIGHTING_AND_WEIGHTING | One selection is required. Not all scheduling methods may be available based on your network functions and the number of schedulable creative instances the ad has |
| scheduling_sets | object | Details of the scheduling sets | Required when scheduling method is AUDIENCE_TARGETING or ADVANCED_FLIGHTING_AND_WEIGHTINGWhen scheduling_method is AUDIENCE_ TARGETING, the order of the `scheduling_set items defines the priority of each audience match if a request matches more than one audience item. The last scheduling_set in the array list should represent the default behavior that occurs when no audience match is made |
| scheduling_items | object | Details of the scheduling items | Required when scheduling_method is EQUAL_WEIGHTING, PERCENTAGE_WEIGHTING, AB_TESTING, SEQUENCE, FLIGHTING, or FLIGHTING_AND_WEIGHTING |
Scheduling_Set Object
When the scheduling_method is AUDIENCE_TARGETING, the order of the scheduling_set items defines the priority of each audience match if a request matches more than one audience item. The last scheduling_set in the array list should represent the default behavior that occurs when no audience match is made.
| Name | Type | Description | Notes |
|---|---|---|---|
| audience_item_id | integer | ID of Audience Item. Only valid when scheduling_method is AUDIENCE_TARGETING | Required for a custom scheduling_set. Should not be duplicated for each custom scheduling_set |
| flighting_start | date-time (YYYY-MM-DD HH:MM:SS) | The start date of the flighting period for the scheduling set, in UTC | Required and available only when scheduling_method is ADVANCED_FLIGHTING_AND_WEIGHTING |
| flighting_end | date-time (YYYY-MM-DD HH:MM:SS) | The end date of the flighting period for the scheduling set, in UTC | Required and available only when scheduling_method is ADVANCED_FLIGHTING_AND_WEIGHTING. |
| scheduling_set_items | array | Array of scheduling set items | At least one item is required. |
Scheduling_Set_Items Array
| Name | Type | Description | Notes |
|---|---|---|---|
| creative_id | integer | FW Creative ID | Required |
| weighting_factor | integer | Percentage of weighting | Optional, available only when scheduling_method is ADVANCED_FLIGHTING_AND_WEIGHTING |
Scheduling_Items Object
| Name | Type | Description | Notes |
|---|---|---|---|
| sequence | integer | Rotation sequence, required when scheduling_method is SEQUENCE | |
| flighting_start | date-time (YYYY-MM-DD HH:MM:SS UTC) | The start date of the item in UTC | Required when scheduling_method is FLIGHTING or FLIGHTING_AND_WEIGHTING |
| flighting_end | date-time (YYYY-MM-DD HH:MM:SS UTC). | The end date of the item in UTC | Required when scheduling_method is FLIGHTING or FLIGHTING_AND_WEIGHTING> |
| creative_id | integer | The FreeWheel creative ID | Required |
| weighting_factor | integer | The percentage of weighting | Required when scheduling_method is PERCENTAGE_WEIGHTING, AB_TESTING, or FLIGHTING_AND_WEIGHTING |