Skip to main content
POST
/
api
/
v1
/
campaigns
/
prefill
Create pre-populated campaign draft from market analysis
curl --request POST \
  --url http://localhost:8000/api/v1/campaigns/prefill \
  --header 'Authorization: Bearer <token>'
{
  "market_analysis_id": 123,
  "market_analysis_title": "<string>",
  "google_ads_customer_id": 123,
  "suggested_campaign_name": "<string>",
  "language_ids": [
    123
  ],
  "location_targets": [
    {
      "geo_target_constant_id": 123,
      "target_type": "INCLUDE"
    }
  ],
  "network_settings": {
    "target_google_search": true,
    "target_search_network": false,
    "target_content_network": false
  },
  "ad_schedule": {
    "mode": "ALL_TIME",
    "schedule_entries": [
      {
        "day_of_week": "MONDAY",
        "start_hour": 11,
        "end_hour": 12,
        "start_minute": 0,
        "end_minute": 0
      }
    ]
  },
  "default_match_type": "EXACT",
  "ad_groups": [
    {
      "id": 123,
      "name": "<string>",
      "keywords": [
        {
          "text": "<string>",
          "match_type": "EXACT",
          "cpc_bid_micros": 123,
          "final_url": "<string>",
          "market_analysis_keyword_id": 123
        }
      ],
      "cpc_bid_micros": 123
    }
  ],
  "draft_id": 123,
  "website_url": "<string>",
  "bidding_strategy": {
    "type": "MAXIMIZE_CONVERSIONS",
    "target_cpa_micros": 123,
    "target_roas": 1,
    "max_cpc_bid_ceiling_micros": 123
  },
  "conversion_goals": [
    {
      "goal_type": "CAMPAIGN_SPECIFIC",
      "conversion_action_id": 1,
      "category": "PURCHASE"
    }
  ],
  "extensions": {
    "sitelinks": [
      {
        "link_text": "<string>",
        "final_url": "<string>",
        "description_1": "<string>",
        "description_2": "<string>",
        "final_mobile_url": "<string>"
      }
    ],
    "callouts": [
      {
        "callout_text": "<string>"
      }
    ],
    "phone": {
      "phone_number": "<string>",
      "country_code": "<string>"
    },
    "structured_snippets": [
      {
        "header": "AMENITIES",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "ad_groups_task_id": "<string>",
  "rsa_task_ids": [
    "<string>"
  ],
  "ad_groups_generation_status": "pending",
  "ad_groups_generation_error": "<string>",
  "rsas_generation_status": "not_started",
  "extensions_generation_status": "not_started",
  "is_published": false,
  "all_rsas_generated": false
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

market_analysis_id
integer
required

Market analysis ID to prefill from

Response

Successful Response

Response schema for campaign prefill from market analysis.

Contains pre-populated campaign data derived from market analysis. A draft is created internally and async tasks are kicked off for ad group splitting and RSA generation.

Fields requiring user input are returned as empty/null.

market_analysis_id
integer
required
market_analysis_title
string
required
google_ads_customer_id
integer
required
suggested_campaign_name
string
required
language_ids
integer[]
required
location_targets
LocationTargetSchema · object[]
required
network_settings
NetworkSettingsSchema · object
required

Network settings for campaign.

ad_schedule
AdScheduleSchema · object
required

Ad schedule configuration.

default_match_type
enum<string>
required

The keyword match types.

Available options:
EXACT,
PHRASE,
BROAD,
BROAD_MODIFIER,
NEGATIVE
ad_groups
AdGroupInputSchema · object[]
required
draft_id
integer
required
website_url
string<uri> | null
Required string length: 1 - 2083
bidding_strategy
BiddingStrategySchema · object

Bidding strategy configuration.

conversion_goals
ConversionGoalSchema · object[]
extensions
ExtensionsInputSchema · object

All extensions configuration.

ad_groups_task_id
string | null
rsa_task_ids
string[]
ad_groups_generation_status
enum<string>
default:pending

Status of background task generation (ad groups, RSAs).

Available options:
not_started,
pending,
in_progress,
completed,
failed
ad_groups_generation_error
string | null
rsas_generation_status
enum<string>
default:not_started

Status of background task generation (ad groups, RSAs).

Available options:
not_started,
pending,
in_progress,
completed,
failed
extensions_generation_status
enum<string>
default:not_started

Status of background task generation (ad groups, RSAs).

Available options:
not_started,
pending,
in_progress,
completed,
failed
is_published
boolean
default:false
all_rsas_generated
boolean
default:false