microsoft_ads_get_impression_share
Get Microsoft Ads Impression Share
MicrosoftDescription
Read-onlyOpen-world
Usage
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "microsoft_ads_get_impression_share",
"arguments": {}
}
}
hopkin microsoft impression-share get
| Flag | Type | Required | Description |
|---|---|---|---|
--account | string | Required | Microsoft Advertising account ID (AccountId). Required. |
--customer-id | string | Optional | Customer/manager ID (CustomerId). Required when accessing accounts under a manager hierarchy. |
--date-range | object | Optional | Custom date range. Provide either date_range or date_preset. |
--date-preset | string | Optional | Predefined date range: Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear. |
--level | string | Optional | Report level: Campaign (default) returns IS per campaign; AdGroup returns IS broken down per ad group within each campaign. |
--campaign-ids | array | Optional | Filter to specific campaign IDs (up to 100). Accepts JSON array string or actual array. |
--campaign-type | array | Optional | Return only rows from campaigns of these types. Options: Search, Shopping, PerformanceMax, Audience. Applied to the report rows before limit, typing each campaign from Microsoft's current campaign list (the impression share report carries no type). Rows from campaigns missing from that list, such as deleted ones, are excluded and counted in warnings. |
--aggregation | string | Optional | Report aggregation period. Daily (default), Weekly, Monthly, or Summary (all dates collapsed). |
--limit | integer | Optional | Page size: rows per page (1–10000, default 1000). count is the total across all pages. When more rows remain the response carries nextCursor; pass it back as cursor to get the next page. |
--cursor | string | Optional | Opaque pagination cursor. Omit for the first page. To fetch the next page, pass the nextCursor value from the previous response unchanged and repeat every other parameter exactly (only limit may change); a cursor used with different parameters is rejected. Later pages re-read the same report, so a cursor expires with it (about 24 hours). |
--connection-id | string | Optional | Optional ID of a specific connection to use for this call. Omit to use the actor's default connection for this network. Call <platform>_list_connections to discover available connection IDs. |
{
"mcpServers": {
"microsoft-ads": {
"url": "https://microsoft.mcp.hopkin.ai",
"transport": "sse"
}
}
}
No example prompts available.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
string |
Required | Microsoft Advertising account ID (AccountId). Required.minLength: 1 |
reason |
string |
Required | Why this tool call is neededminLength: 1, maxLength: 500 |
Optional parameters (10)
| Name | Type | Required | Description |
|---|---|---|---|
customer_id |
string |
Optional | Customer/manager ID (CustomerId). Required when accessing accounts under a manager hierarchy.minLength: 1 |
date_range |
object |
Optional | Custom date range. Provide either date_range or date_preset. |
date_preset |
string |
Optional | Predefined date range: Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.Today Yesterday LastSevenDays ThisWeek LastWeek LastFourWeeks ThisMonth LastMonth LastThreeMonths LastSixMonths ThisYear LastYear |
level |
string |
Optional | Report level: Campaign (default) returns IS per campaign; AdGroup returns IS broken down per ad group within each campaign.Campaign AdGroup |
campaign_ids |
array |
Optional | Filter to specific campaign IDs (up to 100). Accepts JSON array string or actual array. |
campaign_type |
array |
Optional | Return only rows from campaigns of these types. Options: Search, Shopping, PerformanceMax, Audience. Applied to the report rows before limit, typing each campaign from Microsoft's current campaign list (the impression share report carries no type). Rows from campaigns missing from that list, such as deleted ones, are excluded and counted in warnings. |
aggregation |
string |
Optional | Report aggregation period. Daily (default), Weekly, Monthly, or Summary (all dates collapsed).Daily Weekly Monthly Summary |
limit |
integer |
Optional | Page size: rows per page (1–10000, default 1000). count is the total across all pages. When more rows remain the response carries nextCursor; pass it back as cursor to get the next page.min: 1, max: 10000 |
cursor |
string |
Optional | Opaque pagination cursor. Omit for the first page. To fetch the next page, pass the nextCursor value from the previous response unchanged and repeat every other parameter exactly (only limit may change); a cursor used with different parameters is rejected. Later pages re-read the same report, so a cursor expires with it (about 24 hours).minLength: 1 |
connection_id |
string |
Optional | Optional ID of a specific connection to use for this call. Omit to use the actor's default connection for this network. Call <platform>_list_connections to discover available connection IDs. |