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"=>"CATALOG_SALES", "ad_account_id"=>"56335121659", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"4567", "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}, {"name"=>"<string>", "objective_type"=>"CATALOG_SALES", "ad_account_id"=>"64615847396", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"58199475018", "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"=>[{"billable_event"=>"IMPRESSION", "campaign_id"=>"9", "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"=>"PAGE_VISIT", "conversion_tag_id"=>"28", "cpa_goal_value_in_micro_currency"=>"68914099", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"NOT_ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"THIRTY_DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"4853589329"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["50-54", "35-44"], "APPTYPE"=>["android_tablet", "web_mobile"], "AUDIENCE_EXCLUDE"=>["3042780060", "8993139"], "AUDIENCE_INCLUDE'"=>["23923", "34675"], "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", "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"=>"SEARCH", "pacing_delivery_type"=>"STANDARD", "bid_strategy_type"=>nil}, {"billable_event"=>"CLICKTHROUGH", "campaign_id"=>"C4368997257", "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"=>"88659343", "cpa_goal_value_in_micro_currency"=>"5766088304", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"NOT_ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"55294"}}, "budget_type"=>"DAILY", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["21+", "21+"], "APPTYPE"=>["web", "android_mobile"], "AUDIENCE_EXCLUDE"=>["31533992585", "6742198"], "AUDIENCE_INCLUDE'"=>["8", "84544249"], "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"=>["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"=>"ALL", "pacing_delivery_type"=>"STANDARD", "bid_strategy_type"=>"TARGET_AVG"}], "ads"=>[{"ad_group_id"=>"AG54825127837", "pin_id"=>"4", "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>"}, {"ad_group_id"=>"658", "pin_id"=>"786793402", "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"=>"PAUSED", "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"=>"AG4", "product_group_promotion"=>[{"id"=>"17769", "ad_group_id"=>"2496388934", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"7857670", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"186", "catalog_product_group_name"=>"<string>", "creative_type"=>"REGULAR", "collections_hero_pin_id"=>"55", "collections_hero_destination_url"=>"<string>"}, {"id"=>"1551107", "ad_group_id"=>"AG209447081", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"839", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"95", "catalog_product_group_name"=>"<string>", "creative_type"=>"QUIZ", "collections_hero_pin_id"=>"4354", "collections_hero_destination_url"=>"<string>"}]}, {"ad_group_id"=>"2125801339", "product_group_promotion"=>[{"id"=>"29404495", "ad_group_id"=>"AG5784680682", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"55227", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"PAUSED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"882271215", "catalog_product_group_name"=>"<string>", "creative_type"=>"CAROUSEL", "collections_hero_pin_id"=>"59453", "collections_hero_destination_url"=>"<string>"}, {"id"=>"1", "ad_group_id"=>"1689", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"1790", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"37560329411", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOPPING", "collections_hero_pin_id"=>"1", "collections_hero_destination_url"=>"<string>"}]}], "keywords"=>[{"keywords"=>[{"match_type"=>"BROAD", "value"=>"<string>", "bid"=>"<integer>"}, {"match_type"=>nil, "value"=>"<string>", "bid"=>"<integer>"}], "parent_id"=>"252034665"}, {"keywords"=>[{"match_type"=>"EXACT_NEGATIVE", "value"=>"<string>", "bid"=>"<integer>"}, {"match_type"=>"EXACT_NEGATIVE", "value"=>"<string>", "bid"=>"<integer>"}], "parent_id"=>"6807995"}]}, "update"=>{"campaigns"=>[{"id"=>"7", "ad_account_id"=>"49090", "name"=>"<string>", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"268", "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"=>"1577632", "ad_account_id"=>"97273793", "name"=>"<string>", "status"=>"ACTIVE", "lifetime_spend_cap"=>"<integer>", "daily_spend_cap"=>"<integer>", "order_line_id"=>"421453", "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}], "ad_groups"=>[{"id"=>"45326", "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"=>"9", "cpa_goal_value_in_micro_currency"=>"7145558", "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"=>"445212569"}}, "budget_type"=>"CBO_ADGROUP", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["35-44", "65+"], "APPTYPE"=>["iphone", "web"], "AUDIENCE_EXCLUDE"=>["9204176", "24407"], "AUDIENCE_INCLUDE'"=>["6306392", "08"], "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", "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"=>"SEARCH", "pacing_delivery_type"=>"STANDARD", "campaign_id"=>"C08", "billable_event"=>"CLICKTHROUGH", "bid_strategy_type"=>"MAX_BID"}, {"id"=>"5", "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"=>"LEAD", "conversion_tag_id"=>"187445381", "cpa_goal_value_in_micro_currency"=>"70844", "is_roas_optimized"=>"<boolean>", "learning_mode_type"=>"NOT_ACTIVE"}, "frequency_goal_metadata"=>{"frequency"=>"<integer>", "timerange"=>"DAY"}, "scrollup_goal_metadata"=>{"scrollup_goal_value_in_micro_currency"=>"054"}}, "budget_type"=>"LIFETIME", "start_time"=>"<integer>", "end_time"=>"<integer>", "targeting_spec"=>{"AGE_BUCKET"=>["50-54", "25-34"], "APPTYPE"=>["android_tablet", "android_mobile"], "AUDIENCE_EXCLUDE"=>["895095", "6330"], "AUDIENCE_INCLUDE'"=>["7", "24829"], "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"=>["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"=>"SEARCH", "pacing_delivery_type"=>"ACCELERATED", "campaign_id"=>"56", "billable_event"=>"IMPRESSION", "bid_strategy_type"=>"AUTOMATIC_BID"}], "ads"=>[{"id"=>"95", "ad_group_id"=>"81209874", "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"=>"REGULAR", "destination_url"=>"<string>", "ios_deep_link"=>"<string>", "is_pin_deleted"=>"<boolean>", "is_removable"=>"<boolean>", "name"=>"<string>", "status"=>"PAUSED", "tracking_urls"=>{"impression"=>["<string>", "<string>"], "click"=>["<string>", "<string>"], "engagement"=>["<string>", "<string>"], "buyable_button"=>["<string>", "<string>"], "audience_verification"=>["<string>", "<string>"]}, "view_tracking_url"=>"<string>"}, {"id"=>"973524891", "ad_group_id"=>"AG70832020054", "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"=>"CAROUSEL", "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"=>"751", "product_group_promotion"=>[{"id"=>"56817", "ad_group_id"=>"8347144", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"823259", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ARCHIVED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"692", "catalog_product_group_name"=>"<string>", "creative_type"=>"IDEA", "collections_hero_pin_id"=>"0719503", "collections_hero_destination_url"=>"<string>"}, {"id"=>"0098324521", "ad_group_id"=>"AG74694", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"4", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"PAUSED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"008538", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOP_THE_PIN", "collections_hero_pin_id"=>"338533", "collections_hero_destination_url"=>"<string>"}]}, {"ad_group_id"=>"AG2914", "product_group_promotion"=>[{"id"=>"1472027", "ad_group_id"=>"7", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"21632", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"ACTIVE", "tracking_url"=>"<string>", "catalog_product_group_id"=>"12226857666", "catalog_product_group_name"=>"<string>", "creative_type"=>"SHOPPING", "collections_hero_pin_id"=>"8244153", "collections_hero_destination_url"=>"<string>"}, {"id"=>"27299", "ad_group_id"=>"975434947", "bid_in_micro_currency"=>"<integer>", "included"=>"<boolean>", "definition"=>"<string>", "relative_definition"=>"<string>", "parent_id"=>"98275", "slideshow_collections_title"=>"<string>", "slideshow_collections_description"=>"<string>", "is_mdl"=>"<boolean>", "status"=>"PAUSED", "tracking_url"=>"<string>", "catalog_product_group_id"=>"50777", "catalog_product_group_name"=>"<string>", "creative_type"=>"VIDEO", "collections_hero_pin_id"=>"5857090404", "collections_hero_destination_url"=>"<string>"}]}], "keywords"=>[{"id"=>"578532918", "archived"=>"<boolean>", "bid"=>"<integer>"}, {"id"=>"8727302270", "archived"=>"<boolean>", "bid"=>"<integer>"}]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

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