Articles in this section

Available Microsoft Advertising APIs

When you configure an export, import, or other type of flow step using the prebuilt Microsoft Advertising connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Microsoft Advertising API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint

Export

Import

Ad insight Apply recommendations

 

X

Get auction insight data

X

 

Get audience breakdown

X

 

Get audience full estimation

X

 

Get auto apply opt-in status

X

 

Get bid landscape by ad group IDs

X

 

Get bid landscape by campaign IDs

X

 

Get bid landscape by keyword IDs

X

 

Get bid opportunities

X

 

Get budget opportunities

X

 

Dismiss recommendations

 

X

Get domain categories

X

 

Get estimated bid by keyword IDs

X

 

Get estimated bid by keywords

X

 

Get estimated position by keyword IDs

X

 

Get estimated position by keywords

X

 

Get historical keyword performance

X

 

Get historical search count

X

 

Get keyword categories

X

 

Get keyword demographics

X

 

Get keyword ideas

X

 

Get keyword idea categories

X

 

Get keyword locations

X

 

Get keyword opportunities

X

 

Get keyword traffic estimates

X

 

Get performance insights detail data by account ID

X

 

Put metric data

 

X

Get recommendations

X

 

Retrieve recommendations

X

 

Set auto-apply opt-in status

 

X

Suggest keywords for URL

X

 

Suggest keywords from existing keywords

X

 

Tag recommendations

 

X

Get text asset suggestions by final URL

X

 

Bulk Get bulk download status

X

 

Get bulk upload status

X

 

Get bulk upload URL

X

 

Download campaigns by account IDs

X

 

Download campaigns by campaign IDs

X

 

Campaign management Get account migration statuses

X

 

Get account properties

X

 

Get ad extension IDs by account ID

X

 

Get ad extensions by IDs

X

 

Get ad extensions associations

X

 

Get ad extensions editorial reasons

X

 

Get ad group criterions by IDs

X

 

Get ad groups by campaign ID

X

 

Get ad groups by IDs

X

 

Add ad extensions

 

X

Add ad group criterions

 

X

Add ad groups

 

X

Add ads

 

X

Add asset groups

 

X

Add audience groups

 

X

Add audiences

 

X

Add bid strategies

 

X

Add brand kits

 

X

Add budgets

 

X

Add campaign conversion goals

 

X

Add campaign criterions

 

X

Add campaigns

 

X

Add conversion goals

 

X

Add conversion value rules

 

X

Add data exclusions

 

X

Add experiments

 

X

Add HTML5s

 

X

Add import jobs

 

X

Add keywords

 

X

Add labels

 

X

Add linked in segments

 

X

Add list items to shared list

 

X

Add media

 

X

Add negative keywords to entities

 

X

Add new customer acquisition goals

 

X

Add seasonality adjustments

 

X

Add shared entity

 

X

Add uet tags

 

X

Add videos

 

X

Get ads by ad group ID

X

 

Get ads by editorial status

X

 

Get ads by IDs

X

 

Get annotation opt out

X

 

Appeal editorial rejections

 

X

Apply asset group listing group actions

 

X

Apply customer list items

 

X

Apply customer list user data

 

X

Apply hotel group actions

 

X

Apply offline conversion adjustments

 

X

Apply offline conversions

 

X

Apply online conversion adjustments

 

X

Apply product partition actions

 

X

Get asset group listing groups by IDs

X

 

Get asset groups by campaign ID

X

 

Get asset groups by IDs

X

 

Get asset groups editorial reasons

X

 

Get audience group asset group associations by asset group IDs

X

 

Get audience group asset group associations by audience group IDs

X

 

Get audience groups by IDs

X

 

Get audiences by IDs

X

 

Get BMC stores by customer ID

X

 

Get b s c countries

X

 

Get bid strategies by IDs

X

 

Get brand kits by account ID

X

 

Get brand kits by IDs

X

 

Get budgets by IDs

X

 

Get campaign criterions by IDs

X

 

Get campaign IDs by bid strategy IDs

X

 

Get campaign IDs by budget IDs

X

 

Get campaign sizes by account ID

X

 

Get campaigns by account ID

X

 

Get campaigns by IDs

X

 

Get clipchamp templates

X

 

Search companies

X

 

Get config value

X

 

Get conversion goals by IDs

X

 

Get conversion goals by tag IDs

X

 

Get conversion value rules by account ID

X

 

Get conversion value rules by IDs

X

 

Create asset group recommendation

 

X

Create brand kit recommendation

 

X

Create responsive ad recommendation

 

X

Create responsive search ad recommendation

 

X

Get data exclusions by account ID

X

 

Get data exclusions by IDs

X

 

Delete ad extensions

 

X

Delete ad extensions associations

 

X

Delete ad group criterions

 

X

Delete ad groups

 

X

Delete ads

 

X

Delete asset groups

 

