Skip to main content
Microsoft Advertising logo
  • Category: ads & conversion
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 14
  • Triggers: 0
  • Slug: MICROSOFT_ADVERTISING
  • Version: 00000000_00

Tools

Slug: MICROSOFT_ADVERTISING_ACTIVATE_AD_GROUPSActivate up to 1,000 ad groups in a Microsoft Advertising campaign. WARNING: Activation can immediately make eligible ads deliver and incur spend when the parent campaign, bids, targeting, and ads permit delivery. Verify the selected IDs and campaign configuration before calling. Inspect partial_errors because Microsoft can accept the request while rejecting individual activations.

Input Parameters

string
required
Advertiser account ID containing the parent campaign.
string
required
Campaign ID containing the ad groups to activate.
string
required
Manager customer ID through which the connected user operates the advertiser account.
array
required
IDs of up to 1,000 ad groups to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_ACTIVATE_CAMPAIGNSActivate 1 to 100 Microsoft Advertising campaigns. This can immediately make configured ads eligible for delivery and cause the account to incur ad spend. Inspect partial_errors because Microsoft can accept the request while rejecting individual campaign activations.

Input Parameters

string
required
Advertiser account ID containing the campaigns to activate.
string
required
Manager customer ID through which the connected user operates the advertiser account.
array
required
Campaign IDs to activate. Activating campaigns can enable configured ads to deliver and incur spend.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_CREATE_SEARCH_AD_GROUPSCreate up to 1,000 Search ad groups under a Microsoft Advertising campaign. Ad groups default to Paused. HTTP success can include failed items, represented by null ad_group_ids and indexed partial_errors.

Input Parameters

array
required
Search ad groups to create, up to 1,000. Each item is sent as SearchStandard and defaults to Paused.
string
required
Advertiser account ID containing the parent campaign.
string
required
Campaign ID that will own the new ad groups.
string
required
Manager customer ID through which the connected user operates the advertiser account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_CREATE_SEARCH_CAMPAIGNSCreate up to 100 Search campaigns with unshared budgets in a Microsoft Advertising account. Campaigns default to Paused. HTTP success can include failed items, represented by null campaign_ids and indexed partial_errors.

Input Parameters

array
required
Search campaigns to create, up to 100. Every item uses CampaignType Search and an unshared campaign-level budget.
string
required
Advertiser account ID where the campaigns will be created; sent as both the CustomerAccountId header and AccountId body field.
string
required
Manager customer ID through which the connected user operates the advertiser account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_DELETE_AD_GROUPSPermanently delete 1 to 1,000 ad groups from a Microsoft Advertising campaign. This destructive operation cannot be undone. A successful HTTP response can still contain item-level failures in partial_errors.

Input Parameters

string
required
Advertiser account ID containing the parent campaign.
string
required
Campaign ID containing the ad groups to permanently delete.
string
required
Manager customer ID through which the connected user operates the advertiser account.
array
required
Ad-group IDs to permanently delete, from 1 to 1,000 IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_DELETE_CAMPAIGNSPermanently delete 1 to 100 campaigns from a Microsoft Advertising account. This destructive operation cannot be undone. A successful HTTP response can still contain item-level failures, which are preserved in partial_errors.

Input Parameters

string
required
Advertiser account ID containing the campaigns; sent both as the CustomerAccountId header and AccountId body field.
string
required
Manager customer ID through which the connected user operates the advertiser account.
array
required
Campaign IDs to permanently delete, from 1 to 100 IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_GENERATE_ACCOUNT_PERFORMANCE_REPORTSubmit an account-performance report without polling, or check an existing report_request_id once. A submission returns Pending promptly; wait 2 to 15 minutes before checking that ID again until Success. Does not download the ZIP.

Input Parameters

string ("Csv" | "Tsv" | "Xml")
Report data format inside Microsoft’s ZIP download.
array
AccountPerformanceReportColumn values in desired output order.
string
required
Advertiser account ID to report on; sent as CustomerAccountId.
string ("Summary" | "Hourly" | "Daily" | "Weekly" | "Monthly" | "Yearly" | "HourOfDay" | "DayOfWeek" | "WeeklyStartingMonday")
How to aggregate report rows. Include TimePeriod in columns for non-Summary aggregation to take effect.
string
required
Manager customer ID through which the connected user operates the account.
string
Optional name included in the report header.
object
Inclusive custom end date; requires custom_start_date.
string ("Today" | "Yesterday" | "LastSevenDays" | "ThisWeek" | "LastWeek" | "Last14Days" | "Last30Days" | "LastFourWeeks" | "ThisMonth" | "LastMonth" | "LastThreeMonths" | "LastSixMonths" | "ThisYear" | "LastYear" | "ThisWeekStartingMonday" | "LastWeekStartingMonday" | "LastFourWeeksStartingMonday")
Microsoft predefined report period, such as Yesterday, LastSevenDays, ThisMonth, or LastMonth. Custom dates replace this value.
string ("Nukualofa" | "FijiKamchatkaMarshallIsland" | "AucklandWellington" | "MagadanSolomonIslandNewCaledonia" | "Vladivostok" | "Hobart" | "GuamPortMoresby" | "CanberraMelbourneSydney" | "Brisbane" | "Darwin" | "Adelaide" | "Yakutsk" | "Seoul" | "OsakaSapporoTokyo" | "Taipei" | "Perth" | "KualaLumpurSingapore" | "IrkutskUlaanBataar" | "BeijingChongqingHongKongUrumqi" | "Krasnoyarsk" | "BangkokHanoiJakarta" | "Rangoon" | "SriJayawardenepura" | "AstanaDhaka" | "AlmatyNovosibirsk" | "Kathmandu" | "ChennaiKolkataMumbaiNewDelhi" | "IslandamabadKarachiTashkent" | "Ekaterinburg" | "Kabul" | "BakuTbilisiYerevan" | "AbuDhabiMuscat" | "Tehran" | "Nairobi" | "MoscowStPetersburgVolgograd" | "KuwaitRiyadh" | "Baghdad" | "Jerusalem" | "HelsinkiKyivRigaSofiaTallinnVilnius" | "HararePretoria" | "Cairo" | "Bucharest" | "AthensIslandanbulMinsk" | "WestCentralAfrica" | "SarajevoSkopjeWarsawZagreb" | "BrusselsCopenhagenMadridParis" | "BelgradeBratislavaBudapestLjubljanaPrague" | "AmsterdamBerlinBernRomeStockholmVienna" | "CasablancaMonrovia" | "GreenwichMeanTimeDublinEdinburghLisbonLondon" | "Azores" | "CapeVerdeIsland" | "MidAtlantic" | "Brasilia" | "BuenosAiresGeorgetown" | "Greenland" | "Newfoundland" | "AtlanticTimeCanada" | "CaracasLaPaz" | "Santiago" | "BogotaLimaQuito" | "EasternTimeUSCanada" | "IndianaEast" | "CentralAmerica" | "CentralTimeUSCanada" | "GuadalajaraMexicoCityMonterrey" | "Saskatchewan" | "Arizona" | "ChihuahuaLaPazMazatlan" | "MountainTimeUSCanada" | "PacificTimeUSCanadaTijuana" | "Alaska" | "Hawaii" | "MidwayIslandandSamoa" | "InternationalDateLineWest")
Microsoft Reporting time-zone value used to interpret the period.
object
Inclusive custom start date; requires custom_end_date.
string
Existing Microsoft report request ID to check. When supplied, the action skips submission and checks this request once.
boolean
Require fully processed data; do not enable for a period including today.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_GET_CURRENT_USERReturn the connected Microsoft Advertising user and their customer/account roles; optionally look up another accessible user by ID.

