Create/update ad entities in bulk

POST {{baseUrl}}/ad_accounts/:ad_account_id/bulk/upsert

Either create or update any combination of campaigns, ad groups, product groups, ads, or keywords. Note that this request will be processed asynchronously; the response will include a request_id that can be used to obtain the status of the request.

Request Body

{"create"=>{"campaigns"=>[{"name"=>"<string>", "objective_type"=>"AWARENESS", "ad_account_id"=>"77672596", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"9", "tracking_urls"=>{"impression"=>["<string>"], "click"=>["<string>"], "engagement"=>["<string>"], "buyable_button"=>["<string>"], "audience_verification"=>["<string>"]}, "start_time"=>"<integer>", "end_time"=>"<integer>", "summary_status"=>"PAUSED", "is_flexible_daily_budgets"=>false, "default_ad_group_budget_in_micro_currency"=>"<integer>", "is_automated_campaign"=>false}], "ad_groups"=>[{"billable_event"=>"IMPRESSION", "campaign_id"=>"C8034", "name"=>"<string>", "status"=>"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"=>"SIGNUP", "conversion_tag_id"=>"0032727117", "cpa_goal_value_in_micro_currency"=>"57115132834", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"NOT_ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"SEVEN_DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"39"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["18-24"], "APPTYPE"=>["web_mobile"], "AUDIENCE_EXCLUDE"=>["429906658"], "AUDIENCE_INCLUDE'"=>["46767310820"], "GENDER"=>["unknown"], "GEO"=>["<string>"], "INTEREST"=>["<string>"], "LOCALE"=>["<string>"], "LOCATION"=>["<string>"], "SHOPPING_RETARGETING"=>[{"lookback_window"=>"<integer>", "tag_types"=>["<integer>"], "exclusion_window"=>"<integer>"}], "TARGETING_STRATEGY"=>["CHOOSE_YOUR_OWN"]}, "lifetime_frequency_cap"=>"<integer>", "tracking_urls"=>{"impression"=>["<string>"], "click"=>["<string>"], "engagement"=>["<string>"], "buyable_button"=>["<string>"], "audience_verification"=>["<string>"]}, "auto_targeting_enabled"=>"<boolean>", "placement_group"=>"ALL", "pacing_delivery_type"=>"STANDARD", "bid_strategy_type"=>"AUTOMATIC_BID"}], "ads"=>[{"ad_group_id"=>"630491", "pin_id"=>"001", "creative_type"=>"SHOP_THE_PIN", "android_deep_link"=>"<string>", "carousel_android_deep_links"=>["<string>"], "carousel_destination_urls"=>["<string>"], "carousel_ios_deep_links"=>["<string>"], "click_tracking_url"=>"<string>", "destination_url"=>"<string>", "ios_deep_link"=>"<string>", "is_pin_deleted"=>"<boolean>", "is_removable"=>"<boolean>", "name"=>"<string>", "status"=>"ACTIVE", "tracking_urls"=>{"impression"=>["<string>"], "click"=>["<string>"], "engagement"=>["<string>"], "buyable_button"=>["<string>"], "audience_verification"=>["<string>"]}, "view_tracking_url"=>"<string>", "lead_form_id"=>"425", "grid_click_type"=>"CLOSEUP", "customizable_cta_type"=>"SUBSCRIBE", "quiz_pin_data"=>{"questions"=>[{"question_id"=>"<number>", "question_text"=>"<string>", "options"=>[{"id"=>"<number>", "text"=>"<string>"}]}], "results"=>[{"organic_pin_id"=>"<string>", "android_deep_link"=>"<string>", "ios_deep_link"=>"<string>", "destination_url"=>"<string>", "result_id"=>"<number>"}]}}], "product_groups"=>[{"ad_group_id"=>"AG7", "product_group_promotion"=>[{"id"=>"5328478", "ad_group_id"=>"7667", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"7762222495", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"DELETED_DRAFT", "tracking_url"=>"<string>", "catalog_product_group_id"=>"6285254650", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOPPING", "collections_hero_pin_id"=>"2", "collections_hero_destination_url"=>"<string>", "grid_click_type"=>"CLOSEUP"}]}], "keywords"=>[{"keywords"=>[{"match_type"=>"BROAD", "value"=>"<string>", "bid"=>"<integer>"}], "parent_id"=>"1728360"}]}, "update"=>{"campaigns"=>[{"id"=>"70553891405", "ad_account_id"=>"0302108", "name"=>"<string>", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"76364", "tracking_urls"=>{"impression"=>["<string>"], "click"=>["<string>"], "engagement"=>["<string>"], "buyable_button"=>["<string>"], "audience_verification"=>["<string>"]}, "start_time"=>"<integer>", "end_time"=>"<integer>", "summary_status"=>"ARCHIVED", "is_flexible_daily_budgets"=>false, "default_ad_group_budget_in_micro_currency"=>"<integer>", "is_automated_campaign"=>false, "is_campaign_budget_optimization"=>false, "objective_type"=>"WEB_CONVERSION"}], "ad_groups"=>[{"id"=>"3", "name"=>"<string>", "status"=>"ACTIVE", "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"=>"ADD_TO_CART", "conversion_tag_id"=>"6404839309", "cpa_goal_value_in_micro_currency"=>"21074", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>nil}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"THIRTY_DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"67806"}}, "budget_type"=>"CBO_ADGROUP", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["35-44"], "APPTYPE"=>["ipad"], "AUDIENCE_EXCLUDE"=>["570"], "AUDIENCE_INCLUDE'"=>["634899265"], "GENDER"=>["female"], "GEO"=>["<string>"], "INTEREST"=>["<string>"], "LOCALE"=>["<string>"], "LOCATION"=>["<string>"], "SHOPPING_RETARGETING"=>[{"lookback_window"=>"<integer>", "tag_types"=>["<integer>"], "exclusion_window"=>"<integer>"}], "TARGETING_STRATEGY"=>["RECONNECT_WITH_USERS"]}, "lifetime_frequency_cap"=>"<integer>", "tracking_urls"=>{"impression"=>["<string>"], "click"=>["<string>"], "engagement"=>["<string>"], "buyable_button"=>["<string>"], "audience_verification"=>["<string>"]}, "auto_targeting_enabled"=>"<boolean>", "placement_group"=>"ALL", "pacing_delivery_type"=>"STANDARD", "campaign_id"=>"C665399648", "billable_event"=>"IMPRESSION", "bid_strategy_type"=>"MAX_BID"}], "ads"=>[{"id"=>"5898947", "ad_group_id"=>"9424", "android_deep_link"=>"<string>", "carousel_android_deep_links"=>["<string>"], "carousel_destination_urls"=>["<string>"], "carousel_ios_deep_links"=>["<string>"], "click_tracking_url"=>"<string>", "creative_type"=>"REGULAR", "destination_url"=>"<string>", "ios_deep_link"=>"<string>", "is_pin_deleted"=>"<boolean>", "is_removable"=>"<boolean>", "name"=>"<string>", "status"=>"DELETED_DRAFT", "tracking_urls"=>{"impression"=>["<string>"], "click"=>["<string>"], "engagement"=>["<string>"], "buyable_button"=>["<string>"], "audience_verification"=>["<string>"]}, "view_tracking_url"=>"<string>", "lead_form_id"=>"AG35927499940", "grid_click_type"=>"DIRECT_TO_DESTINATION", "customizable_cta_type"=>"READ_MORE", "quiz_pin_data"=>{"questions"=>[{"question_id"=>"<number>", "question_text"=>"<string>", "options"=>[{"id"=>"<number>", "text"=>"<string>"}]}], "results"=>[{"organic_pin_id"=>"<string>", "android_deep_link"=>"<string>", "ios_deep_link"=>"<string>", "destination_url"=>"<string>", "result_id"=>"<number>"}]}, "pin_id"=>"51070"}], "product_groups"=>[{"ad_group_id"=>"75409397839", "product_group_promotion"=>[{"id"=>"349767", "ad_group_id"=>"8596", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"3837972170", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"PAUSED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"5957", "catalog_product_group_name"=>"<string>", "creative_type"=>"REGULAR", "collections_hero_pin_id"=>"13", "collections_hero_destination_url"=>"<string>", "grid_click_type"=>"CLOSEUP"}]}], "keywords"=>[{"id"=>"85956105", "archived"=>"<boolean>", "bid"=>"<integer>"}]}}

HEADERS

RESPONSES

status: OK

{"request_id":"\u003cstring\u003e"}