Qodex.ai

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"=>"29771262", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"28561636534", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "start_time"=>"<integer>", "end_time"=>"<integer>", "summary_status"=>"RUNNING", "is_campaign_budget_optimization"=>false, "is_flexible_daily_budgets"=>false, "default_ad_group_budget_in_micro_currency"=>"<integer>", "is_automated_campaign"=>false}, {"name"=>"<string>", "objective_type"=>"CONSIDERATION", "ad_account_id"=>"34093132362", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"56", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "start_time"=>"<integer>", "end_time"=>"<integer>", "summary_status"=>"ARCHIVED", "is_campaign_budget_optimization"=>false, "is_flexible_daily_budgets"=>false, "default_ad_group_budget_in_micro_currency"=>"<integer>", "is_automated_campaign"=>false}], "ad_groups"=>[{"billable_event"=>"CLICKTHROUGH", "campaign_id"=>"6", "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"=>"SEARCH", "conversion_tag_id"=>"8440869", "cpa_goal_value_in_micro_currency"=>"777790734", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>nil}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"45404"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["35-44", "45-49"], "APPTYPE"=>["iphone", "android_tablet"], "AUDIENCE_EXCLUDE"=>["1363898868", "10797"], "AUDIENCE_INCLUDE'"=>["907024", "00316054"], "GENDER"=>["female", "male"], "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"=>["RECONNECT_WITH_USERS", "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"=>"BROWSE", "pacing_delivery_type"=>"STANDARD", "bid_strategy_type"=>"MAX_BID"}, {"billable_event"=>"VIDEO_V_50_MRC", "campaign_id"=>"C435689", "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"=>"WATCH_VIDEO", "conversion_tag_id"=>"2460883800", "cpa_goal_value_in_micro_currency"=>"140962", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"TWENTY_MINUTE"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"260"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["21+", "65+"], "APPTYPE"=>["android_mobile", "ipad"], "AUDIENCE_EXCLUDE"=>["620323484", "019040"], "AUDIENCE_INCLUDE'"=>["9", "81256868033"], "GENDER"=>["female", "female"], "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"=>["RECONNECT_WITH_USERS", "FIND_NEW_CUSTOMERS"]}, "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"=>"SEARCH", "pacing_delivery_type"=>"STANDARD", "bid_strategy_type"=>"MAX_BID"}], "ads"=>[{"ad_group_id"=>"AG298325", "pin_id"=>"51819794", "creative_type"=>"REGULAR", "android_deep_link"=>"<string>", "carousel_android_deep_links"=>["<string>", "<string>"], "carousel_destination_urls"=>["<string>", "<string>"], "carousel_ios_deep_links"=>["<string>", "<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>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "view_tracking_url"=>"<string>", "lead_form_id"=>"6"}, {"ad_group_id"=>"AG17", "pin_id"=>"063688205", "creative_type"=>"CAROUSEL", "android_deep_link"=>"<string>", "carousel_android_deep_links"=>["<string>", "<string>"], "carousel_destination_urls"=>["<string>", "<string>"], "carousel_ios_deep_links"=>["<string>", "<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>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "view_tracking_url"=>"<string>", "lead_form_id"=>"5435860"}], "product_groups"=>[{"ad_group_id"=>"AG160", "product_group_promotion"=>[{"id"=>"632", "ad_group_id"=>"AG22438230457", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"50122", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"0639", "catalog_product_group_name"=>"<string>", "creative_type"=>"QUIZ", "collections_hero_pin_id"=>"616", "collections_hero_destination_url"=>"<string>"}, {"id"=>"78367033", "ad_group_id"=>"AG91722", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"6", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"00", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOP_THE_PIN", "collections_hero_pin_id"=>"79610", "collections_hero_destination_url"=>"<string>"}]}, {"ad_group_id"=>"AG8706874717", "product_group_promotion"=>[{"id"=>"95201124502", "ad_group_id"=>"84448524843", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"0757", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"5498126524", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOPPING", "collections_hero_pin_id"=>"8232", "collections_hero_destination_url"=>"<string>"}, {"id"=>"582", "ad_group_id"=>"0143", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"068", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"3239448", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOPPING", "collections_hero_pin_id"=>"813106", "collections_hero_destination_url"=>"<string>"}]}], "keywords"=>[{"keywords"=>[{"match_type"=>"PHRASE", "value"=>"<string>", "bid"=>"<integer>"}, {"match_type"=>"PHRASE", "value"=>"<string>", "bid"=>"<integer>"}], "parent_id"=>"7995"}, {"keywords"=>[{"match_type"=>"PHRASE", "value"=>"<string>", "bid"=>"<integer>"}, {"match_type"=>"EXACT", "value"=>"<string>", "bid"=>"<integer>"}], "parent_id"=>"9651"}]}, "update"=>{"campaigns"=>[{"id"=>"512736", "ad_account_id"=>"1", "name"=>"<string>", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"162", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "start_time"=>"<integer>", "end_time"=>"<integer>", "summary_status"=>"ARCHIVED", "is_campaign_budget_optimization"=>false, "is_flexible_daily_budgets"=>false, "default_ad_group_budget_in_micro_currency"=>"<integer>", "is_automated_campaign"=>false}, {"id"=>"11005726515", "ad_account_id"=>"646316964", "name"=>"<string>", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"919", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "start_time"=>"<integer>", "end_time"=>"<integer>", "summary_status"=>"COMPLETED", "is_campaign_budget_optimization"=>false, "is_flexible_daily_budgets"=>false, "default_ad_group_budget_in_micro_currency"=>"<integer>", "is_automated_campaign"=>false}], "ad_groups"=>[{"id"=>"4667794288", "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"=>"CHECKOUT", "conversion_tag_id"=>"4844", "cpa_goal_value_in_micro_currency"=>"2027471081", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"NOT_ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"TWENTY_FOUR_HOUR"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"11356"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["18-24", "55-64"], "APPTYPE"=>["android_mobile", "web"], "AUDIENCE_EXCLUDE"=>["0728362", "64485"], "AUDIENCE_INCLUDE'"=>["8600", "06"], "GENDER"=>["unknown", "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"=>"ACCELERATED", "campaign_id"=>"5", "billable_event"=>"VIDEO_V_50_MRC", "bid_strategy_type"=>"MAX_BID"}, {"id"=>"02506615562", "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"=>"CUSTOM", "conversion_tag_id"=>"06482", "cpa_goal_value_in_micro_currency"=>"7206", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>nil}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"TEN_MINUTE"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"0570"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["45-49", "18-24"], "APPTYPE"=>["android_tablet", "web"], "AUDIENCE_EXCLUDE"=>["3717469", "62554"], "AUDIENCE_INCLUDE'"=>["08875085072", "386638287"], "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"=>["FIND_NEW_CUSTOMERS", "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"=>"31569", "billable_event"=>"IMPRESSION", "bid_strategy_type"=>"TARGET_AVG"}], "ads"=>[{"id"=>"23381279", "ad_group_id"=>"AG55227016", "android_deep_link"=>"<string>", "carousel_android_deep_links"=>["<string>", "<string>"], "carousel_destination_urls"=>["<string>", "<string>"], "carousel_ios_deep_links"=>["<string>", "<string>"], "click_tracking_url"=>"<string>", "creative_type"=>"QUIZ", "destination_url"=>"<string>", "ios_deep_link"=>"<string>", "is_pin_deleted"=>"<boolean>", "is_removable"=>"<boolean>", "name"=>"<string>", "status"=>"ACTIVE", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "view_tracking_url"=>"<string>", "lead_form_id"=>"25"}, {"id"=>"412", "ad_group_id"=>"5", "android_deep_link"=>"<string>", "carousel_android_deep_links"=>["<string>", "<string>"], "carousel_destination_urls"=>["<string>", "<string>"], "carousel_ios_deep_links"=>["<string>", "<string>"], "click_tracking_url"=>"<string>", "creative_type"=>"VIDEO", "destination_url"=>"<string>", "ios_deep_link"=>"<string>", "is_pin_deleted"=>"<boolean>", "is_removable"=>"<boolean>", "name"=>"<string>", "status"=>"ACTIVE", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "view_tracking_url"=>"<string>", "lead_form_id"=>"24179"}], "product_groups"=>[{"ad_group_id"=>"6061", "product_group_promotion"=>[{"id"=>"8", "ad_group_id"=>"AG80501217", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"395800", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"816", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOWCASE", "collections_hero_pin_id"=>"50982316623", "collections_hero_destination_url"=>"<string>"}, {"id"=>"6023", "ad_group_id"=>"AG213627603", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"112057010", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"9", "catalog_product_group_name"=>"<string>", "creative_type"=>"MAX_VIDEO", "collections_hero_pin_id"=>"9261546", "collections_hero_destination_url"=>"<string>"}]}, {"ad_group_id"=>"AG32", "product_group_promotion"=>[{"id"=>"29564027", "ad_group_id"=>"AG25286401106", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"15439569389", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"PAUSED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"1541829", "catalog_product_group_name"=>"<string>", "creative_type"=>"COLLECTION", "collections_hero_pin_id"=>"21282807", "collections_hero_destination_url"=>"<string>"}, {"id"=>"86713", "ad_group_id"=>"8362280", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"63772826", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"28", "catalog_product_group_name"=>"<string>", "creative_type"=>"COLLECTION", "collections_hero_pin_id"=>"3446978", "collections_hero_destination_url"=>"<string>"}]}], "keywords"=>[{"id"=>"2543373", "archived"=>"<boolean>", "bid"=>"<integer>"}, {"id"=>"8016", "archived"=>"<boolean>", "bid"=>"<integer>"}]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;request_id&quot;:&quot;\u003cstring\u003e&quot;}