Input Parameters

string
Microsoft Advertising user ID to retrieve; omit to return the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_LIST_ACCOUNTSReturn advertiser accounts accessible under a customer, including lifecycle and pause state needed before campaign work.

Input Parameters

string
Customer ID whose advertiser accounts to list; omit to let Microsoft infer the customer from the connected user.
boolean
When true, exclude linked advertiser accounts owned by other customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_LIST_AD_GROUPSReturn ad groups in a Microsoft Advertising campaign. Omit ad_group_ids to use the campaign-wide route, or supply up to 1,000 IDs to use Microsoft’s ID-filtered route. ID-filtered responses preserve nullable ad-group slots and partial_errors instead of treating HTTP 200 as complete success.

Input Parameters

string
required
Advertiser account ID containing the campaign.
string
required
Campaign ID containing the ad groups.
string
required
Manager customer ID through which the connected user operates the advertiser account.
array
Ad-group IDs to retrieve, up to 1,000. Omit to list all ad groups in the campaign. ID-filtered results retain null slots for IDs Microsoft could not resolve; inspect partial_errors for item-level failures.
array
AdGroupAdditionalField values for properties that Microsoft does not return by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_LIST_CAMPAIGNSReturn campaigns in a Microsoft Advertising account. Omit campaign_ids to use the account-wide route, or supply up to 100 IDs to use Microsoft’s ID-filtered route. ID-filtered responses preserve nullable campaign slots and matching partial_errors instead of treating HTTP 200 as complete success.

Input Parameters

string
required
Advertiser account ID containing the campaigns; sent both as the CustomerAccountId header and AccountId body field.
string
required
Manager customer ID through which the connected user operates the advertiser account.
array
Campaign IDs to retrieve, up to 100. Omit to list campaigns in the account instead. Results retain null slots for IDs Microsoft could not resolve; inspect partial_errors at the matching indexes.
array
Campaign types to include, such as Search, Shopping, Audience, Hotel, or PerformanceMax. Omit for Microsoft’s Search default.
array
CampaignAdditionalField values for newer properties that Microsoft does not return by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_LIST_CUSTOMERSReturn Microsoft Advertising customers accessible to the connected user, optionally filtered by a case-insensitive name prefix.

Input Parameters

integer
Positive maximum number of customers to return. This bounds one complete response and is not pagination.
string
Optional customer-name prefix; matching is case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_UPDATE_AD_GROUPSPartially update up to 1,000 ad groups in a Microsoft Advertising campaign. Only supplied fields are sent, so omitted settings remain unchanged. This action is financially consequential: increasing a CPC bid or expanding network reach can increase spend on an active ad group. Inspect partial_errors because Microsoft can accept the request while rejecting individual ad-group patches.

Input Parameters

array
required
Ad-group patches. Each item requires an ID and at least one mutable field; omitted fields remain unchanged.
string
required
Advertiser account ID containing the parent campaign.
string
required
Campaign ID containing the ad groups to update.
string
required
Manager customer ID through which the connected user operates the advertiser account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_ADVERTISING_UPDATE_CAMPAIGNSPartially update up to 100 campaigns in a Microsoft Advertising account. Only supplied fields are sent, so omitted settings remain unchanged. This action is financially consequential: increasing a budget can increase spend on an active campaign. It can pause campaigns but cannot activate them; use ACTIVATE_CAMPAIGNS for activation. Inspect partial_errors because Microsoft can accept the request while rejecting individual campaign patches.

Input Parameters

array
required
Campaign patches. Each item requires an ID and at least one mutable field; omitted fields remain unchanged.
string
required
Advertiser account ID containing the campaigns; sent both as the CustomerAccountId header and AccountId body field.
string
required
Manager customer ID through which the connected user operates the advertiser account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not