Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AsyncReport":{"properties":{"configuration":{"$ref":"#/components/schemas/AsyncReportConfiguration"},"createdAt":{"description":"The date at which the report was created in ISO 8601 date time format.","type":"string"},"endDate":{"description":"The end date for the reporting period in YYYY-mm-dd format.","type":"string"},"failureReason":{"description":"Present for failed reports only. The reason why a report failed to generate.","nullable":true,"type":"string"},"fileSize":{"description":"The size of the report file, in bytes.","nullable":true,"type":"number"},"generatedAt":{"description":"The date at which the report was generated in ISO 8601 date time format.","nullable":true,"type":"string"},"name":{"description":"Optional. The name of the generated report.","nullable":true,"type":"string"},"reportId":{"description":"The identifier of the requested report.","type":"string"},"startDate":{"description":"The start date for the reporting period in YYYY-mm-dd format.","type":"string"},"status":{"description":"The build status of the report.\n - `PENDING` - Report is created and awaiting processing.\n - `PROCESSING` - Report is processing. Please wait.\n - `COMPLETED` - Report has completed.","enum":["COMPLETED","FAILED","PENDING","PROCESSING"],"type":"string"},"updatedAt":{"description":"The date at which the report was last updated in ISO 8601 date time format.","type":"string"},"url":{"description":"URL of the generated report.","nullable":true,"type":"string"},"urlExpiresAt":{"description":"The date at which the download URL for the generated report expires. urlExpires at this time defaults to 3600 seconds but may vary in the future.","nullable":true,"type":"string"}},"required":["configuration","createdAt","endDate","reportId","startDate","status","updatedAt"],"type":"object"},"AsyncReportAdProduct":{"description":"The advertising product.","enum":["ALL","DEMAND_SIDE_PLATFORM","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"],"type":"string"},"AsyncReportConfiguration":{"properties":{"adProduct":{"$ref":"#/components/schemas/AsyncReportAdProduct"},"columns":{"description":"The list of columns to be used for report. The availability of\ncolumns depends on the selection of reportTypeId. This list cannot be null or empty.\n","items":{"type":"string"},"type":"array"},"filters":{"description":"The list of filters supported by a report type. The availability of filters fields depends on the selection of reportTypeId.","items":{"$ref":"#/components/schemas/AsyncReportFilter"},"nullable":true,"type":"array"},"format":{"description":"The report file format.","enum":["GZIP_JSON"],"type":"string"},"groupBy":{"description":"This field determines the aggregation level of the report data and also makes additional fields available\nfor selection. This field cannot be null or empty.\n","items":{"type":"string"},"type":"array"},"reportTypeId":{"description":"The identifier of the Report Type to be generated.","type":"string"},"timeUnit":{"description":"The aggregation level of report data. If the timeUnit is set to `SUMMARY`, the report data is aggregated at the time period specified. The availability\nof time unit breakdowns depends on the selection of reportTypeId.\n","enum":["DAILY","SUMMARY"],"type":"string"}},"required":["adProduct","columns","format","groupBy","reportTypeId","timeUnit"],"type":"object"},"AsyncReportFilter":{"properties":{"field":{"description":"The field name of the filter","type":"string"},"values":{"description":"The values to be filtered by","items":{"type":"string"},"type":"array"}},"type":"object"},"AsyncReportingError":{"description":"The Error Response.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"detail":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"CreateAsyncReportRequest":{"properties":{"configuration":{"$ref":"#/components/schemas/AsyncReportConfiguration"},"endDate":{"description":"YYYY-MM-DD format. The maximum lookback window supported depends on the selection of reportTypeId. Most report types support `95 days` as lookback window.","type":"string"},"name":{"description":"The name of the report.","type":"string"},"startDate":{"description":"YYYY-MM-DD format. The maximum lookback window supported depends on the selection of reportTypeId. Most report types support `95 days` as lookback window.","type":"string"}},"required":["configuration","endDate","startDate"],"type":"object"},"DeleteAsyncReportResponse":{"properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"detail":{"description":"A human-readable description of the response.","type":"string"},"reportId":{"description":"The identifier of the report.","type":"string"}},"type":"object"}},"securitySchemes":{}},"info":{"title":"Offline Report","version":"3.0"},"openapi":"3.0.1","paths":{"/reporting/reports":{"post":{"description":"Creates a report request. Use this operation to request the creation of a new report for Amazon Advertising Products. Use `adProduct` to specify the Advertising Product of the report.","operationId":"createAsyncReport","parameters":[{"description":"The client identifier of the customer making the request.","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":false,"schema":{"type":"string"}},{"description":"The identifier of a DSP advertiser account. Optional. For details, see [this guide](guides/reporting/dsp/creating-reports).","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.createasyncreportrequest.v3+json":{"schema":{"$ref":"#/components/schemas/CreateAsyncReportRequest"}}}},"responses":{"200":{"content":{"application/vnd.createasyncreportresponse.v3+json":{"schema":{"$ref":"#/components/schemas/AsyncReport"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"425":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Too Early - Request is a duplicate of a processing request."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Creates a report request","tags":["Asynchronous Reports"]}},"/reporting/reports/{reportId}":{"delete":{"description":"Deletes a report by id. Use this operation to cancel a report in a `PENDING` status.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Advertising-API-Scope...","operationId":"deleteAsyncReport","parameters":[{"description":"The identifier of the requested report.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}},{"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":false,"schema":{"type":"string"}},{"description":"The identifier of a DSP advertiser account. Optional. For details, see [this guide](guides/reporting/dsp/creating-reports).","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.deleteasyncreportresponse.v3+json":{"schema":{"$ref":"#/components/schemas/DeleteAsyncReportResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"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/AsyncReportingError"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Not Found."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Deletes a report by id","tags":["Asynchronous Reports"]},"get":{"description":"Gets a generation status of a report by id. Uses the `reportId` value from\nthe response of previously requested report via `POST /reporting/reports`\noperation.","operationId":"getAsyncReport","parameters":[{"description":"The identifier of the requested report.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}},{"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":false,"schema":{"type":"string"}},{"description":"The identifier of a DSP advertiser account. Optional. For details, see [this guide](guides/reporting/dsp/creating-reports).","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.getasyncreportresponse.v3+json":{"schema":{"$ref":"#/components/schemas/AsyncReport"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Not Found."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncReportingError"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets a generation status of report by id","tags":["Asynchronous Reports"]}}}}