update_campaign
Modify campaign settings such as name, budget, status, bid strategy, or tracking parameters by passing only the fields to change.
Instructions
Update an existing campaign in place. Only the fields you pass change.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New campaign name (rename). | |
| status | No | "Active" or "Paused". | |
| max_cpc | No | Optional Maximum CPC limit (account currency) for MaxClicks / MaxConversions / TargetCpa / MaxConversionValue / TargetRoas. Not valid for EnhancedCpc / ManualCpc. get_campaigns reports the current value; re-pass it when changing bid_strategy_type or the existing cap may be cleared (the scheme is rewritten as a whole). | |
| time_zone | No | Campaign time zone (Microsoft code, e.g. "CentralTimeUSCanada"); ad schedules run in this zone. Read the current value from get_campaigns. | |
| target_cpa | No | Target CPA (account currency) for TargetCpa / MaxConversions. get_campaigns reports the current value; re-pass it to preserve it (see max_cpc). | |
| campaign_id | Yes | The campaign id. | |
| target_roas | No | Target ROAS for TargetRoas / MaxConversionValue. get_campaigns reports the current value; re-pass it to preserve it (see max_cpc). | |
| daily_budget | No | New daily budget in account currency. | |
| bid_strategy_id | No | Id of a portfolio (shared) bid strategy to apply. Mutually exclusive with bid_strategy_type. | |
| final_url_suffix | No | Final URL suffix appended to landing-page URLs. | |
| bid_strategy_type | No | Set the campaign's own inline bid strategy (BiddingScheme): one of "EnhancedCpc", "ManualCpc", "MaxClicks", "MaxConversions", "TargetCpa", "MaxConversionValue", "TargetRoas". e.g. "MaxClicks" (+ optional max_cpc) is Maximize Clicks with a Maximum CPC limit. The long-form value get_campaigns returns for TargetRoas / MaxConversionValue ("TargetRoasBiddingScheme" / "MaxConversionValueBiddingScheme") is also accepted, so a read value round-trips. Mutually exclusive with bid_strategy_id. | |
| tracking_url_template | No | Tracking template for all URLs in the campaign. | |
| url_custom_parameters | No | {key: value} URL custom parameters, referenced in templates/suffixes as {_key}. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| ids | No | ||
| message | Yes | ||
| partial_errors | No |