Skip to content
advardeDeveloper docs
v1.0

Update ad group

Loading server catalog…. Download catalog

POSThttps://app.advarde.com/mcp
Prepare change

Upstream account eligibility and feature access may also apply.

Description: Prepare a reviewable change: Update an ad group. Returns a change_id; call ads_apply_change to execute after approval. Some features need Ads account enablement.

Method: tools/call · ads_update_ad_group

Output: Tool data is returned in result.structuredContent and as JSON text in result.content. Inspect result.isError before using the result. Individual output fields depend on the operation.

Access: Requires the applicable write scopes, workspace role, and account permissions.

Upstream operation: POST /ad_groups/{ad_group_id}. Call this through the MCP tool above.

Review before applying

This tool prepares a proposal. Review the exact payload and obtain authorization before calling ads_apply_change. Preparation does not mean the upstream change has been applied.

Authentication

Use an MCP access token from MCP connections, or connect through OAuth. Send your token in the Authorization: Bearer header.

For full protocol initialization and tool discovery, use an MCP client. These examples show individual JSON-RPC requests.

Tool arguments

Send these fields inside params.arguments. The tool name is sent as params.name.

account_idstringrequired

Workspace-owned Advarde connection ID from ads_list_accounts.

format: "uuid"
ad_group_idstringrequired
bodyobjectrequired
additionalProperties: false
EXPAND BODY
namestringoptional
minLength: 3maxLength: 1000pattern: "^.*\\S.*$"
descriptionschemaoptional
EXPAND DESCRIPTION
anyOf · schema 1

See the full schema for accepted values.

{
  "type": "string"
}
anyOf · schema 2

See the full schema for accepted values.

{
  "type": "null"
}
context_hintsarrayoptional
maxItems: 2000
EXPAND CONTEXT_HINTS

Each array item

{
  "type": "string"
}
statusstringoptional
enum: ["active","paused","archived"]
bidding_configobjectoptional
additionalProperties: false
EXPAND BIDDING_CONFIG
billing_event_typestringoptional
enum: ["impression","click"]
strategystringoptional
enum: ["fixed_bid","maximize_clicks","maximize_conversions"]
max_bid_microsintegeroptional
minimum: 1maximum: 30400000000000
custom_audience_bid_multipliersarrayoptional
EXPAND CUSTOM_AUDIENCE_BID_MULTIPLIERS

Each array item

custom_audience_idstringrequired
bid_multiplier_microsintegerrequired
minimum: 100000maximum: 10000000
product_setschemaoptional
EXPAND PRODUCT_SET
anyOf · schema 1
product_feed_idstringoptional
filtersarrayoptional
EXPAND FILTERS

Each array item

fieldstringrequired
operatorstringrequired
enum: ["in","not_in","gt","gte","lt","lte","contains","not_contains","starts_with"]
valuesarrayrequired
EXPAND VALUES

Each array item

