Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AdvertiserResponse":{"properties":{"advertisers":{"items":{"$ref":"#/components/schemas/advertiser","properties":{}},"type":"array"}},"type":"object"},"AttributionTagResponse":{"properties":{"advertiserAttributionTagMap":{"additionalProperties":{"$ref":"#/components/schemas/attributionTagMap","properties":{}},"description":"A list of advertisers and associated attribution tags.","type":"object"}},"type":"object"},"MaaSError":{"description":"The error response object.","properties":{"code":{"description":"The HTTP status code of the response. Possible value of code is \"200\", \"207\", \"400\", \"401\", \"429\", \"403\", or \"500\".","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"Publisher":{"properties":{"id":{"allOf":[{"description":"The identifier of a macro publisher.","properties":{},"type":"string","x-amazon-advertising-package":"MaaSPublicAPIAPISwagger"},{"description":"The identifier of a publisher that does not support macros.","properties":{},"type":"string","x-amazon-advertising-package":"MaaSPublicAPIAPISwagger"}],"description":"The identifier of a publisher.","type":"object"},"macroEnabled":{"description":"Set to 'true' if Amazon Attribution provides macro tags for the given publisher.","type":"boolean"},"name":{"description":"The name of the publisher.","type":"string"}},"type":"object"},"PublishersResponse":{"properties":{"publisher":{"description":"A list of publishers.","items":{"$ref":"#/components/schemas/Publisher","properties":{}},"type":"array"}},"type":"object"},"ReportEntry":{"description":"Report entry object in GetReport reports list.","properties":{"adGroupId":{"description":"An ad group external identifier. Applies to `PERFORMANCE` and `PRODUCTS` reportType.","type":"string"},"advertiserName":{"description":"Name of advertiser. Applies to `PERFORMANCE` and `PRODUCTS` reportType.","type":"string"},"brandName":{"description":"Name of the advertiser's brand. Applies only to `PRODUCTS` reportType.","type":"string"},"campaignId":{"description":"A campaign external identifier. Applies to `PERFORMANCE` and `PRODUCTS` reportType.","type":"string"},"creativeId":{"description":"A creative external identifier. Applies only to `PERFORMANCE` reportType","type":"string"},"date":{"description":"Date on which the events took place. Applies to `PERFORMANCE` and `PRODUCTS` reportType.","type":"string"},"marketplace":{"description":"The Amazon-owned site the product is sold on. Applies only to `PRODUCTS` reportType.","type":"string"},"productAsin":{"description":"A unique block of letters and/or numbers that identify all products sold on Amazon. Applies only to `PRODUCTS` reportType.","type":"string"},"productCategory":{"description":"A classification for the type of product being sold which determines its place in the Amazon retail catalog. Contains categories of products. Applies only to `PRODUCTS` reportType.","type":"string"},"productConversionType":{"description":"The conversion type describes whether the conversion happened on a promoted or a brand halo ASIN. Applies only to `PRODUCTS` reportType.","type":"string"},"productGroup":{"description":"A distinct product grouping distinguishing products like watches from video games from toys. Contains groups of products. Applies only to `PRODUCTS` reportType.","type":"string"},"productName":{"description":"The name of the product. Applies only to `PRODUCTS` reportType.","type":"string"},"productSubcategory":{"description":"A classification for the type of product being sold which determines its place in the Amazon retail catalog. Contains subcategories of products. Applies only to `PRODUCTS` reportType","type":"string"},"publisher":{"description":"The publisher name. Applies to `PERFORMANCE` and `PRODUCTS` reportType","type":"string"}},"type":"object"},"ReportRequestBody":{"description":"Report request body. \nTwo types of reports are available: Performance or Products - choose by including the `reportType` property.","properties":{"advertiserIds":{"description":"One or more advertiser Ids to filter reporting by. If requesting reporting for multiple advertiser Ids, input via a comma-delimited list.","type":"string"},"count":{"description":"The number of entries to include in the report.","maximum":5000.0,"minimum":1,"type":"integer"},"cursorId":{"description":"The value of `cursorId` must be set to `null` without `\"\"`, or set to `\"\"` for the first request. For each following request, the value of `cursorId` from the previous response must be included in the current request. Note that for the cursorId values the `\"` character must be escaped with `\\`.","type":"string"},"endDate":{"description":"The end date for the report, form as \"YYYYMMDD\"","type":"string"},"groupBy":{"description":"For Performance report only - controls level of aggregation. Value can be `CAMPAIGN`, `ADGROUP`, or `CREATIVE`. Default is `CREATIVE`.","enum":["ADGROUP","CAMPAIGN","CREATIVE"],"type":"string"},"metrics":{"description":"A comma-delimited list of metrics to include in the report. In the report, each metric’s value reflects the events which took place on the row’s date; in other words, events are reported on the date t...","type":"string"},"reportType":{"description":"The type of report. Either `PERFORMANCE` or `PRODUCTS`. It is an optional parameter. If not used in request body, default reportType is `PERFORMANCE`.","type":"string"},"startDate":{"description":"The start date for the report, in \"YYYYMMDD\" format. For reportType `PRODUCTS`, startDate can only be within last 90 days from current date.","type":"string"}},"type":"object"},"ReportResponse":{"properties":{"cursorId":{"description":"The identifier of the pagination cursor.","type":"string"},"reports":{"items":{"$ref":"#/components/schemas/ReportEntry","properties":{}},"type":"array"},"size":{"description":"The size of the report.","type":"integer"}},"type":"object"},"advertiser":{"properties":{"advertiserId":{"type":"string"},"advertiserName":{"type":"string"}},"type":"object"},"attributionTagMap":{"additionalProperties":{"type":"string"},"description":"An object representing the association between a publisher identifier and an attribution tag.","type":"object"}},"securitySchemes":{}},"info":{"title":"Amazon Attribution","version":"3.0"},"openapi":"3.0.1","paths":{"/attribution/advertisers":{"get":{"description":"For sellers, an attribution profile has one associated advertiser. For vendors, an attribution profile may have more than one associated advertiser.","operationId":"getAdvertisersByProfile","parameters":[{"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"}},{"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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertiserResponse"}}},"description":"success"}},"summary":"Gets a list of advertisers associated with an Amazon Attribution account.","tags":["Advertisers"]}},"/attribution/publishers":{"get":{"description":"Use the response to determine whether to use either the macroTags or nonMacroTemplateTags resource to get tags for a certain publisher.","operationId":"getPublishers","parameters":[{"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"}},{"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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishersResponse"}}},"description":"Success."}},"summary":"Gets a list of all available publishers.","tags":["Publishers"]}},"/attribution/report":{"post":{"operationId":"getAttributionTagsByCampaign","parameters":[{"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"}},{"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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Invalid request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets an attribution report for a specified list of advertisers.","tags":["Reports"]}},"/attribution/tags/macroTag":{"get":{"description":"Third-party publishers, such as Google Ads, Facebook, Microsoft Ads, and Pinterest support tags that include macro parameters.","operationId":"getPublisherAttributionTagTemplate","parameters":[{"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"}},{"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"}},{"description":"A list of publisher identifiers for which to request tags.","explode":true,"in":"query","name":"publisherIds","required":true,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"List of advertiser identifiers for which to request tags.\nIf no values are passed, all advertisers are returned.","explode":true,"in":"query","name":"advertiserIds","schema":{"items":{"format":"int64","type":"integer"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributionTagResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Invalid request, publisher not supported, or invalid advertiser identifier."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Too Many Requests. Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets a list of attribution tags for third-party publisher campaigns that support macros.","tags":["Attribution Tags"]}},"/attribution/tags/nonMacroTemplateTag":{"get":{"description":"Some third-party publishers do not support tags that include macro parameters. In this case, the attribution tag includes a set of '**insertValue**' placeholder values.","operationId":"getPublisherMacroAttributionTag","parameters":[{"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"}},{"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"}},{"description":"A list of publisher identifiers for which to request tags.","explode":true,"in":"query","name":"publisherIds","required":true,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"List of advertiser identifiers for which to request tags.\nIf no values are passed, all advertisers are returned.","explode":true,"in":"query","name":"advertiserIds","schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributionTagResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Invalid request, publisher not supported, or invalid advertiser identifier."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Too Many Requests. Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaaSError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets a list of attribution tags for third-party publisher campaigns that do not support macros.","tags":["Attribution Tags"]}}}}