Create ad groups
POST {{baseUrl}}/ad_accounts/:ad_account_id/ad_groups
Create multiple new ad groups. All ads in a given ad group will have the same budget, bid, run dates, targeting, and placement (search, browse, other). For more information, click here.
Note: - 'bidinmicrocurrency' and 'budgetinmicrocurrency' should be expressed in microcurrency amounts based on the currency field set in the advertiser's profile.
Microcurrency is used to track very small transactions, based on the currency set in the advertiser’s profile.
A microcurrency unit is 10-6 of the standard unit of currency selected in the advertiser’s profile.
Equivalency equations, using dollars as an example currency:
- $1 = 1,000,000 microdollars
- 1 microdollar = $0.000001
To convert between currency and microcurrency, using dollars as an example currency:
- To convert dollars to microdollars, mutiply dollars by 1,000,000
- To convert microdollars to dollars, divide microdollars by 1,000,000
Request Body
{"0"=>{"billable_event"=>"CLICKTHROUGH", "campaign_id"=>"C19824", "name"=>"<string>", "status"=>"DELETED_DRAFT", "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"=>"LEAD", "conversion_tag_id"=>"22091", "cpa_goal_value_in_micro_currency"=>"35417004508", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>nil}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"SEVEN_DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"013103"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["65+", "45-49"], "APPTYPE"=>["android_tablet", "android_tablet"], "AUDIENCE_EXCLUDE"=>["85", "627270"], "AUDIENCE_INCLUDE'"=>["41727373918", "487"], "GENDER"=>["female", "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"=>"ALL", "pacing_delivery_type"=>"STANDARD", "bid_strategy_type"=>"TARGET_AVG"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"items":[{"data":{"name":"\u003cstring\u003e","status":"DRAFT","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":"81484","cpa_goal_value_in_micro_currency":"8169112","is_roas_optimized":"\u003cboolean\u003e","learning_mode_type":null},"frequency_goal_metadata":{"frequency":"\u003cinteger\u003e","timerange":"TWENTY_FOUR_HOUR"},"scrollup_goal_metadata":{"scrollup_goal_value_in_micro_currency":"16020314473"}},"budget_type":"LIFETIME","start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","targeting_spec":{"AGE_BUCKET":["65+","45-49"],"APPTYPE":["web","android_mobile"],"AUDIENCE_EXCLUDE":["92811","44394"],"AUDIENCE_INCLUDE'":["16","44750811820"],"GENDER":["male","unknown"],"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","RECONNECT_WITH_USERS"]},"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":"ALL","pacing_delivery_type":"STANDARD","campaign_id":"C723950","billable_event":"CLICKTHROUGH","bid_strategy_type":null,"id":"099132","ad_account_id":"2860","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"adgroup","conversion_learning_mode_type":null,"summary_status":"ADVERTISER_DISABLED","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":"DRAFT","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":"APP_INSTALL","conversion_tag_id":"529811","cpa_goal_value_in_micro_currency":"65455280770","is_roas_optimized":"\u003cboolean\u003e","learning_mode_type":"NOT_ACTIVE"},"frequency_goal_metadata":{"frequency":"\u003cinteger\u003e","timerange":"DAY"},"scrollup_goal_metadata":{"scrollup_goal_value_in_micro_currency":"1693795804"}},"budget_type":"LIFETIME","start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","targeting_spec":{"AGE_BUCKET":["55-64","65+"],"APPTYPE":["web","iphone"],"AUDIENCE_EXCLUDE":["69632567","2609"],"AUDIENCE_INCLUDE'":["253879","4"],"GENDER":["male","unknown"],"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","RECONNECT_WITH_USERS"]},"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":"ALL","pacing_delivery_type":"ACCELERATED","campaign_id":"256","billable_event":"IMPRESSION","bid_strategy_type":null,"id":"090396","ad_account_id":"053986696","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"adgroup","conversion_learning_mode_type":"ACTIVE","summary_status":"DELETED_DRAFT","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"}]}]}