Apple Ads
The 67 tools Pilot MCP serves for Apple Ads: 46 read-only, and 21 that write with the €29 plan, taken from the server.
Pilot MCP serves 46 read-only tools for Apple Ads, on every plan. With the €29 plan, it also serves 14 that create or change and 7 that delete. Their names start with apple_ads_.
What each entry shows
The name, description and parameters come from the list the server serves to your assistant (tools/list). Descriptions are in English: this is the text your assistant receives. Your assistant never fills in platform credentials: Pilot adds them on each call.
Writing and deleting
Write tools are only served with the €29 plan: your assistant creates, changes, pauses and deletes there, with no access level to pick when you connect. On the free plan, it does not see them. A change that sets an object to deleted or archived counts as a deletion, and a deletion targets one object at a time. Changes apply directly on the ad platform: Pilot reads the object from the platform before and after the write, and logs it in your workspace. See Read and write.
Tool families
| Family | Tools |
|---|---|
| Other tools | 46 |
| Create and change (€29) | 14 |
| Delete (€29) | 7 |
Other tools
apple_ads_apple_ads_find_adgroup_negative_keywords
Apple Ads: Find Ad Group Negative Keywords · read-only · idempotent
Searches the negative keywords of an ad group with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_adgroups_in_campaign
Apple Ads: Find Ad Groups in Campaign · read-only · idempotent
Searches the ad groups within a campaign with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_adgroups_org_wide
Apple Ads: Find Ad Groups Org Wide · read-only · idempotent
Searches ad groups across all campaigns of the org with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_ads_in_campaign
Apple Ads: Find Ads in Campaign · read-only · idempotent
Searches the ads within a campaign with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_ads_org_wide
Apple Ads: Find Ads Org Wide · read-only · idempotent
Searches ads across all campaigns of the org with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_app_assets
Apple Ads: Find App Assets · read-only · idempotent
Searches the assets of an app with an Apple selector (POST /apps/{adam_id}/assets/find).
| Parameter | Type | Required | Description |
|---|---|---|---|
adam_id | string | no | |
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_app_eligibilities
Apple Ads: Find App Eligibilities · read-only · idempotent
Locates app eligibility records with an Apple selector (POST /apps/eligibilities/find).
| Parameter | Type | Required | Description |
|---|---|---|---|
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_campaign_negative_keywords
Apple Ads: Find Campaign Negative Keywords · read-only · idempotent
Searches the negative keywords of a campaign with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_campaigns
Apple Ads: Find Campaigns · read-only · idempotent
Searches campaigns with an Apple selector (conditions, orderBy, pagination).
| Parameter | Type | Required | Description |
|---|---|---|---|
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_creatives
Apple Ads: Find Creatives · read-only · idempotent
Searches the creatives of the org with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_product_page_reasons
Apple Ads: Find Product Page Reasons · read-only · idempotent
Searches creative rejection reasons with an Apple selector.
| Parameter | Type | Required | Description |
|---|---|---|---|
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_find_targeting_keywords
Apple Ads: Find Targeting Keywords · read-only · idempotent
Search targeting keywords across an ad group.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
selector | object | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_geo_lookup
Apple Ads: Geo Lookup · read-only · idempotent
Resolve geo entities by ID (POST body = array of ids).
| Parameter | Type | Required | Description |
|---|---|---|---|
ids | string[] | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_ad
Apple Ads: Get Ad · read-only · idempotent
Retrieves an ad of an ad group by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
ad_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_adgroup
Apple Ads: Get Ad Group · read-only · idempotent
Gets an ad group by its ID, within its campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_adgroup_negative_keyword
Apple Ads: Get Ad Group Negative Keyword · read-only · idempotent
Gets one negative keyword of an ad group by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keyword_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_app
Apple Ads: Get App · read-only · idempotent
Fetches the App Store details of an app by its adamId (GET /apps/{adam_id}).
| Parameter | Type | Required | Description |
|---|---|---|---|
adam_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_app_locale_details
Apple Ads: Get App Locale Details · read-only · idempotent
Returns the localized App Store information of an app (GET /apps/{adam_id}/locale-details).
| Parameter | Type | Required | Description |
|---|---|---|---|
adam_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_campaign
Apple Ads: Get Campaign · read-only · idempotent
Retrieves a campaign of the Apple Ads org by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_campaign_negative_keyword
Apple Ads: Get Campaign Negative Keyword · read-only · idempotent
Gets one campaign-level negative keyword by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
keyword_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_cpp
Apple Ads: Get CPP · read-only · idempotent
Gets one Custom Product Page of an app, by adamId and cpp_id.
| Parameter | Type | Required | Description |
|---|---|---|---|
adam_id | string | no | |
cpp_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_cpp_locale_details
Apple Ads: Get CPP Locale Details · read-only · idempotent
Get locale-specific information for a CPP.
| Parameter | Type | Required | Description |
|---|---|---|---|
adam_id | string | no | |
cpp_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_creative
Apple Ads: Get Creative · read-only · idempotent
Retrieves a creative of the Apple Ads org by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
creative_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_custom_report
Apple Ads: Get Custom Report · read-only · idempotent
Polls the status and results of a custom (impression share) report by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
report_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_product_page_reason
Apple Ads: Get Product Page Reason · read-only · idempotent
Retrieves one creative rejection reason by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
reason_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_get_targeting_keyword
Apple Ads: Get Targeting Keyword · read-only · idempotent
Gets one targeting keyword of an ad group by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keyword_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_adgroup_negative_keywords
Apple Ads: List Ad Group Negative Keywords · read-only · idempotent
Lists the negative keywords of an ad group, with limit/offset pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_adgroups
Apple Ads: List Ad Groups · read-only · idempotent
Lists the ad groups of a campaign, with limit/offset pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_ads
Apple Ads: List Ads · read-only · idempotent
Lists the ads in an ad group, with limit/offset pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_campaign_negative_keywords
Apple Ads: List Campaign Negative Keywords · read-only · idempotent
Lists the negative keywords of a campaign, with limit/offset pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_campaigns
Apple Ads: List Campaigns · read-only · idempotent
Lists all campaigns of the Apple Ads org, with limit/offset pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_countries_or_regions
Apple Ads: List Countries or Regions · read-only · idempotent
Lists the countries and regions that Apple Ads supports (GET /countries-or-regions).
| Parameter | Type | Required | Description |
|---|---|---|---|
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_cpp
Apple Ads: List CPP · read-only · idempotent
Lists the Custom Product Pages of an app, by its adamId.
| Parameter | Type | Required | Description |
|---|---|---|---|
adam_id | string | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_creative_app_preview_devices
Apple Ads: List Creative App Preview Devices · read-only · idempotent
Lists the devices supported for creative app previews (GET /creativeappassets/devices).
| Parameter | Type | Required | Description |
|---|---|---|---|
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_creatives
Apple Ads: List Creatives · read-only · idempotent
Lists the creatives of the Apple Ads org, with limit/offset pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_custom_reports
Apple Ads: List Custom Reports · read-only · idempotent
Lists the custom (impression share) reports, with limit/offset pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_list_targeting_keywords
Apple Ads: List Targeting Keywords · read-only · idempotent
List targeting keywords for an ad group.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
limit | number | no | Page size (max 1000, default 20). |
offset | number | no | Pagination offset (default 0). |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_report_adgroups
Apple Ads: Report Ad Groups · read-only · idempotent
Ad-group performance report for a campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
startTime | string | no | Report start date YYYY-MM-DD. |
endTime | string | no | Report end date YYYY-MM-DD. |
granularity | string | no | HOURLY | DAILY | WEEKLY | MONTHLY. |
groupBy | string[] | no | Optional groupBy fields (e.g. countryOrRegion, deviceClass). |
selector | object | no | Apple selector { conditions, orderBy, pagination }. |
returnRowTotals | boolean | no | |
returnGrandTotals | boolean | no | |
returnRecordsWithNoMetrics | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_report_ads_in_campaign
Apple Ads: Report Ads in Campaign · read-only · idempotent
Ad performance report for a campaign, over a date range.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
startTime | string | no | Report start date YYYY-MM-DD. |
endTime | string | no | Report end date YYYY-MM-DD. |
granularity | string | no | HOURLY | DAILY | WEEKLY | MONTHLY. |
groupBy | string[] | no | Optional groupBy fields (e.g. countryOrRegion, deviceClass). |
selector | object | no | Apple selector { conditions, orderBy, pagination }. |
returnRowTotals | boolean | no | |
returnGrandTotals | boolean | no | |
returnRecordsWithNoMetrics | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_report_campaigns
Apple Ads: Report Campaigns · read-only · idempotent
Campaign-level performance report for the org over a date range (startTime, endTime).
| Parameter | Type | Required | Description |
|---|---|---|---|
startTime | string | no | Report start date YYYY-MM-DD. |
endTime | string | no | Report end date YYYY-MM-DD. |
granularity | string | no | HOURLY | DAILY | WEEKLY | MONTHLY. |
groupBy | string[] | no | Optional groupBy fields (e.g. countryOrRegion, deviceClass). |
selector | object | no | Apple selector { conditions, orderBy, pagination }. |
returnRowTotals | boolean | no | |
returnGrandTotals | boolean | no | |
returnRecordsWithNoMetrics | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_report_keywords_in_adgroup
Apple Ads: Report Keywords in Ad Group · read-only · idempotent
Keyword performance report within an ad group, over a date range.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
startTime | string | no | Report start date YYYY-MM-DD. |
endTime | string | no | Report end date YYYY-MM-DD. |
granularity | string | no | HOURLY | DAILY | WEEKLY | MONTHLY. |
groupBy | string[] | no | Optional groupBy fields (e.g. countryOrRegion, deviceClass). |
selector | object | no | Apple selector { conditions, orderBy, pagination }. |
returnRowTotals | boolean | no | |
returnGrandTotals | boolean | no | |
returnRecordsWithNoMetrics | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_report_keywords_in_campaign
Apple Ads: Report Keywords in Campaign · read-only · idempotent
Keyword performance for an entire campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
startTime | string | no | Report start date YYYY-MM-DD. |
endTime | string | no | Report end date YYYY-MM-DD. |
granularity | string | no | HOURLY | DAILY | WEEKLY | MONTHLY. |
groupBy | string[] | no | Optional groupBy fields (e.g. countryOrRegion, deviceClass). |
selector | object | no | Apple selector { conditions, orderBy, pagination }. |
returnRowTotals | boolean | no | |
returnGrandTotals | boolean | no | |
returnRecordsWithNoMetrics | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_report_search_terms_in_adgroup
Apple Ads: Report Search Terms in Ad Group · read-only · idempotent
Search-term performance for an ad group.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
startTime | string | no | Report start date YYYY-MM-DD. |
endTime | string | no | Report end date YYYY-MM-DD. |
granularity | string | no | HOURLY | DAILY | WEEKLY | MONTHLY. |
groupBy | string[] | no | Optional groupBy fields (e.g. countryOrRegion, deviceClass). |
selector | object | no | Apple selector { conditions, orderBy, pagination }. |
returnRowTotals | boolean | no | |
returnGrandTotals | boolean | no | |
returnRecordsWithNoMetrics | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_report_search_terms_in_campaign
Apple Ads: Report Search Terms in Campaign · read-only · idempotent
Search-term performance report for a campaign, over a date range.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
startTime | string | no | Report start date YYYY-MM-DD. |
endTime | string | no | Report end date YYYY-MM-DD. |
granularity | string | no | HOURLY | DAILY | WEEKLY | MONTHLY. |
groupBy | string[] | no | Optional groupBy fields (e.g. countryOrRegion, deviceClass). |
selector | object | no | Apple selector { conditions, orderBy, pagination }. |
returnRowTotals | boolean | no | |
returnGrandTotals | boolean | no | |
returnRecordsWithNoMetrics | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_search_apps
Apple Ads: Search Apps · read-only · idempotent
Search apps on the App Store for ad targeting.
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | no | |
returnOwnedApps | boolean | no | |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
apple_ads_apple_ads_search_geo
Apple Ads: Search Geo · read-only · idempotent
Search geographic entities (Country, AdminArea, Locality).
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | no | |
entity | string | no | Country|AdminArea|Locality. |
account_id | string | no | Apple Ads organization to use when the workspace has several. Default: the first organization linked to the workspace. |
Create and change (€29)
Served with the €29 plan.
apple_ads_apple_ads_create_ad
Apple Ads: Create Ad · create or change, €29 plan · creates an object on each call
Creates a new ad in an ad group from an ad object.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
ad | object | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_create_adgroup
Apple Ads: Create Ad Group · create or change, €29 plan · creates an object on each call
Creates a new ad group in a campaign from an adgroup object.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup | object | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_create_adgroup_negative_keywords
Apple Ads: Create Ad Group Negative Keywords · create or change, €29 plan · creates an object on each call
Bulk-creates negative keywords in an ad group.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keywords | any[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_create_campaign
Apple Ads: Create Campaign · create or change, €29 plan · creates an object on each call
Creates a new campaign in the Apple Ads org from a campaign object (POST /campaigns).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign | object | no | Campaign object. |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_create_campaign_negative_keywords
Apple Ads: Create Campaign Negative Keywords · create or change, €29 plan · creates an object on each call
Bulk-creates negative keywords at campaign level.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
keywords | any[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_create_creative
Apple Ads: Create Creative · create or change, €29 plan · creates an object on each call
Creates a new creative in the Apple Ads org from a creative object. Apple Ads cannot change or delete a creative afterwards (Creatives: create, find, get only).
| Parameter | Type | Required | Description |
|---|---|---|---|
creative | object | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_create_custom_report
Apple Ads: Create Custom Report · create or change, €29 plan · creates an object on each call
Create an async impression-share report. Apple Ads cannot delete a report afterwards (Impression Share Reports: create, get only).
| Parameter | Type | Required | Description |
|---|---|---|---|
report | object | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_create_targeting_keywords
Apple Ads: Create Targeting Keywords · create or change, €29 plan · creates an object on each call
Bulk-create targeting keywords (up to 1000).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keywords | any[] | no | Array of keyword objects. |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_update_ad
Apple Ads: Update Ad · create or change, €29 plan · creates an object on each call
Updates an ad of an ad group with an ad object (PUT).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
ad_id | string | no | |
ad | object | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_update_adgroup
Apple Ads: Update Ad Group · create or change, €29 plan · creates an object on each call
Updates an ad group of a campaign with an adgroup object (PUT).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
adgroup | object | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_update_adgroup_negative_keywords
Apple Ads: Update Ad Group Negative Keywords · create or change, €29 plan · creates an object on each call
Bulk-updates the negative keywords of an ad group (PUT).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keywords | any[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_update_campaign
Apple Ads: Update Campaign · create or change, €29 plan · creates an object on each call
Updates a campaign by its ID with a campaign object (PUT /campaigns/{campaign_id}).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
campaign | object | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_update_campaign_negative_keywords
Apple Ads: Update Campaign Negative Keywords · create or change, €29 plan · creates an object on each call
Bulk-updates the negative keywords of a campaign (PUT).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
keywords | any[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_update_targeting_keywords
Apple Ads: Update Targeting Keywords · create or change, €29 plan · creates an object on each call
Bulk-updates the targeting keywords of an ad group (PUT).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keywords | any[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
Delete (€29)
Served with the €29 plan. A deletion targets one object at a time.
apple_ads_apple_ads_delete_ad
Apple Ads: Delete Ad · delete, €29 plan, one object at a time · creates an object on each call
Deletes an ad from its ad group, by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
ad_id | string | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_delete_adgroup
Apple Ads: Delete Ad Group · delete, €29 plan, one object at a time · creates an object on each call
Deletes an ad group of a campaign by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_delete_adgroup_negative_keywords
Apple Ads: Delete Ad Group Negative Keywords · delete, €29 plan, one object at a time · creates an object on each call
Bulk-deletes negative keywords of an ad group by their IDs (keyword_ids).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keyword_ids | string[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_delete_campaign
Apple Ads: Delete Campaign · delete, €29 plan, one object at a time · creates an object on each call
Deletes a campaign of the Apple Ads org by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_delete_campaign_negative_keywords
Apple Ads: Delete Campaign Negative Keywords · delete, €29 plan, one object at a time · creates an object on each call
Bulk-deletes negative keywords of a campaign by their IDs (keyword_ids).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
keyword_ids | string[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_delete_targeting_keyword
Apple Ads: Delete Targeting Keyword · delete, €29 plan, one object at a time · creates an object on each call
Deletes a single targeting keyword of an ad group by its ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keyword_id | string | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |
apple_ads_apple_ads_delete_targeting_keywords
Apple Ads: Delete Targeting Keywords · delete, €29 plan, one object at a time · creates an object on each call
Bulk-deletes targeting keywords of an ad group by their IDs (keyword_ids).
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | no | |
adgroup_id | string | no | |
keyword_ids | string[] | no | |
account_id | string | no | Apple Ads organization that owns the target object. Required when the workspace has several linked organizations; otherwise its only organization. |