# Microsoft Advertising

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

App · 12 actions. Web page: https://docs.lodol.com/docs/integrations/microsoft-advertising

## Actions

### Get ad groups

Get ad groups in Microsoft Advertising.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Record IDs (`record_ids`, list, required): Record ids.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "AdGroups": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get ads

Get ads in Microsoft Advertising.

**Inputs**

- Campaign (`campaign_id`, text): Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
- Ad group (`ad_group_id`, text, required): Ad group id.
- Record IDs (`record_ids`, list, required): Record ids.
- Ad types (`ad_types`, list, required): Ad types. One or more of: `Text`, `ExpandedText`, `ResponsiveSearch`, `ResponsiveAd`, `DynamicSearch`, `Product`.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Ads": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get campaigns

Get campaigns in Microsoft Advertising.

**Inputs**

- Account (`account_id`, text): The ad account. Leave empty to use the connection's account.
- Record IDs (`record_ids`, list, required): Record ids.
- Campaign type (`campaign_type`, text): Campaign type. Defaults to Search. One of: `Search`, `Shopping`, `DynamicSearchAds`, `Audience`, `Hotel`, `PerformanceMax`.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Campaigns": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get keywords

Get keywords in Microsoft Advertising.

**Inputs**

- Campaign (`campaign_id`, text): Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
- Ad group (`ad_group_id`, text, required): Ad group id.
- Record IDs (`record_ids`, list, required): Record ids.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Keywords": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List ad groups

List ad groups in Microsoft Advertising.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "AdGroups": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List ads

List ads in Microsoft Advertising.

**Inputs**

- Campaign (`campaign_id`, text): Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
- Ad group (`ad_group_id`, text, required): Ad group id.
- Ad types (`ad_types`, list): Ad types. Defaults to ResponsiveSearch. One or more of: `Text`, `ExpandedText`, `ResponsiveSearch`, `ResponsiveAd`, `DynamicSearch`, `Product`.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Ads": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List audiences

List audiences in Microsoft Advertising.

**Inputs**

- Audience type (`audience_type`, text, required): Audience type. One of: `RemarketingList`, `Custom`, `InMarket`, `SimilarRemarketingList`, `CombinedList`, `CustomerList`.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Audiences": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List budgets

List budgets in Microsoft Advertising.

**Inputs**: None.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Budgets": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List campaigns

List campaigns in Microsoft Advertising.

**Inputs**

- Account (`account_id`, text): The ad account. Leave empty to use the connection's account.
- Campaign type (`campaign_type`, text): Campaign type. Defaults to Search. One of: `Search`, `Shopping`, `DynamicSearchAds`, `Audience`, `Hotel`, `PerformanceMax`.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Campaigns": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List conversion goals

List conversion goals in Microsoft Advertising.

**Inputs**

- Goal types (`goal_types`, text, required): Goal types. One of: `Url`, `Duration`, `PagesViewedPerVisit`, `Event`, `OfflineConversion`, `InStoreTransaction`, `AppInstall`.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "ConversionGoals": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List keywords

List keywords in Microsoft Advertising.

**Inputs**

- Campaign (`campaign_id`, text): Choose a campaign to select an ad group. Leave empty when supplying an ad group ID from an earlier step.
- Ad group (`ad_group_id`, text, required): Ad group id.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Keywords": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List labels

List labels in Microsoft Advertising.

**Inputs**

- Page index (`page_index`, number): Page index. At least 0.
- Page size (`page_size`, number): Page size. At least 1.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "Labels": []
  },
  "has_more": false,
  "next_cursor": null
}
```
