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"=>"WEB_SESSIONS", "ad_account_id"=>"93932833377", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"846", "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"=>"NOT_STARTED", "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"=>"CATALOG_SALES", "ad_account_id"=>"62694", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"284918", "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"=>"883", "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"=>"ADD_TO_CART", "conversion_tag_id"=>"264", "cpa_goal_value_in_micro_currency"=>"69181", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>nil}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"09462506000"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["65+", "50-54"], "APPTYPE"=>["android_tablet", "iphone"], "AUDIENCE_EXCLUDE"=>["2", "06094633506"], "AUDIENCE_INCLUDE'"=>["8698", "0241071"], "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"=>["CHOOSE_YOUR_OWN", "RECONNECT_WITH_USERS"]}, "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", "bid_strategy_type"=>"MAX_BID"}, {"billable_event"=>"CLICKTHROUGH", "campaign_id"=>"C8272842", "name"=>"<string>", "status"=>"PAUSED", "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"=>"9355", "cpa_goal_value_in_micro_currency"=>"8627", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"SEVEN_DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"2552"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["35-44", "25-34"], "APPTYPE"=>["android_tablet", "iphone"], "AUDIENCE_EXCLUDE"=>["1128400", "2784815"], "AUDIENCE_INCLUDE'"=>["02", "0"], "GENDER"=>["male", "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", "RECONNECT_WITH_USERS"]}, "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"=>"AUTOMATIC_BID"}], "ads"=>[{"ad_group_id"=>"386", "pin_id"=>"8488202360", "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>"}, {"ad_group_id"=>"AG91569", "pin_id"=>"3", "creative_type"=>"SHOP_THE_PIN", "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>"}], "product_groups"=>[{"ad_group_id"=>"2632862", "product_group_promotion"=>[{"id"=>"0666", "ad_group_id"=>"94909", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"80865858130", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"56080", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOP_THE_PIN", "collections_hero_pin_id"=>"84516377844", "collections_hero_destination_url"=>"<string>"}, {"id"=>"7382915", "ad_group_id"=>"7330", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"8123682591", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"0088549173", "catalog_product_group_name"=>"<string>", "creative_type"=>"REGULAR", "collections_hero_pin_id"=>"7874210836", "collections_hero_destination_url"=>"<string>"}]}, {"ad_group_id"=>"AG2", "product_group_promotion"=>[{"id"=>"2582930", "ad_group_id"=>"AG1025289248", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"26", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"33464476", "catalog_product_group_name"=>"<string>", "creative_type"=>"IDEA", "collections_hero_pin_id"=>"28", "collections_hero_destination_url"=>"<string>"}, {"id"=>"1", "ad_group_id"=>"AG6803", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"2945066550", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"63905815947", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOP_THE_PIN", "collections_hero_pin_id"=>"794704", "collections_hero_destination_url"=>"<string>"}]}], "keywords"=>[{"keywords"=>[{"match_type"=>"PHRASE", "value"=>"<string>", "bid"=>"<integer>"}, {"match_type"=>"PHRASE_NEGATIVE", "value"=>"<string>", "bid"=>"<integer>"}], "parent_id"=>"6"}, {"keywords"=>[{"match_type"=>"EXACT_NEGATIVE", "value"=>"<string>", "bid"=>"<integer>"}, {"match_type"=>"PHRASE", "value"=>"<string>", "bid"=>"<integer>"}], "parent_id"=>"01930092"}]}, "update"=>{"campaigns"=>[{"id"=>"006799", "ad_account_id"=>"64494016", "name"=>"<string>", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"8536347", "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"=>"PAUSED", "is_campaign_budget_optimization"=>false, "is_flexible_daily_budgets"=>false, "default_ad_group_budget_in_micro_currency"=>"<integer>", "is_automated_campaign"=>false}, {"id"=>"14791098475", "ad_account_id"=>"3549390", "name"=>"<string>", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"03121", "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"=>"NOT_STARTED", "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"=>"9", "name"=>"<string>", "status"=>"PAUSED", "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"=>"05428", "cpa_goal_value_in_micro_currency"=>"6102719453", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"THIRTY_DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"4388075"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["65+", "25-34"], "APPTYPE"=>["web_mobile", "android_tablet"], "AUDIENCE_EXCLUDE"=>["44881974", "856085264"], "AUDIENCE_INCLUDE'"=>["90035546818", "9884194378"], "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"=>["FIND_NEW_CUSTOMERS", "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"=>"BROWSE", "pacing_delivery_type"=>"ACCELERATED", "campaign_id"=>"C6651798251", "billable_event"=>"VIDEO_V_50_MRC", "bid_strategy_type"=>nil}, {"id"=>"97621412", "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"=>"14841365", "cpa_goal_value_in_micro_currency"=>"05", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"SEVEN_DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"10997936"}}, "budget_type"=>"CBO_ADGROUP", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["45-49", "55-64"], "APPTYPE"=>["ipad", "ipad"], "AUDIENCE_EXCLUDE"=>["7", "580646"], "AUDIENCE_INCLUDE'"=>["44135804444", "114397606"], "GENDER"=>["male", "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", "campaign_id"=>"C69", "billable_event"=>"CLICKTHROUGH", "bid_strategy_type"=>nil}], "ads"=>[{"id"=>"4552397", "ad_group_id"=>"AG4519", "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"=>"ARCHIVED", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "view_tracking_url"=>"<string>"}, {"id"=>"11150", "ad_group_id"=>"527", "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"=>"SHOWCASE", "destination_url"=>"<string>", "ios_deep_link"=>"<string>", "is_pin_deleted"=>"<boolean>", "is_removable"=>"<boolean>", "name"=>"<string>", "status"=>"ARCHIVED", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "view_tracking_url"=>"<string>"}], "product_groups"=>[{"ad_group_id"=>"3613343667", "product_group_promotion"=>[{"id"=>"648031", "ad_group_id"=>"45307", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"885", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"2476390559", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOP_THE_PIN", "collections_hero_pin_id"=>"222977", "collections_hero_destination_url"=>"<string>"}, {"id"=>"5828936253", "ad_group_id"=>"575", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"91833", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"7", "catalog_product_group_name"=>"<string>", "creative_type"=>"VIDEO", "collections_hero_pin_id"=>"843001775", "collections_hero_destination_url"=>"<string>"}]}, {"ad_group_id"=>"96962", "product_group_promotion"=>[{"id"=>"299", "ad_group_id"=>"23022742204", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"953985641", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"1", "catalog_product_group_name"=>"<string>", "creative_type"=>"QUIZ", "collections_hero_pin_id"=>"829723", "collections_hero_destination_url"=>"<string>"}, {"id"=>"16575652650", "ad_group_id"=>"717", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"44942450", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"PAUSED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"37747072", "catalog_product_group_name"=>"<string>", "creative_type"=>"COLLECTION", "collections_hero_pin_id"=>"238864431", "collections_hero_destination_url"=>"<string>"}]}], "keywords"=>[{"id"=>"909", "archived"=>"<boolean>", "bid"=>"<integer>"}, {"id"=>"22970947608", "archived"=>"<boolean>", "bid"=>"<integer>"}]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

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