# Apple Search Ads

> Read Apple advertising campaigns, ad groups, keywords and budgets, and run performance reports.

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/apple-search-ads

## Actions

### Get ad group

Get ad group in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- 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": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get ad group report

Get ad group report in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Granularity (`granularity`, text): Granularity. One of: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`.
- Time zone (`time_zone`, text): Time zone. One of: `ORTZ`, `UTC`.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get ad report

Get ad report in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Granularity (`granularity`, text): Granularity. One of: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`.
- Time zone (`time_zone`, text): Time zone. One of: `ORTZ`, `UTC`.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get budget order

Get budget order in Apple Search Ads.

**Inputs**

- Budget order (`budget_order_id`, text, required): Budget order id.

**Outputs**: Response.

- `data` (object): Budget order response.
- `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": {
    "data": {
      "bo": {
        "id": 0,
        "name": "Example"
      },
      "orgIds": []
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get campaign

Get campaign in Apple Search Ads.

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

### Get campaign report

Get campaign report in Apple Search Ads.

**Inputs**

- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Granularity (`granularity`, text): Granularity. One of: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`.
- Time zone (`time_zone`, text): Time zone. One of: `ORTZ`, `UTC`.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get keyword report

Get keyword report in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Granularity (`granularity`, text): Granularity. One of: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`.
- Time zone (`time_zone`, text): Time zone. One of: `ORTZ`, `UTC`.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get search term report

Get search term report in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Granularity (`granularity`, text): Granularity. One of: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`.
- Time zone (`time_zone`, text): Time zone. One of: `ORTZ`, `UTC`.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get user acl

Get user acl in Apple Search Ads.

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

### List ad group negative keywords

List ad group negative keywords in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Ad group (`ad_group_id`, text, required): Ad group id.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List ad groups

List ad groups in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List budget orders

List budget orders in Apple Search Ads.

**Inputs**

- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List campaign negative keywords

List campaign negative keywords in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List campaigns

List campaigns in Apple Search Ads.

**Inputs**

- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List targeting keywords

List targeting keywords in Apple Search Ads.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.
- Ad group (`ad_group_id`, text, required): Ad group id.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. 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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```
