| field name | type | description | required |
|---|---|---|---|
| campaign_ids | array | the campaign to be updated | Yes |
| charge_type | string | Bidding Strategy, historical values by default. The allowed value contains: cpc, smart_bid, max_cv | No |
| status | int | the active/pause status of the campaign, while 0 represents pause, 1 represents active | No |
| day_parting | [][]int | an 7*24 array indicating the certain times of day or certain days of the week that you open your campaign, where index 0-6 in first dimension means Monday to Sunday, index 0-23 in second dimension means hours in a day, value 1 means selected, 0 means unselected e.g. [[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]] means campaign will run from 3am to 2pm every Friday | No |
| dp_timezone | string | By default your account time zone is selected. We'll schedule your campaign to run based on the selected time zone. The allowed value contains: EST UTC-12 UTC-11 UTC-10 UTC-9 UTC-8 UTC-7 UTC-6 UTC-5 UTC-4 UTC-3 UTC-2 UTC-1 UTC UTC+1 UTC+2 UTC+3 UTC+4 UTC+5 UTC+6 UTC+7 UTC+8 UTC+9 UTC+10 UTC+11 UTC+12 UTC+13 UTC+14 | No |
| start_time | string | the exactly start time for the campaign, format yyyy-mm-dd hh:mm:ss, it can not before very day manage-api called | No |
| end_time | string | the exactly end time for the campaign, format yyyy-mm-dd hh:mm:ss, it can neither before start_time nor after year 2030 | No |
| daily_cap | double | cpc cost as most everyday, minimum daily_cap cap is $20/day, daily_cap/cpc can not be less than 30 | No |
| cpc | double | budget for a click(unit: USD), cpc can not be higher than $5, daily_cap/cpc can not be less than 30 | When charge_type is set to cpc or smart_bid, cpc is required. When charge_type is set to maxcv, cpc is not required. |
| objective | string | objective of your campaign. Note: Please choose ONE Objective. The allowed value contains: "lead" means Lead Generation, "conversions" means Online Purchases, "awareness" means Website Engagement | No |
| target_cpa | double | target CPA of your campaign.(unit: USD) | When Marketing Objective selects Lead Generation or Online Purchases, target CPA is required; when Website Engagement is selected, target CPA is not required. |
| optimization_type | string | conversion goal of your campaign. Note: Please fill in ONE conversion goal. The conversion goal is the type of pixel important conversion embedded in the account. If the pixel important conversion has not installed, please choose '-1' as the value. The allowed value contains: "1" means View Content, "2" means App Install, "3" means Complete Registration, "4" means Add to Cart, "5" means Add Payment Info, "6" means Search, "7" means Start Checkout, "8" means Purchase, "9" means Add to Wishlist, "10" means Lead, "-1" means Default Optimization | When Marketing Objective selects Lead Generation or Online Purchases, optimization_type is required;when Website Engagement is selected, optimization_type is not required. The optimization_type is the type of pixel important conversion embedded in the account. If the pixel important conversion has not been installed, you can choose Default Optimization, which will optimize for important conversions that are passed back by default. |
success_campaign_idsfailed_campaign_idsvalidation_errorsYYYY-MM-DD HH:MM:SS format2024-01-01 00:00:00