Skip to content
AdlyseDocs
Product guideMCP reference
⌘K
Open Adlyse
⌘K
Overview
QuickstartAuthentication
adlyse-insights
adlyse-ads
list_ad_accountsget_platform_supportget_ad_creation_capabilitiesget_ad_build_specupdate_ad_build_speclist_ad_plansget_ad_plan_publicationget_ad_planimport_ad_to_planimport_live_ad_to_plancreate_ad_plan_variantsadd_ad_plan_variantsupdate_ad_plan_groupgroup_ad_plansget_ad_plan_groupfreeze_ad_plan_grouppublish_ad_plan_groupcreate_ad_plancreate_ad_edit_planupdate_ad_planattach_ad_plan_assetfill_ad_plan_slotsfreeze_ad_planpublish_ad_planresolve_ad_publish_steplist_campaignsget_performancelist_change_eventslist_adsget_ad_performancelist_creative_librarylist_experimentsget_experimentpause_experimentresume_experimentstop_experimentpause_creative_adsupdate_ad_group_statusupdate_ad_statusupdate_campaign_statusupdate_campaign_budgetlist_swipe_filesave_competitor_ad_to_swipe_filesave_creative_to_swipe_fileremix_from_swipe_filestart_creative_jobresize_creativemake_variants_of_winnerget_creative_jobestimate_creative_batchstart_creative_batchbatch_to_plan_groupget_creative_batchsnapshot_catalog_productsgenerate_ad_copylist_ad_copycreate_creative_conceptrequest_creative_reviewget_creative_review
adlyse-workflows
adlyse-admin
adlyse-all
  1. Overview
  2. adlyse-ads

batch_to_plan_group

Turn a finished creative batch into an ad plan group: one plan per done cell, built from source_plan_id (an ad plan whose shape every cell’s ad takes) as create_ad_plan_variants builds copies.

Each plan takes its cell’s image in the first media field it fits (as creative:<id>), its copy variant in the step its format writes (held to that copy’s approval at review), and its ad and creative names from the build spec’s name_templates (update_ad_build_spec). Each cell is a row of the batch’s table, recorded as the plan’s source_row. Cells the source cannot take (a size no field fits, a copy format no step writes, a market with no account, unfinished) are listed in skipped with the reason; spec_issues lists images that break their field’s platform spec. Stores plans only: review with freeze_ad_plan_group, then publish_ad_plan_group.

Returns: group (as get_ad_plan_group), table_id, plans [{cell, key, label, account_id, names}], skipped [{cell, reason}], spec_issues [{cell, step_id, field, message}], name_templates; a preview has no group or table

Parameters#

NameTypeRequiredDefaultDescription
batch_idstringyesCreative batch id (crjob_…) from start_creative_batch; it must have finished.
source_plan_idstringyesThe ad plan every cell’s ad is built from.
expected_versionintegeryesThe source plan’s current version.
request_keystringnoA key you choose; reuse it after an uncertain response. Not needed for a preview.
account_by_marketobjectno{market: ad account id}, e.g. {“de-DE”: “act_1”}; cells with no market use the source’s account.
titlestringnoThe group’s title (default: the source’s).
name_templatesobjectno{ad?, creative?} naming templates for this build (default: the build spec’s; tokens as in update_ad_build_spec).
previewbooleannofalseTrue: list the plans it would build, with their names, and write nothing.

Generated by generate_mcp_docs from the server tool. Add to this page below this block; the block is rewritten on every run.

Previousstart_creative_batchNextget_creative_batch