X

Delete audience group asset group associations

 

X

Delete audience groups

 

X

Delete audiences

 

X

Delete bid strategies

 

X

Delete brand kits

 

X

Delete budgets

 

X

Delete campaign conversion goals

 

X

Delete campaign criterions

 

X

Delete campaigns

 

X

Delete data exclusions

 

X

Delete experiments

 

X

Delete HTML5s

 

X

Delete import jobs

 

X

Delete keywords

 

X

Delete label associations

 

X

Delete labels

 

X

Delete linked in segments

 

X

Delete list items from shared list

 

X

Delete media

 

X

Delete negative keywords from entities

 

X

Delete seasonality adjustments

 

X

Delete shared entities

 

X

Delete shared entity associations

 

X

Delete videos

 

X

Get diagnostics

X

 

Get editorial reasons by IDs

X

 

Get experiments by IDs

X

 

Get file import upload URL

X

 

Get geo locations file URL

X

 

Get HTML5s by IDs

X

 

Get health check

X

 

Get import entity IDs mapping

X

 

Get import jobs by IDs

X

 

Get import results

X

 

Get keywords by ad group ID

X

 

Get keywords by editorial status

X

 

Get keywords by IDs

X

 

Get label associations by entity IDs

X

 

Get label associations by label IDs

X

 

Get labels by IDs

X

 

Get list items by shared list

X

 

Get media associations

X

 

Get media metadata by account ID

X

 

Get media metadata by IDs

X

 

Get negative keywords by entity IDs

X

 

Get negative sites by ad group IDs

X

 

Get negative sites by campaign IDs

X

 

Get new customer acquisition goals by account ID

X

 

Get offline conversion report by goal IDs

X

 

Get offline conversion reports

X

 

Get profile data file URL

X

 

Refine asset group recommendation

 

X

Refine responsive ad recommendation

 

X

Refine responsive search ad recommendation

 

X

Get responsive ad recommendation job

X

 

Get seasonality adjustments by account ID

X

 

Get seasonality adjustments by IDs

X

 

Set account properties

 

X

Set ad extensions associations

 

X

Set audience group asset group associations

 

X

Set label associations

 

X

Set negative sites to ad groups

 

X

Set negative sites to campaigns

 

X

Set shared entity associations

 

X

Get shared entities

X

 

Get shared entities by account ID

X

 

Get shared entity associations by entity IDs

X

 

Get shared entity associations by shared entity IDs

X

 

Get supported Clipchamp audio

X

 

Get supported fonts

X

 

Get uet tag auth key

X

 

Get uet tags by IDs

X

 

Update ad extensions

 

X

Update ad group criterions

 

X

Update ad groups

 

X

Update ads

 

X

Update annotation opt out

 

X

Update asset groups

 

X

Update audience groups

 

X

Update audiences

 

X

Update bid strategies

 

X

Update brand kits

 

X

Update budgets

 

X

Update campaign criterions

 

X

Update campaigns

 

X

Update conversion goals

 

X

Update conversion value rules

 

X

Update conversion value rules status

 

X

Update data exclusions

 

X

Update experiments

 

X

Update import jobs

 

X

Update keywords

 

X

Update labels

 

X

Update linked in segments

 

X

Update new customer acquisition goals

 

X

Update seasonality adjustments

 

X

Update shared entities

 

X

Update uet tags

 

X

Update videos

 

X

Get videos by IDs

X

 

Customer billing Get account monthly spend

X

 

Add insertion order

 

X

Get billing documents

X

 

Get billing documents info

X

 

Get billing groups

X

 

Check feature adoption coupon eligibility

X

 

Claim feature adoption coupons

 

X

Get coupon info

X

 

Search coupons

X

 

Dispatch coupons

 

X

Search insertion orders

X

 

Redeem coupon

 

X

Get ungrouped accounts

X

 

Update billing group accounts

 

X

Update insertion order

 

X

Customer management Get accessible customer

X

 

Get account

X

 

Search accounts

X

 

Get accounts info

X

 

Add account

 

X

Add client links

 

X

Add prepay account

 

X

Search client links

X

 

Get current user

X

 

Get customer

X

 

Search customers

X

 

Get customers info

X

 

Delete account

 

X

Delete customer

 

X

Delete user

 

X

Dismiss notifications

 

X

Find accounts

X

 

Find accounts or customers info

X

 

Get linked accounts and customers info

X

 

Get notifications

X

 

Send user invitation

 

X

Signup customer

 

X

Update account

 

X

Update client links

 

X

Update customer

 

X

Update prepay account

 

X

Update user

 

X

Update user roles

 

X

Upgrade customer to agency

 

X

Get user

X

 

Search user invitations

X

 

Get user MFA status

X

 

Get users info

X

 

Validate address

X

 

Reporting Get the status of a report request

X

 

Submit generate report

 

X