POST /strategy
Create a strategy.
Servers
- https://services.adroll.com/activate/api/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
advertisable_eid |
String | Yes |
Advertisable EID to create strategy under. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
budget |
Object | Yes | |
budget.current_month_spend |
Number | No |
Amount spent by this Campaign this month, if a monthly budget is used. |
budget.goal |
Number | Yes |
Budget of campaign in the currency specified by the currency field. |
budget.type |
String | Yes |
Type of budget Possible values:
|
budget.is_prorated |
Boolean | No |
When using monthly budgets, this flag will enable prorating if the start date is not the first of the month. Defaults to False. |
budget.spend |
Number | No |
Amount spent by this campaign till now, if a lifetime or monthly budget is used. |
name |
String | No |
Name of Strategy. |
start_date |
String | No |
Start date of Strategy in ISO-8601 format (Responses are in UTC). |
managed_by_spendtracker |
Boolean | No |
Boolean indicating if the Strategy is managed by SpendTracker. When a Strategy is managed its budget and kpi settings are controlled (externally) by SpendTracker. For more information please contact your account manager. |
end_date |
String | No |
End date of Strategy in ISO-8601 format (Responses are in UTC). |
spend_floor |
Number | No |
Percentage representing how low the budget fulfillment can go to try to attain the user kpi. - 1 means our algorithm will always try to maximize budget fulfillment (recommended). - 0 means our algorithm might stop spending if that's needed to reach the user KPI goal. You can use the numbers in between to tune our algorithm. |
is_draft |
Boolean | No |
Field indicating whether this is a draft Strategy. |
draft_eid |
String | No |
EID of draft Strategy to publish. |
currency |
String | Yes |
ISO-4217 currency code for budget. This value must match the currency set on the Advertisable'sbilling account. Possible values:
|
budget_balancing_automated |
Boolean | No |
Allow our system to smartly allocate your budget among the Strategy's campaigns to optimize the Strategy performance. If you have this setting turned off, you'll have to manually set the budget split of the Strategy's configured campaigns. |
campaigns[] |
Array | No |
List of campaigns to create and attach to the strategy. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.