# Amazon Ads

> Read Sponsored Products campaign structure, budgets, portfolios and targeting; run Amazon advertising reports.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/amazon-ads

## Actions

### Create report

Start an asynchronous Sponsored Products report. Returns its report ID; use Get report to check readiness without starting a second report.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Name (`name`, text): Name.
- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Report type (`report_type`, text, required): Report type. One of: `spCampaigns`, `spTargeting`, `spSearchTerm`, `spAdvertisedProduct`, `spPurchasedProduct`.
- Group by (`group_by`, list, required): Group by. One or more of: `campaign`, `adGroup`, `targeting`, `searchTerm`, `advertiser`.
- Columns (`columns`, list, required): Columns.
- Time unit (`time_unit`, text, required): Time unit. One of: `DAILY`, `SUMMARY`.

**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": {
    "id": "Example",
    "reportId": "Example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Delete report

Delete report in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Report ID (`report_id`, text, required): Report 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": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get budget rule

Get budget rule in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Budget rule ID (`budget_rule_id`, text, required): Budget rule id.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "budgetRule": {
      "createdDate": 0,
      "lastUpdatedDate": 0,
      "ruleDetails": {
        "budgetIncreaseBy": {},
        "duration": {},
        "name": {},
        "performanceMeasureCondition": {},
        "recurrence": {},
        "ruleType": {}
      },
      "ruleId": "Example",
      "ruleState": "ACTIVE",
      "ruleStatus": "Example"
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get category refinements

Get category refinements in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Category ID (`category_id`, text, required): Category id.

**Outputs**: Response.

- `data` (object): Response object for the GetRefinementsForCategory API, containing information on Brand Nodes, Age Range Nodes, and Genre Nodes.
- `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": {
    "ageRanges": [],
    "brands": [],
    "genres": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get profile

Get profile in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile 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": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get report

Get report in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Report ID (`report_id`, text, required): Report 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": {},
  "has_more": false,
  "next_cursor": null
}
```

### List ad groups

List ad groups in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": [],
    "nextToken": "Example",
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List budget rules

List budget rules in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Page size (`page_size`, number): Number of rules per page, up to 30. From 1 to 30.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "budgetRulesForAdvertiserResponse": [],
    "nextToken": "Example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List campaign budget rules

List campaign budget rules in Amazon Ads.

**Inputs**

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

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "associatedRules": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List campaign negative keywords

List campaign negative keywords in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "campaignNegativeKeywords": [],
    "nextToken": "Example",
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List campaign negative targets

List campaign negative targets in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "campaignNegativeTargetingClauses": [],
    "nextToken": "Example",
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List campaigns

List campaigns in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": [],
    "nextToken": "Example",
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List keywords

List keywords in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": [],
    "nextToken": "Example",
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List negative keywords

List negative keywords in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "negativeKeywords": [],
    "nextToken": "Example",
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List negative targets

List negative targets in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "negativeTargetingClauses": [],
    "nextToken": "Example",
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List portfolios

List portfolios in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.

**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": {
    "portfolios": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List product ads

List product ads in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "nextToken": "Example",
    "productAds": [],
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List profiles

List profiles in Amazon Ads.

**Inputs**: None.

**Outputs**: Response.

- `data` (list): The records returned by the official API.
- `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": [],
  "has_more": false,
  "next_cursor": null
}
```

### List target categories

List target categories in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Locale (`locale`, text): Language and country code, such as en_US.

**Outputs**: Response.

- `data` (object): Response object containing all targetable categories for the advertiser's marketplace. ID is the category ID. NA is the name. CH is the list of child categories. TA is if the category is targetable. AsinCountRange is the AsinCounts of the node. Version 4 adds the number of targetable ASINs to each category.
- `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": {
    "categoryTree": "Example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List targets

List targets in Amazon Ads.

**Inputs**

- Profile (`profile_id`, text, required): Profile id.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. At least 1.

**Outputs**: Response.

- `data` (object): data.
- `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": {
    "nextToken": "Example",
    "targetingClauses": [],
    "totalResults": 0
  },
  "has_more": false,
  "next_cursor": null
}
```
