Update ad groups
PATCH {{baseUrl}}/ad_accounts/:ad_account_id/ad_groups
Update multiple existing ad groups.
Request Body
{"0"=>{"id"=>"0072", "name"=>"<string>", "status"=>"ARCHIVED", "budget_in_micro_currency"=>"<integer>", "bid_in_micro_currency"=>"<integer>", "optimization_goal_metadata"=>{"conversion_tag_v3_goal_metadata"=>{"attribution_windows"=>{"click_window_days"=>"<integer>", "engagement_window_days"=>"<integer>", "view_window_days"=>"<integer>"}, "conversion_event"=>"CUSTOM", "conversion_tag_id"=>"61806562250", "cpa_goal_value_in_micro_currency"=>"8189", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"TEN_MINUTE"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"19683"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["25-34", "65+"], "APPTYPE"=>["web", "android_tablet"], "AUDIENCE_EXCLUDE"=>["5552903", "982"], "AUDIENCE_INCLUDE'"=>["0409629334", "6517626"], "GENDER"=>["male", "unknown"], "GEO"=>["<string>", "<string>"], "INTEREST"=>["<string>", "<string>"], "LOCALE"=>["<string>", "<string>"], "LOCATION"=>["<string>", "<string>"], "SHOPPING_RETARGETING"=>[{"lookback_window"=>"<integer>", "tag_types"=>["<integer>", "<integer>"], "exclusion_window"=>"<integer>"}, {"lookback_window"=>"<integer>", "tag_types"=>["<integer>", "<integer>"], "exclusion_window"=>"<integer>"}], "TARGETING_STRATEGY"=>["CHOOSE_YOUR_OWN", "CHOOSE_YOUR_OWN"]}, "lifetime_frequency_cap"=>"<integer>", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "auto_targeting_enabled"=>"<boolean>", "placement_group"=>"OTHER", "pacing_delivery_type"=>"STANDARD", "campaign_id"=>"6770052208", "billable_event"=>"CLICKTHROUGH", "bid_strategy_type"=>"AUTOMATIC_BID"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"items":[{"data":{"name":"\u003cstring\u003e","status":"ACTIVE","budget_in_micro_currency":"\u003cinteger\u003e","bid_in_micro_currency":"\u003cinteger\u003e","optimization_goal_metadata":{"conversion_tag_v3_goal_metadata":{"attribution_windows":{"click_window_days":"\u003cinteger\u003e","engagement_window_days":"\u003cinteger\u003e","view_window_days":"\u003cinteger\u003e"},"conversion_event":"CUSTOM","conversion_tag_id":"675234528","cpa_goal_value_in_micro_currency":"367361584","is_roas_optimized":"\u003cboolean\u003e","learning_mode_type":"ACTIVE"},"frequency_goal_metadata":{"frequency":"\u003cinteger\u003e","timerange":"DAY"},"scrollup_goal_metadata":{"scrollup_goal_value_in_micro_currency":"555"}},"budget_type":"DAILY","start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","targeting_spec":{"AGE_BUCKET":["55-64","21+"],"APPTYPE":["android_mobile","ipad"],"AUDIENCE_EXCLUDE":["9206854163","1162"],"AUDIENCE_INCLUDE'":["1680","981639"],"GENDER":["unknown","female"],"GEO":["\u003cstring\u003e","\u003cstring\u003e"],"INTEREST":["\u003cstring\u003e","\u003cstring\u003e"],"LOCALE":["\u003cstring\u003e","\u003cstring\u003e"],"LOCATION":["\u003cstring\u003e","\u003cstring\u003e"],"SHOPPING_RETARGETING":[{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"},{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"}],"TARGETING_STRATEGY":["RECONNECT_WITH_USERS","CHOOSE_YOUR_OWN"]},"lifetime_frequency_cap":"\u003cinteger\u003e","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"auto_targeting_enabled":"\u003cboolean\u003e","placement_group":"SEARCH","pacing_delivery_type":"ACCELERATED","campaign_id":"C85802653553","billable_event":"CLICKTHROUGH","bid_strategy_type":"TARGET_AVG","id":"41602935","ad_account_id":"3446675","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"adgroup","conversion_learning_mode_type":"NOT_ACTIVE","summary_status":"PAUSED","feed_profile_id":"\u003cstring\u003e","dca_assets":{"description":"[DCA] The Dynamic creative assets to use for DCA. Dynamic Creative Assembly (DCA) accepts basic creative assets of an ad (image, video, title, call to action, logo etc). Then it automatically generates optimized ad combinations based on these assets."}},"exceptions":[{"code":"\u003cinteger\u003e","message":"\u003cstring\u003e"},{"code":"\u003cinteger\u003e","message":"\u003cstring\u003e"}]},{"data":{"name":"\u003cstring\u003e","status":"PAUSED","budget_in_micro_currency":"\u003cinteger\u003e","bid_in_micro_currency":"\u003cinteger\u003e","optimization_goal_metadata":{"conversion_tag_v3_goal_metadata":{"attribution_windows":{"click_window_days":"\u003cinteger\u003e","engagement_window_days":"\u003cinteger\u003e","view_window_days":"\u003cinteger\u003e"},"conversion_event":"CHECKOUT","conversion_tag_id":"4395083211","cpa_goal_value_in_micro_currency":"13","is_roas_optimized":"\u003cboolean\u003e","learning_mode_type":"ACTIVE"},"frequency_goal_metadata":{"frequency":"\u003cinteger\u003e","timerange":"THIRTY_DAY"},"scrollup_goal_metadata":{"scrollup_goal_value_in_micro_currency":"686989794"}},"budget_type":"CBO_ADGROUP","start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","targeting_spec":{"AGE_BUCKET":["50-54","25-34"],"APPTYPE":["web","iphone"],"AUDIENCE_EXCLUDE":["86","93281"],"AUDIENCE_INCLUDE'":["78","405"],"GENDER":["unknown","female"],"GEO":["\u003cstring\u003e","\u003cstring\u003e"],"INTEREST":["\u003cstring\u003e","\u003cstring\u003e"],"LOCALE":["\u003cstring\u003e","\u003cstring\u003e"],"LOCATION":["\u003cstring\u003e","\u003cstring\u003e"],"SHOPPING_RETARGETING":[{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"},{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"}],"TARGETING_STRATEGY":["FIND_NEW_CUSTOMERS","FIND_NEW_CUSTOMERS"]},"lifetime_frequency_cap":"\u003cinteger\u003e","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"auto_targeting_enabled":"\u003cboolean\u003e","placement_group":"OTHER","pacing_delivery_type":"ACCELERATED","campaign_id":"17961","billable_event":"VIDEO_V_50_MRC","bid_strategy_type":"TARGET_AVG","id":"698007","ad_account_id":"449374714","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"adgroup","conversion_learning_mode_type":null,"summary_status":"RUNNING","feed_profile_id":"\u003cstring\u003e","dca_assets":{"description":"[DCA] The Dynamic creative assets to use for DCA. Dynamic Creative Assembly (DCA) accepts basic creative assets of an ad (image, video, title, call to action, logo etc). Then it automatically generates optimized ad combinations based on these assets."}},"exceptions":[{"code":"\u003cinteger\u003e","message":"\u003cstring\u003e"},{"code":"\u003cinteger\u003e","message":"\u003cstring\u003e"}]}]}