Apple Search Ads
App · 15 actions
Read Apple advertising campaigns, ad groups, keywords and budgets, and run performance reports.
Actions
| Action | What it does |
|---|---|
| Get ad group | Get ad group in Apple Search Ads. |
| Get ad group report | Get ad group report in Apple Search Ads. |
| Get ad report | Get ad report in Apple Search Ads. |
| Get budget order | Get budget order in Apple Search Ads. |
| Get campaign | Get campaign in Apple Search Ads. |
| Get campaign report | Get campaign report in Apple Search Ads. |
| Get keyword report | Get keyword report in Apple Search Ads. |
| Get search term report | Get search term report in Apple Search Ads. |
| Get user acl | Get user acl in Apple Search Ads. |
| List ad group negative keywords | List ad group negative keywords in Apple Search Ads. |
| List ad groups | List ad groups in Apple Search Ads. |
| List budget orders | List budget orders in Apple Search Ads. |
| List campaign negative keywords | List campaign negative keywords in Apple Search Ads. |
| List campaigns | List campaigns in Apple Search Ads. |
| List targeting keywords | List targeting keywords in Apple Search Ads. |
Get ad group
Get ad group in Apple Search Ads.
Inputs
- Campaign
campaign_idtextRequired - Campaign id.
- Ad group
ad_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
- Campaign
campaign_idtextRequired - Campaign id.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Granularity
granularitytext - Granularity.One of:
HOURLY,DAILY,WEEKLY,MONTHLY. - Time zone
time_zonetext - Time zone.One of:
ORTZ,UTC. - Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Campaign
campaign_idtextRequired - Campaign id.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Granularity
granularitytext - Granularity.One of:
HOURLY,DAILY,WEEKLY,MONTHLY. - Time zone
time_zonetext - Time zone.One of:
ORTZ,UTC. - Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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 order
budget_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
- Campaign
campaign_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 date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Granularity
granularitytext - Granularity.One of:
HOURLY,DAILY,WEEKLY,MONTHLY. - Time zone
time_zonetext - Time zone.One of:
ORTZ,UTC. - Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Campaign
campaign_idtextRequired - Campaign id.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Granularity
granularitytext - Granularity.One of:
HOURLY,DAILY,WEEKLY,MONTHLY. - Time zone
time_zonetext - Time zone.One of:
ORTZ,UTC. - Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Campaign
campaign_idtextRequired - Campaign id.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Granularity
granularitytext - Granularity.One of:
HOURLY,DAILY,WEEKLY,MONTHLY. - Time zone
time_zonetext - Time zone.One of:
ORTZ,UTC. - Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Campaign
campaign_idtextRequired - Campaign id.
- Ad group
ad_group_idtextRequired - Ad group id.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Campaign
campaign_idtextRequired - Campaign id.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Campaign
campaign_idtextRequired - Campaign id.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
- Campaign
campaign_idtextRequired - Campaign id.
- Ad group
ad_group_idtextRequired - Ad group id.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - 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
}