Microsoft Advertising

App · 12 actions

Read Microsoft Advertising campaigns, ad groups, ads, keywords, budgets, labels, conversion goals and audiences.

Actions

ActionWhat it does
Get ad groupsGet ad groups in Microsoft Advertising.
Get adsGet ads in Microsoft Advertising.
Get campaignsGet campaigns in Microsoft Advertising.
Get keywordsGet keywords in Microsoft Advertising.
List ad groupsList ad groups in Microsoft Advertising.
List adsList ads in Microsoft Advertising.
List audiencesList audiences in Microsoft Advertising.
List budgetsList budgets in Microsoft Advertising.
List campaignsList campaigns in Microsoft Advertising.
List conversion goalsList conversion goals in Microsoft Advertising.
List keywordsList keywords in Microsoft Advertising.
List labelsList labels in Microsoft Advertising.

Get ad groups

Get ad groups in Microsoft Advertising.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Record IDsrecord_idslistRequired
Record ids.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "AdGroups": []
  },
  "has_more": false,
  "next_cursor": null
}

Get ads

Get ads in Microsoft Advertising.

Inputs

Campaigncampaign_idtext
Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
Ad groupad_group_idtextRequired
Ad group id.
Record IDsrecord_idslistRequired
Record ids.
Ad typesad_typeslistRequired
Ad types.One or more of: Text, ExpandedText, ResponsiveSearch, ResponsiveAd, DynamicSearch, Product.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Ads": []
  },
  "has_more": false,
  "next_cursor": null
}

Get campaigns

Get campaigns in Microsoft Advertising.

Inputs

Accountaccount_idtext
The ad account. Leave empty to use the connection's account.
Record IDsrecord_idslistRequired
Record ids.
Campaign typecampaign_typetext
Campaign type. Defaults to Search.One of: Search, Shopping, DynamicSearchAds, Audience, Hotel, PerformanceMax.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Campaigns": []
  },
  "has_more": false,
  "next_cursor": null
}

Get keywords

Get keywords in Microsoft Advertising.

Inputs

Campaigncampaign_idtext
Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
Ad groupad_group_idtextRequired
Ad group id.
Record IDsrecord_idslistRequired
Record ids.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Keywords": []
  },
  "has_more": false,
  "next_cursor": null
}

List ad groups

List ad groups in Microsoft Advertising.

Inputs

Campaigncampaign_idtextRequired
Campaign id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "AdGroups": []
  },
  "has_more": false,
  "next_cursor": null
}

List ads

List ads in Microsoft Advertising.

Inputs

Campaigncampaign_idtext
Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
Ad groupad_group_idtextRequired
Ad group id.
Ad typesad_typeslist
Ad types. Defaults to ResponsiveSearch.One or more of: Text, ExpandedText, ResponsiveSearch, ResponsiveAd, DynamicSearch, Product.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Ads": []
  },
  "has_more": false,
  "next_cursor": null
}

List audiences

List audiences in Microsoft Advertising.

Inputs

Audience typeaudience_typetextRequired
Audience type.One of: RemarketingList, Custom, InMarket, SimilarRemarketingList, CombinedList, CustomerList.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Audiences": []
  },
  "has_more": false,
  "next_cursor": null
}

List budgets

List budgets in Microsoft Advertising.

Inputs

None.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Budgets": []
  },
  "has_more": false,
  "next_cursor": null
}

List campaigns

List campaigns in Microsoft Advertising.

Inputs

Accountaccount_idtext
The ad account. Leave empty to use the connection's account.
Campaign typecampaign_typetext
Campaign type. Defaults to Search.One of: Search, Shopping, DynamicSearchAds, Audience, Hotel, PerformanceMax.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Campaigns": []
  },
  "has_more": false,
  "next_cursor": null
}

List conversion goals

List conversion goals in Microsoft Advertising.

Inputs

Goal typesgoal_typestextRequired
Goal types.One of: Url, Duration, PagesViewedPerVisit, Event, OfflineConversion, InStoreTransaction, AppInstall.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "ConversionGoals": []
  },
  "has_more": false,
  "next_cursor": null
}

List keywords

List keywords in Microsoft Advertising.

Inputs

Campaigncampaign_idtext
Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
Ad groupad_group_idtextRequired
Ad group id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Keywords": []
  },
  "has_more": false,
  "next_cursor": null
}

List labels

List labels in Microsoft Advertising.

Inputs

Page indexpage_indexnumber
Page index.At least 0.
Page sizepage_sizenumber
Page size.At least 1.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "Labels": []
  },
  "has_more": false,
  "next_cursor": null
}

On this page