@api-emulator/apple-ads
v0.2.2
Published
Apple Ads Platform API v1 provides campaign management, reporting, recommendations, search popularity, account management, and change history.
Readme
@api-emulator/apple-ads
Apple Ads Platform API v1 provides campaign management, reporting, recommendations, search popularity, account management, and change history.
Use this emulator for local tests, CI, and offline agent runs. It keeps your tests separate from the production API.
Start the emulator
- Install the package.
npm install @api-emulator/apple-ads- From this registry, start the emulator.
npx -p api-emulator api --plugin ./providers/@apple-ads/api-emulator.mjs --service apple-adsThe emulator uses the local URL that api-emulator prints. Set your client base URL to this local URL.
Supported API
POST /v1/${path}/queryGET /v1/${path}/:idPOST /v1/${path}PUT /v1/${path}/:idDELETE /v1/${path}/:idPOST /v1/${path}/bulk-${operation}GET /healthGET /openapi.jsonPOST /auth/localGET /v1/search/appsPOST /v1/eligibilities/apps/queryGET /v1/apps/:idPOST /v1/apps/:id/locale-details/queryPOST /v1/metadata/apps/supported-languages/queryGET /v1/campaigns/:id/legacy-app-limited-status-reason-detailsPOST /v1/product-pages/queryGET /v1/product-pages/:idPOST /v1/product-pages/locale-details/queryPOST /v1/assets/uploadGET /v1/assets/:idDELETE /v1/assets/:idGET /v1/rejection-reasons/apps/:idPOST /v1/rejection-reasons/business-brands/queryPOST /v1/reports/apps/${kind}/queryPOST /v1/reports/business-brands/${kind}/queryPOST /v1/insights/apps/impression-share/queryPOST /v1/insights/apps/search-term-popularity/queryGET /v1/meGET /v1/aclsGET /v1/orgs/:idGET /v1/advertiser-resourcesGET /v1/search/geoPOST /v1/search/geoPOST /v1/locations/queryGET /v1/locations/:idPOST /v1/ad-accountsGET /v1/ad-accounts/:idPUT /v1/ad-accounts/:idPOST /v1/recommendations/${type}/${action}POST /v1/suggestions/keywords/query
Coverage
- Level:
smoke-only - Meaning: A smoke test starts the emulator and checks its main behavior.
- Evidence: a direct smoke test exists, but a conformance manifest does not exist.
Credentials
Use a fixed bearer token or API key in each test. The emulator does not send these credentials to the provider.
Test data
Add repeatable test data to the provider configuration.
apple-ads:
# Add provider-specific seed state here.