-
Notifications
You must be signed in to change notification settings - Fork 4
Mutation Reference
John Williams edited this page Mar 6, 2026
·
1 revision
Detailed parameter reference for all 62 write operations.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Campaign name |
budgetAmountDollars |
number | Yes | Daily budget in dollars |
channelType |
string | No |
SEARCH, DISPLAY, SHOPPING, PERFORMANCE_MAX, VIDEO, DEMAND_GEN
|
biddingStrategy |
string | No |
MAXIMIZE_CONVERSIONS, MAXIMIZE_CONVERSION_VALUE, TARGET_CPA, TARGET_ROAS, MANUAL_CPC, MAXIMIZE_CLICKS
|
targetCpa |
number | No | Target CPA in micros (for TARGET_CPA) |
targetRoas |
number | No | Target ROAS multiplier (for TARGET_ROAS) |
status |
string | No |
PAUSED (default) or ENABLED
|
merchantId |
string | No | Merchant Center ID (for Shopping/PMax) |
feedLabel |
string | No | Feed label (for Shopping) |
searchPartners |
boolean | No | Include search partners |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
status |
string | Yes (ENABLED or PAUSED) |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
name |
string | No |
targetCpa |
number | No |
targetRoas |
number | No |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
biddingStrategy |
string | Yes |
targetCpa |
number | No |
targetRoas |
number | No |
targetCpaDollars |
number | No |
enhancedCpc |
boolean | No |
| Parameter | Type | Required |
|---|---|---|
budgetId |
string | Yes |
amountDollars |
number | Yes |
| Parameter | Type | Required |
|---|---|---|
name |
string | Yes |
amountDollars |
number | Yes |
deliveryMethod |
string | No |
| Parameter | Type | Required |
|---|---|---|
budgetId |
string | Yes |
amountDollars |
number | No |
name |
string | No |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
budgetId |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
name |
string | Yes |
cpcBidDollars |
number | No |
type |
string | No |
status |
string | No |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
status |
string | No |
cpcBidMicros |
number | No |
name |
string | No |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
headlines |
array | Yes (up to 15, max 30 chars each) |
descriptions |
array | Yes (up to 4, max 90 chars each) |
finalUrl |
string | Yes |
path1 |
string | No (max 15 chars) |
path2 |
string | No (max 15 chars) |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
headlines |
array | No |
longHeadline |
string | No |
descriptions |
array | No |
businessName |
string | No |
finalUrl |
string | No |
marketingImageAssetIds |
array | No |
squareImageAssetIds |
array | No |
logoAssetIds |
array | No |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
adId |
string | Yes |
headlines |
array | Yes |
descriptions |
array | Yes |
finalUrl |
string | Yes |
path1 |
string | No |
path2 |
string | No |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
adId |
string | Yes |
status |
string | Yes (ENABLED or PAUSED) |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
adId |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
keyword |
string | Yes |
matchType |
string | No (BROAD, PHRASE, EXACT) |
cpcBidDollars |
number | No |
finalUrl |
string | No |
| Parameter | Type | Required |
|---|---|---|
criterionId |
string | Yes |
adGroupId |
string | Yes |
status |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
criterionId |
string | Yes |
cpcBidMicros |
number | Yes |
| Parameter | Type | Required |
|---|---|---|
adGroupId |
string | Yes |
criterionId |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
keyword |
string | Yes |
matchType |
string | No |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
criterionId |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
linkText |
string | Yes |
finalUrl |
string | Yes |
description1 |
string | No |
description2 |
string | No |
| Parameter | Type | Required |
|---|---|---|
calloutText |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
header |
string | Yes |
values |
array | Yes (3+ items) |
campaignId |
string | No |
| Parameter | Type | Required |
|---|---|---|
phoneNumber |
string | Yes |
countryCode |
string | Yes |
campaignId |
string | No |
callTrackingEnabled |
boolean | No |
| Parameter | Type | Required |
|---|---|---|
type |
string | Yes |
priceOfferings |
array | Yes (3+ items) |
campaignId |
string | No |
currency |
string | No |
language |
string | No |
| Parameter | Type | Required |
|---|---|---|
promotionTarget |
string | Yes |
finalUrl |
string | Yes |
campaignId |
string | No |
percentOff |
number | No |
moneyOff |
number | No |
discountModifier |
string | No |
occasion |
string | No |
promotionCode |
string | No |
| Parameter | Type | Required |
|---|---|---|
headline |
string | Yes |
businessName |
string | Yes |
description |
string | Yes |
privacyPolicyUrl |
string | Yes |
fields |
array | Yes |
callToActionType |
string | No |
deliveryMethods |
array | No |
| Parameter | Type | Required |
|---|---|---|
imageUrl |
string | Yes |
campaignId |
string | No |
name |
string | No |
| Parameter | Type | Required |
|---|---|---|
name |
string | Yes |
type |
string | Yes |
category |
string | Yes |
countingType |
string | No |
defaultValue |
number | No |
defaultCurrency |
string | No |
viewThroughDays |
number | No |
clickThroughDays |
number | No |
attributionModel |
string | No |
| Parameter | Type | Required |
|---|---|---|
conversionActionId |
string | Yes |
name |
string | No |
status |
string | No |
category |
string | No |
countingType |
string | No |
| Parameter | Type | Required |
|---|---|---|
name |
string | Yes |
campaignId |
string | Yes |
trafficSplitPercent |
number | Yes |
description |
string | No |
startDate |
string | No |
endDate |
string | No |
| Parameter | Type | Required |
|---|---|---|
experimentId |
string | Yes |
promoteVariant |
boolean | No (end only) |
| Parameter | Type | Required |
|---|---|---|
campaignId |
string | Yes |
name |
string | Yes |
finalUrl |
string | No |
headlines |
array | No |
descriptions |
array | No |
businessName |
string | No |
| Parameter | Type | Required |
|---|---|---|
assetGroupId |
string | Yes |
assetId |
string | Yes |
fieldType |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
imageData |
string | Yes (base64) |
name |
string | Yes |
| Parameter | Type | Required |
|---|---|---|
text |
string | Yes |
| Action | Required Params |
|---|---|
mc_insert_product |
merchantId, product
|
mc_list_products |
merchantId |
mc_update_product |
merchantId, productId, updates
|
mc_delete_product |
merchantId, productId
|
mc_get_product_status |
merchantId |