{
  "type": "string"
}
{
  "properties": {
    "product_feed_id": {
      "type": "string"
    },
    "filters": {
      "items": {
        "properties": {
          "field": {
            "type": "string"
          },
          "operator": {
            "type": "string",
            "enum": [
              "in",
              "not_in",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains",
              "not_contains",
              "starts_with"
            ],
            "x-openai-class-name": "sofa.api.params.ad_groups.ProductSetFilterOperatorParam"
          },
          "values": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "object",
        "required": [
          "field",
          "operator",
          "values"
        ],
        "x-openai-class-name": "sofa.api.params.ad_groups.ProductSetFilterParams",
        "additionalProperties": false
      },
      "type": "array"
    }
  },
  "type": "object",
  "required": [],
  "x-openai-class-name": "sofa.api.params.ad_groups.ProductSetParams",
  "additionalProperties": false
}
anyOf · schema 2

See the full schema for accepted values.

{
  "type": "null"
}
landing_page_configurationschemaoptional
EXPAND LANDING_PAGE_CONFIGURATION
anyOf · schema 1
query_string_templatestringoptional
{
  "properties": {
    "query_string_template": {
      "type": "string"
    }
  },
  "type": "object",
  "required": [],
  "x-openai-class-name": "sofa.api.params.campaigns.LandingPageConfigurationParams",
  "additionalProperties": false
}
anyOf · schema 2

See the full schema for accepted values.

{
  "type": "null"
}
Full JSON Schema
{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Workspace-owned Advarde connection ID from ads_list_accounts."
    },
    "ad_group_id": {
      "type": "string"
    },
    "body": {
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 1000,
          "minLength": 3,
          "pattern": "^.*\\S.*$"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "context_hints": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "maxItems": 2000
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "paused",
            "archived"
          ],
          "x-openai-class-name": "sofa.api.params.common.ActivePausedArchivedStatusParam"
        },
        "bidding_config": {
          "properties": {
            "billing_event_type": {
              "type": "string",
              "enum": [
                "impression",
                "click"
              ],
              "x-openai-class-name": "sofa.api.params.ad_groups.BillingEventTypeParam"
            },
            "strategy": {
              "type": "string",
              "enum": [
                "fixed_bid",
                "maximize_clicks",
                "maximize_conversions"
              ],
              "x-openai-class-name": "sofa.api.params.ad_groups.BiddingStrategyTypeParam"
            },
            "max_bid_micros": {
              "type": "integer",
              "maximum": 30400000000000,
              "minimum": 1
            },
            "custom_audience_bid_multipliers": {
              "items": {
                "properties": {
                  "custom_audience_id": {
                    "type": "string"
                  },
                  "bid_multiplier_micros": {
                    "type": "integer",
                    "maximum": 10000000,
                    "minimum": 100000
                  }
                },
                "type": "object",
                "required": [
                  "custom_audience_id",
                  "bid_multiplier_micros"
                ],
                "x-openai-class-name": "sofa.api.params.ad_groups.CustomAudienceBidMultiplierParams",
                "additionalProperties": false
              },
              "type": "array"
            }
          },
          "type": "object",
          "required": [],
          "x-openai-class-name": "sofa.api.params.ad_groups.BiddingConfigParams",
          "additionalProperties": false
        },
        "product_set": {
          "anyOf": [
            {
              "properties": {
                "product_feed_id": {
                  "type": "string"
                },
                "filters": {
                  "items": {
                    "properties": {
                      "field": {
                        "type": "string"
                      },
                      "operator": {
                        "type": "string",
                        "enum": [
                          "in",
                          "not_in",
                          "gt",
                          "gte",
                          "lt",
                          "lte",
                          "contains",
                          "not_contains",
                          "starts_with"
                        ],
                        "x-openai-class-name": "sofa.api.params.ad_groups.ProductSetFilterOperatorParam"
                      },
                      "values": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object",
                    "required": [
                      "field",
                      "operator",
                      "values"
                    ],
                    "x-openai-class-name": "sofa.api.params.ad_groups.ProductSetFilterParams",
                    "additionalProperties": false
                  },
                  "type": "array"
                }
              },
              "type": "object",
              "required": [],
              "x-openai-class-name": "sofa.api.params.ad_groups.ProductSetParams",
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "landing_page_configuration": {
          "anyOf": [
            {
              "properties": {
                "query_string_template": {
                  "type": "string"
                }
              },
              "type": "object",
              "required": [],
              "x-openai-class-name": "sofa.api.params.campaigns.LandingPageConfigurationParams",
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object",
      "required": [],
      "x-openai-class-name": "sofa.api.params.ad_groups.UpdateAdGroupBody",
      "additionalProperties": false
    }
  },
  "required": [
    "account_id",
    "ad_group_id",
    "body"
  ],
  "additionalProperties": false
}

Responses

200Successful protocol response

Inspect result.isError for tool-level failures, even when the HTTP status is 200.

202Notification accepted

MCP notifications return no JSON-RPC response body.

400Invalid request

Check the JSON-RPC envelope, parameters, and protocol version.

406Not acceptable

Accept must include application/json and text/event-stream.

429Rate limited

Wait for the Retry-After interval before making another request.

401Unauthorized

A valid, unexpired MCP bearer token is required.

403Access denied

Your connection needs access to this workspace and the requested operation.

Advarde MCP API v1.0