Apple Search Ads

App · 15 actions

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

Actions

ActionWhat it does
Get ad groupGet ad group in Apple Search Ads.
Get ad group reportGet ad group report in Apple Search Ads.
Get ad reportGet ad report in Apple Search Ads.
Get budget orderGet budget order in Apple Search Ads.
Get campaignGet campaign in Apple Search Ads.
Get campaign reportGet campaign report in Apple Search Ads.
Get keyword reportGet keyword report in Apple Search Ads.
Get search term reportGet search term report in Apple Search Ads.
Get user aclGet user acl in Apple Search Ads.
List ad group negative keywordsList ad group negative keywords in Apple Search Ads.
List ad groupsList ad groups in Apple Search Ads.
List budget ordersList budget orders in Apple Search Ads.
List campaign negative keywordsList campaign negative keywords in Apple Search Ads.
List campaignsList campaigns in Apple Search Ads.
List targeting keywordsList targeting keywords in Apple Search Ads.

Get ad group

Get ad group in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
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": {},
  "has_more": false,
  "next_cursor": null
}

Get ad group report

Get ad group report in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Granularitygranularitytext
Granularity.One of: HOURLY, DAILY, WEEKLY, MONTHLY.
Time zonetime_zonetext
Time zone.One of: ORTZ, UTC.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get ad report

Get ad report in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Granularitygranularitytext
Granularity.One of: HOURLY, DAILY, WEEKLY, MONTHLY.
Time zonetime_zonetext
Time zone.One of: ORTZ, UTC.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get budget order

Get budget order in Apple Search Ads.

Inputs

Budget orderbudget_order_idtextRequired
Budget order id.

Outputs

Response.

dataobject
Budget order response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "data": {
      "bo": {
        "id": 0,
        "name": "Example"
      },
      "orgIds": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get campaign

Get campaign in Apple Search Ads.

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

Get campaign report

Get campaign report in Apple Search Ads.

Inputs

Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Granularitygranularitytext
Granularity.One of: HOURLY, DAILY, WEEKLY, MONTHLY.
Time zonetime_zonetext
Time zone.One of: ORTZ, UTC.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get keyword report

Get keyword report in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Granularitygranularitytext
Granularity.One of: HOURLY, DAILY, WEEKLY, MONTHLY.
Time zonetime_zonetext
Time zone.One of: ORTZ, UTC.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get search term report

Get search term report in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Granularitygranularitytext
Granularity.One of: HOURLY, DAILY, WEEKLY, MONTHLY.
Time zonetime_zonetext
Time zone.One of: ORTZ, UTC.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": {
      "reportingDataResponse": {
        "row": []
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get user acl

Get user acl in Apple Search Ads.

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

List ad group negative keywords

List ad group negative keywords in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Ad groupad_group_idtextRequired
Ad group id.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List ad groups

List ad groups in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List budget orders

List budget orders in Apple Search Ads.

Inputs

Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List campaign negative keywords

List campaign negative keywords in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List campaigns

List campaigns in Apple Search Ads.

Inputs

Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List targeting keywords

List targeting keywords in Apple Search Ads.

Inputs

Campaigncampaign_idtextRequired
Campaign id.
Ad groupad_group_idtextRequired
Ad group id.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.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": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

On this page