Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"UniversalApiAmazonAdsApiClientId":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},"UniversalApiAmazonAdsScopeId":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{"UniversalApiBadRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniversalApiError"}}},"description":"Bad request."},"UniversalApiNotAcceptable":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniversalApiError"}}},"description":"Not Acceptable. Either client has provided unsupported accept header value, or in case of getting a export the Accept header differs from the one used to create the particular export."},"UniversalApiNotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniversalApiError"}}},"description":"The requested resource was not found."},"UniversalApiUnauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniversalApiError"}}},"description":"UniversalApiUnauthorized."}},"schemas":{"BaseUniversalApiExportRequest":{"properties":{"adProductFilter":{"default":["SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS"],"description":"Filters the entities returned in export only to selected ad products. In case the filter is not provided, it returns entities from all ad products.","items":{"enum":["SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS"],"type":"string"},"maxItems":3,"minItems":1,"type":"array"},"stateFilter":{"default":["ENABLED","PAUSED"],"description":"Filters the entities returned in export only to selected states. In case the filter is not provided, it returns only `ENABLED` or `PAUSED` entities.","items":{"enum":["ARCHIVED","ENABLED","PAUSED"],"type":"string"},"maxItems":3,"minItems":1,"type":"array"}},"type":"object"},"TargetsUniversalApiExportRequest":{"allOf":[{"$ref":"#/components/schemas/BaseUniversalApiExportRequest"},{"properties":{"negativeFilter":{"default":["false","true"],"description":"Filters the targets returned in export to negative or positive targets. In case the filter is not provided, it returns both negative and positive targets.","items":{"type":"boolean"},"maxItems":2,"minItems":1,"type":"array"},"targetLevelFilter":{"default":["AD_GROUP","CAMPAIGN"],"description":"Filters the targets returned in export only to selected levels. In case the filter is not provided, it returns both `CAMPAIGN` and `AD_GROUP` level targets.","items":{"enum":["AD_GROUP","CAMPAIGN"],"type":"string"},"maxItems":2,"minItems":1,"type":"array"},"targetTypeFilter":{"default":["AUDIENCE","AUTO","KEYWORD","PRODUCT","PRODUCT_AUDIENCE","PRODUCT_CATEGORY","PRODUCT_CATEGORY_AUDIENCE","THEME"],"description":"Filters the targets returned in exports only to selected types. In case the filter is not provided, it returns targets with all target types. Target types are only supported by certain ad products - for instance, `THEME` targets are not available in `SPONSORED_BRANDS`. Please reference https://advertising.amazon.com/API/docs/en-us/reference/common-models/targets for more details.","items":{"enum":["AUDIENCE","AUTO","KEYWORD","PRODUCT","PRODUCT_AUDIENCE","PRODUCT_CATEGORY","PRODUCT_CATEGORY_AUDIENCE","THEME"],"type":"string"},"maxItems":8,"minItems":1,"type":"array"}},"type":"object"}]},"UniversalApiError":{"properties":{"errorCode":{"description":"- INTERNAL_ERROR: The export has failed with an internal error. If the issue persists, please contact customer support.\n- TIMED_OUT: The export request has timed out. For exports with millions of entities, try using filters to reduce the size of the export. If the issue persists, please contact customer support.\n","enum":["INTERNAL_ERROR","TIMED_OUT"],"type":"string"},"message":{"description":"A human-readable description of the error.","type":"string"}},"required":["message"]},"UniversalApiExportResponse":{"properties":{"createdAt":{"description":"Date of when the export request was created.","format":"date-time","type":"string"},"error":{"$ref":"#/components/schemas/UniversalApiError"},"exportId":{"description":"The export identifier.","type":"string"},"fileSize":{"description":"Byte size of the generated file.","type":"number"},"generatedAt":{"description":"Date of when the export was finished generating.","format":"date-time","type":"string"},"status":{"description":"The generation status of the export.\n- PROCESSING: Export is currently in progress.\n- COMPLETED: Export has completed successfully.\n- FAILED: Export has failed. See the error message for more details.\n","enum":["COMPLETED","FAILED","PROCESSING"],"type":"string"},"url":{"description":"A URL for the export. It’s only available if status is COMPLETED.","type":"string"},"urlExpiresAt":{"description":"Date at which the download URL for the generated export expires.","format":"date-time","type":"string"}},"required":["exportId","status"]}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API to request and download exports across ad products.","title":"Amazon Ads API Exports","version":"3.0"},"openapi":"3.0.1","paths":{"/adGroups/export":{"post":{"description":"Creates a file-based export of Ad Groups in the account satisfying the filtering criteria.\n\nTo understand the call flow for asynchronous exports, see [Getting started with sponsored ads exports](/API/docs/en-us/guides/exports/get-started).\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"AdGroupExport","parameters":[{"$ref":"#/components/parameters/UniversalApiAmazonAdsApiClientId"},{"$ref":"#/components/parameters/UniversalApiAmazonAdsScopeId"}],"requestBody":{"content":{"application/vnd.adgroupsexport.v1+json":{"schema":{"$ref":"#/components/schemas/BaseUniversalApiExportRequest"}}},"required":true},"responses":{"202":{"content":{"application/vnd.adgroupsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}}},"description":"Success."},"400":{"$ref":"#/components/responses/UniversalApiBadRequest"},"401":{"$ref":"#/components/responses/UniversalApiUnauthorized"},"406":{"$ref":"#/components/responses/UniversalApiNotAcceptable"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"summary":"Creates a file-based export of Ad Groups.","tags":["Exports"]}},"/ads/export":{"post":{"description":"Creates a file-based export of Ads in the account satisfying the filtering criteria.\n\nTo understand the call flow for asynchronous exports, see [Getting started with sponsored ads exports](/API/docs/en-us/guides/exports/get-started).\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"AdExport","parameters":[{"$ref":"#/components/parameters/UniversalApiAmazonAdsApiClientId"},{"$ref":"#/components/parameters/UniversalApiAmazonAdsScopeId"}],"requestBody":{"content":{"application/vnd.adsexport.v1+json":{"schema":{"$ref":"#/components/schemas/BaseUniversalApiExportRequest"}}},"required":true},"responses":{"202":{"content":{"application/vnd.adsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}}},"description":"Success."},"400":{"$ref":"#/components/responses/UniversalApiBadRequest"},"401":{"$ref":"#/components/responses/UniversalApiUnauthorized"},"406":{"$ref":"#/components/responses/UniversalApiNotAcceptable"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"summary":"Creates a file-based export of Ads.","tags":["Exports"]}},"/campaigns/export":{"post":{"description":"Creates a file-based export of Campaigns in the account satisfying the filtering criteria.\n\nTo understand the call flow for asynchronous exports, see [Getting started with sponsored ads exports](/API/docs/en-us/guides/exports/get-started).\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"CampaignExport","parameters":[{"$ref":"#/components/parameters/UniversalApiAmazonAdsApiClientId"},{"$ref":"#/components/parameters/UniversalApiAmazonAdsScopeId"}],"requestBody":{"content":{"application/vnd.campaignsexport.v1+json":{"schema":{"$ref":"#/components/schemas/BaseUniversalApiExportRequest"}}},"required":true},"responses":{"202":{"content":{"application/vnd.campaignsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}}},"description":"Success."},"400":{"$ref":"#/components/responses/UniversalApiBadRequest"},"401":{"$ref":"#/components/responses/UniversalApiUnauthorized"},"406":{"$ref":"#/components/responses/UniversalApiNotAcceptable"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"summary":"Creates a file-based export of Campaigns.","tags":["Exports"]}},"/exports/{exportId}":{"get":{"description":"This API will return a status of the specified export.\n\nTo understand the call flow for asynchronous exports, see [Getting started with sponsored ads exports](/API/docs/en-us/guides/exports/get-started).\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"GetExport","parameters":[{"$ref":"#/components/parameters/UniversalApiAmazonAdsApiClientId"},{"$ref":"#/components/parameters/UniversalApiAmazonAdsScopeId"},{"description":"The export identifier.","in":"path","name":"exportId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.adgroupsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}},"application/vnd.adsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}},"application/vnd.campaignsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}},"application/vnd.targetsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}}},"description":"Success."},"401":{"$ref":"#/components/responses/UniversalApiUnauthorized"},"404":{"$ref":"#/components/responses/UniversalApiNotFound"},"406":{"$ref":"#/components/responses/UniversalApiNotAcceptable"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"summary":"Gets the status of a requested export and a link to download the export.","tags":["Exports"]}},"/targets/export":{"post":{"description":"Creates a file-based export of Targets in the account satisfying the filtering criteria.\n\nTo understand the call flow for asynchronous exports, see [Getting started with sponsored ads exports](/API/docs/en-us/guides/exports/get-started).\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"TargetExport","parameters":[{"$ref":"#/components/parameters/UniversalApiAmazonAdsApiClientId"},{"$ref":"#/components/parameters/UniversalApiAmazonAdsScopeId"}],"requestBody":{"content":{"application/vnd.targetsexport.v1+json":{"schema":{"$ref":"#/components/schemas/TargetsUniversalApiExportRequest"}}},"required":true},"responses":{"202":{"content":{"application/vnd.targetsexport.v1+json":{"schema":{"$ref":"#/components/schemas/UniversalApiExportResponse"}}},"description":"Success."},"400":{"$ref":"#/components/responses/UniversalApiBadRequest"},"401":{"$ref":"#/components/responses/UniversalApiUnauthorized"},"406":{"$ref":"#/components/responses/UniversalApiNotAcceptable"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"summary":"Creates a file-based export of Targets.","tags":["Exports"]}}},"servers":[{"url":"https://advertising-api.amazon.com"},{"url":"https://advertising-api-eu.amazon.com"},{"url":"https://advertising-api-fe.amazon.com"}]}