Overview
Overview
The Magnite Campaign Budget Update Tool processes input data from a CSV file, validates it, and updates campaigns based on the specified method: Insert, Upsert, or Replace.
Bulk Updates
You can provide a CSV file to update multiple campaigns in one go.
Required Column:
-
campaign_id: Identifies the campaign to be updated.
Optional Columns (depending on update needs):
-
id: Unique identifier for a specific budget entry. -
budget_metric: Specifies the focus of the budget (e.g., costs, impressions). -
budget_period: Defines the time frame for the budget. -
budget_pacing: Determines how the budget is distributed over time. -
budget_value: The monetary value for the budget.
Valid Values for Optional Columns:
budget_metric:
-
net_cost -
gross_cost -
requests -
revenue -
impressions -
completes -
clicks
budget_period:
-
day -
lifetime -
month -
week -
hour
budget_pacing:
-
asap: Spend as quickly as possible. -
smooth: Spend evenly over the period. -
front_loaded: Spend more at the beginning. -
even: Spread spending evenly.
Additional Considerations
Each budget item in the file is validated against the following rules:
-
Valid Values:
-
budget_metric,budget_period, andbudget_pacingmust use the valid options listed above. -
budget_valuemust be numeric.
-
-
Unique Budget Periods:
-
No duplicate budget periods are allowed for the same campaign.
-
-
Pacing Constraints for Lifetime Budgets:
-
If
budget_periodislifetime, onlyasapandsmoothare valid pacing options.
-
-
No Invalid Ad Caching Adjustments:
-
Certain metrics (
revenue,requests) cannot have caching adjustments.
-
Example Input File
Below is an example of how your CSV file should be formatted:
```csv campaignid,id,budgetmetric,budgetperiod,budgetpacing,budgetvalue 12345,,netcost,day,smooth,500 12345,,revenue,lifetime,smooth,2000 67890,1,impressions,month,even,10000
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
Username |
MAGNITE_USERNAME |
Alphanumeric |
✅ |
- |
- |
The username to authenticate. |
|
Password |
MAGNITE_PASSWORD |
Password |
✅ |
- |
- |
|
|
File Name |
MAGNITE_FILE |
Alphanumeric |
➖ |
- |
- |
The file that contains multiple ID's to update. Required for bulk updates |
YAML
Below is the YAML template
source:
template: Magnite - Update Budget Fields
inputs:
MAGNITE_USERNAME:
MAGNITE_PASSWORD:
MAGNITE_FILE:
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 200
- 201
- 202
- 203