MCP Bid Model tutorial
Use IQM Model Context Protocol (MCP) to interact with the Bid Model API.
Overview
This tutorial guides you through using IQM MCP to interact with the Bid Model app. You'll learn how to create, update, and manage Bid Models using MCP prompts.
Before you begin
To create a Bid Model with IQM MCP, the following are required:
- An account on the IQM platform
- See Before you begin to create an account and request a Client ID and Client Secret
- IQM MCP set up on your computer
- See the MCP Setup guide to set up the MCP with your authorization credentials
- A campaign that meets the following criteria:
- Duration of at least 3 days
- Daily budget of at least $100
- Base bid and max bid price must be defined
About IQM Bid Model
The Bid Model API allows you to optimize advertising campaigns for better performance. You can fine-tune metrics such as where ads appear (Include/Exclude), manage campaign priority, and dimensions by which a campaign is subdivided.
Bid Model settings
Bid Model settings include the following tools:
- Spend Ratio: determines how the campaign budget is distributed across various dimensions, expressed as a percentage in two types
- Strict: budget is allocated up to its specified percentage as able, but underspends if unable to meet that ratio
- Flexible: budget reallocates if unable to fulfill its specified percentage
- Dimension Priority: dictates the sequence of bidding for specified targeting dimensions, expressed as a range of 1-10
- Bid Modifier: adjusts the base bid of a campaign for the specified dimension that is modified, expressed as a multiplier in a range of 0.1-100
Bid Model criteria
IQM currently supports Bid Model settings for the following dimensions:
- Creative: Creative ID
- Location: State, City, ZIP code
- Inventory: Open Exchange, Publisher Category*, Deal ID**
*Spend Ratios are not supported for the publisher category dimension subcategory. Refer to Spend Ratio Overview Help Center article for more information.
**Bid Modifiers are not supported for the deal ID dimension subcategory. Refer to the Bid Modifier Overview Help Center article for more information.
More resources
- Advanced modeling Help Center article
- Bid Model API guidelines
- Create a Bid Model API tutorial
Create a Bid Model
Step 1: Check campaign for eligibility
Before you can create a Bid Model, check that you have an eligible campaign. You can prompt for a list of eligible campaigns, or check a single campaign ID. Try the following prompts:
| Prompt | Response example | Notes |
|---|---|---|
| Show me the list of campaigns eligible for bid modeling | MCP returns a list of campaigns that meet the eligibility criteria for Bid Model settings. tip Prompt for the results to be returned "in a simple table, with reasons why any campaigns are not eligible". | |
| Is campaign 53245 eligible for bid modeling? | MCP checks the specified campaign ID and confirms its eligibility status. |
Step 2: Select dimension
Choose the dimension you want to model for the campaign. You can select from creative, location, or inventory dimensions. Try the following prompt:
| Prompt | Response example | Notes |
|---|---|---|
| Show me a list of dimensions available for bid modeling | See the Bid Model criteria section above for more information on supported dimensions and modeling attributes. |
Step 3: Create Bid Model
The Bid Model management tools allow you to add, update, and delete Bid Model settings for your chosen campaign and dimension. See Manage Bid Model settings in the Bid Model API guidelines for complete documentation.
Use the following prompts to manage your Bid Models:
| Prompt | Response example | Notes |
|---|---|---|
| I want to apply bid modeling to campaign [name or id] | MCP returns the available dimensions for applying Bid Model settings to the declared campaign. It also details the modeling options and attributes possible for each dimension. | |
| Add modeling to the Creative. Bid Modifier: 20, Spend Ratio: 10, Base bid: 5 | MCP finds Creative ID and applies the specified modeling parameters to it. | |
| Update the Creative modeling to have 15% Spend Ratio and 15 multiplier. Also add modeling for Deal ID MN_IQM_Disp70 to have 35% Spend Ratio | MCP can update existing Creative modeling parameters and add new modeling for Deal IDs with specified Spend Ratios. It notes any conflicts or errors in the update process. | |
| Delete the Creative modeling | MCP deletes the specified modeling and notes any remaining modeling for the campaign. |
More Bid Model actions
Bundles
Create a Bid Model Bundle for the specified campaign and dimension IDs. A Bid Model Bundle allows you to group multiple dimension entities and apply modeling attributes at the Bundle level. Try the following prompts:
| Prompt | Response example | Notes |
|---|---|---|
| Create a new Bundle with CMP0001's two creatives | MCP checks the campaign for creatives and bundles them. | |
| Update Bundle 109 by adding Creative ID 232934 | MCP updates the specified Bundle by adding the given Creative ID. | |
| Delete CMP0001's Creative Bundle | MCP deletes the specified Creative Bundle. |
Include/Exclude
Use Include/Exclude modeling to specify where your ads appear based on location or inventory dimensions. Try the following prompts:
| Prompt | Response example | Notes |
|---|---|---|
| Apply bid modeling to Bundle 110. Set priority to 3 and Spend Ratio to 20. However, I would like to exclude Creative ID 232934 | MCP applies modeling to the specified Bundle, setting the priority and Spend Ratio while excluding the specified Creative ID. |
Tools index
In the tables below you can find the complete set of Bid Model tools available in the MCP, categorized by function.
Each tool includes a brief description and a link to the corresponding API documentation for more details on its functionality and usage.
Use this index as a reference to explore the various Bid Model capabilities of the MCP and how they relate to the Bid Model API endpoints.
Bid Model details
| Tool name | Description | Documentation |
|---|---|---|
getBundleDetailsList_1 | Get a list of bundles for a campaign and dimension, with entity and modeling status details | Get list of Bid Model Bundles |
getModelledEntityData | Get modeled entity data for a dimension | Get modeled entities |
getDimensionStatistics | Get dimension-wise counts of modeled items for a campaign | Get campaign dimension statistics |
getDimensionWiseEntitySpentForCampaign_1 | Get dimension-wise spend for a campaign | Get dimension specific spending for a campaign |
getModelledItemsForCampaignAndDimensionId | Get modeled entities and modeling data for a campaign and dimension | Get list of modeled entities for a campaign |
Include/exclude management
| Tool name | Description | Documentation |
|---|---|---|
toggleCampaignDimensionStatus | Include or exclude entities from a campaign | Include/exclude entities from a campaign |
Bid Model management
| Tool name | Description | Documentation |
|---|---|---|
manageBidModelling | Manage bid modeling attributes for a campaign and dimension | Manage Bid Model settings |
createBundle_1 | Create a bundle for a campaign and dimension | Create Bid Model Bundle |
updateBundleDetails_1 | Update a bundle for a campaign and dimension | Update Bid Model Bundle |
deleteBundle_1 | Delete a bundle for a campaign and dimension | Delete Bid Model Bundle |
Bid Model metrics and dimensions
| Tool name | Description | Documentation |
|---|---|---|
fetchCampaignMetricsByDimension | Get a metrics report for a campaign by dimension | Get metrics report for a given campaign and dimension |
getDimensions | Get the list of bid model dimensions | Get list of Bid Model dimensions |
Video demo
Follow along with this video demo of the Bid Model tutorial: