Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AsinComponent":{"description":"Asin component which needs to be pre moderated.","properties":{"asin":{"description":"Asin id to be pre moderated.","type":"string"},"componentType":{"description":"Type of the asin component.","enum":["LANDING_ASIN","PRODUCT_ASIN"],"type":"string"},"id":{"description":"Id of the component. The same will be returned as part of the response as well. This can be used to uniquely identify the component from the pre moderation response.","type":"string"}},"required":["asin","componentType","id"],"type":"object"},"AsinComponentResponse":{"description":"Pre-moderation result for an Asin component","properties":{"asin":{"description":"Pre-moderated Asin Id.","type":"string"},"componentType":{"description":"Type of Asin component.","enum":["LANDING_ASIN","PRODUCT_ASIN"],"type":"string"},"id":{"description":"Id of the component. This is the same id sent as part of the request. This can be used to uniquely identify the component.","type":"string"},"policyViolations":{"description":"A list of policy violations for the component that were detected during pre moderation. Note that this field is present in the response only when preModerationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/AsinPolicyViolation","properties":{}},"type":"array"},"preModerationStatus":{"description":"The pre-moderation status of the component.","enum":["APPROVED","FAILED","REJECTED","RETRYABLE_FAILURE"],"type":"string"}},"type":"object"},"AsinPolicyViolation":{"properties":{"name":{"description":"A policy violation code.","type":"string"},"policyDescription":{"description":"A human-readable description of the policy.","type":"string"},"policyLinkUrl":{"description":"Address of the policy documentation. Follow the link to learn more about the specified policy.","type":"string"},"type":{"description":"Type of policy violation.","enum":["REJECTED","WARNING"],"type":"string"}},"type":"object"},"DateComponent":{"description":"Date component which needs to be pre moderated. Either startDate or endDate must be populated, or both can be populated.","properties":{"componentType":{"description":"Type of the date component.","enum":["CAMPAIGN_DATE"],"type":"string"},"endDate":{"description":"End date of the component in yyyy-MM-dd HH:mm:ss format","type":"string"},"id":{"description":"Id of the component. The same will be returned as part of the response as well. This can be used to uniquely identify the component from the pre moderation response.","type":"string"},"startDate":{"description":"Start date of the component in yyyy-MM-dd HH:mm:ss format","type":"string"}},"required":["componentType","id"],"type":"object"},"DateComponentResponse":{"description":"Pre-moderation result for a date component","properties":{"componentType":{"description":"Type of the date component.","enum":["CAMPAIGN_DATES"],"type":"string"},"endDate":{"description":"End date of the component.","type":"string"},"id":{"description":"Id of the component. This is the same id sent as part of the request. This can be used to uniquely identify the component.","type":"string"},"policyViolations":{"description":"A list of policy violations for the component that were detected during pre moderation. Note that this field is present in the response only when preModerationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/DatePolicyViolation","properties":{}},"type":"array"},"preModerationStatus":{"description":"The pre-moderation status of the component.","enum":["APPROVED","FAILED","REJECTED","RETRYABLE_FAILURE"],"type":"string"},"startDate":{"description":"Start date of the component.","type":"string"}},"type":"object"},"DatePolicyViolation":{"properties":{"name":{"description":"A policy violation code.","type":"string"},"policyDescription":{"description":"A human-readable description of the policy.","type":"string"},"policyLinkUrl":{"description":"Address of the policy documentation. Follow the link to learn more about the specified policy.","type":"string"},"type":{"description":"Type of policy violation.","enum":["REJECTED","WARNING"],"type":"string"}},"type":"object"},"ImageComponent":{"description":"Image component which needs to be pre moderated. A publicly accessible imageUrl must be sent.","properties":{"componentType":{"description":"Type of the image component.","enum":["BRAND_LOGO","CUSTOM_IMAGE","OTHER_IMAGE"],"type":"string"},"id":{"description":"Id of the component. The same will be returned as part of the response as well. This can be used to uniquely identify the component from the pre moderation response.","type":"string"},"landingPage":{"$ref":"#/components/schemas/LandingPage"},"url":{"description":"Url of the image to be pre moderated. The url must be publicly accessible.","type":"string"}},"required":["componentType","id","url"],"type":"object"},"ImageComponentResponse":{"description":"Pre moderation result for a image component","properties":{"componentType":{"description":"Type of the image component.","enum":["BRAND_LOGO","CUSTOM_IMAGE","OTHER_IMAGE"],"type":"string"},"id":{"description":"Id of the component. This is the same id sent as part of the request. This can be used to uniquely identify the component.","type":"string"},"landingPage":{"$ref":"#/components/schemas/LandingPage"},"policyViolations":{"description":"A list of policy violations for the component that were detected during pre moderation. Note that this field is present in the response only when preModerationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/ImagePolicyViolation","properties":{}},"type":"array"},"preModerationStatus":{"description":"The pre moderation status of the component.","enum":["APPROVED","FAILED","REJECTED","RETRYABLE_FAILURE"],"type":"string"},"specViolations":{"description":"A list of specification violations for the component that were detected during pre moderation. Note that this field is present in the response only when preModerationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/ImageSpecViolation","properties":{}},"type":"array"},"url":{"description":"Publicly accessible url of the image that got pre moderated.","type":"string"}},"type":"object"},"ImageEvidence":{"description":"Structure of a image evidence","properties":{"height":{"description":"The height of the content that violates the specified policy within the image.","type":"integer"},"topLeftX":{"description":"The top left X-coordinate of the content that violates the specified policy within the image.","type":"integer"},"topLeftY":{"description":"The top left Y-coordinate of the content that violates the specified policy within the image.","type":"integer"},"width":{"description":"The width of the content that violates the specified policy within the image.","type":"integer"}},"type":"object"},"ImagePolicyViolation":{"description":"Structure of policy violation for a image component","properties":{"imageEvidences":{"description":"List of evidences for the policy violations detected on the image component.","items":{"$ref":"#/components/schemas/ImageEvidence","properties":{}},"type":"array"},"name":{"description":"A policy violation code.","type":"string"},"policyDescription":{"description":"A human-readable description of the policy.","type":"string"},"policyLinkUrl":{"description":"Address of the policy documentation. Follow the link to learn more about the specified policy.","type":"string"},"textEvidences":{"description":"Policy violation on an image can be detected on the ocr detected text on the image as well. This list of text evidences will have the policy violations detected on the text on top of the image.","items":{"$ref":"#/components/schemas/TextEvidence","properties":{}},"type":"array"},"type":{"description":"Type of policy violation.","enum":["REJECTED","WARNING"],"type":"string"}},"type":"object"},"ImageSpecComputed":{"description":"Structure of actual specification of an image component, computed by moderation system.","properties":{"imageEvidences":{"description":"List of evidences for the computed specification value on the image component.","items":{"$ref":"#/components/schemas/ImageEvidence","properties":{}},"maxItems":5,"minItems":0,"type":"array"},"violationDescription":{"description":"A human-readable description of the computed specification for an image component, which violates the requirement","type":"string"}},"type":"object"},"ImageSpecViolation":{"description":"Structure of spec violation for an image component.","properties":{"computedViolations":{"description":"Structure of specifications for an image component, computed by moderation system, which violates the requirement in spec description","items":{"$ref":"#/components/schemas/ImageSpecComputed","properties":{}},"maxItems":5,"minItems":1,"type":"array"},"name":{"description":"A spec violation code.","enum":["AMAZON_LOGO_BLURRY","ANIMATION_MORE_THAN_15_SECONDS","ANIMATION_MORE_THAN_30_SECONDS","CTA_IN_ALL_CAPS","IMAGE_FONT_ILLEGIBLE","INVALID_BRAND_LOGO","INVALID_CUSTOM_IMAGE","LOOPS_MORE_THAN_3_TIMES","POOR_IMAGE_OR_VIDEO_QUALITY"],"type":"string"},"specDescription":{"description":"A human-readable description of the spec requirement.","type":"string"},"specLinkUrl":{"description":"Address of the ad specification documentation. Follow the link to learn more about the required ad specification.","type":"string"},"type":{"description":"Type of spec violation.","enum":["REJECTED","WARNING"],"type":"string"}},"type":"object"},"LandingPage":{"description":"Details of landing page.","properties":{"url":{"description":"Landing Page Url of the component.","type":"string"}},"type":"object"},"ModerationError":{"description":"The Error Response Object.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"PreModerationRequest":{"description":"Components details that needs to be sent for pre moderation.","properties":{"adProgram":{"description":"Type of Ad program to which this pre moderation components belong to.","enum":["DSP","DSP_CONSOLIDATED_TEMPLATE","DSP_IMAGE","DSP_REC","DSP_THIRD_PARTY","SPONSORED_BRANDS","SPONSORED_BRANDS_SPOTLIGHT","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_DISPLAY_NOT_SOLD_ON_AMAZON","SPONSORED_TV","STORES"],"type":"string"},"asinComponents":{"description":"Asin components which needs to be pre moderated.","items":{"$ref":"#/components/schemas/AsinComponent"},"maxItems":10,"type":"array"},"dateComponents":{"description":"Date components which needs to be pre moderated.","items":{"$ref":"#/components/schemas/DateComponent"},"maxItems":10,"type":"array"},"imageComponents":{"description":"Image components which needs to be pre moderated.","items":{"$ref":"#/components/schemas/ImageComponent"},"maxItems":10,"type":"array"},"locale":{"description":"Specifying locale will translate the premoderation message into that locale's associated language. \n \n | Locale | Language (ISO 639) | Country (ISO 3166) | \n |-----|-----|-------| \n | ar-AE | Arabic (...","enum":["ar-AE","de-DE","en-AE","en-AU","en-CA","en-GB","en-IN","en-JP","en-NL","en-SA","en-US","es-ES","es-MX","es-US","fr-CA","fr-FR","it-IT","ja-JP","ko-KR","nl-NL","pt-BR","tr-TR","zh-CN"],"type":"string"},"recordId":{"description":"Id of the brand/advertiser.","type":"string"},"textComponents":{"description":"Text components which needs to be pre moderated.","items":{"$ref":"#/components/schemas/TextComponent"},"maxItems":10,"type":"array"},"videoComponents":{"description":"Video components which needs to be pre moderated.","items":{"$ref":"#/components/schemas/VideoComponent"},"maxItems":1,"type":"array"}},"required":["adProgram","locale"],"type":"object"},"PreModerationResponse":{"description":"Information regarding the policy violations if present for the components, sent for pre moderation.","properties":{"adProgram":{"description":"Type of Ad program to which the pre moderation components belong to.","enum":["DSP","DSP_CONSOLIDATED_TEMPLATE","DSP_IMAGE","DSP_REC","DSP_THIRD_PARTY","SPONSORED_BRANDS","SPONSORED_BRANDS_SPOTLIGHT","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_DISPLAY_NOT_SOLD_ON_AMAZON","SPONSORED_TV","STORES"],"type":"string"},"asinComponents":{"description":"Pre moderation result of the asin components. It will have information regarding the policy violations present if any.","items":{"$ref":"#/components/schemas/AsinComponentResponse","properties":{}},"type":"array"},"dateComponents":{"description":"Pre moderation result of the date components. It will have information regarding the policy violations present if any.","items":{"$ref":"#/components/schemas/DateComponentResponse","properties":{}},"type":"array"},"imageComponents":{"description":"Pre moderation result of the image components. It will have information regarding the policy violations present if any.","items":{"$ref":"#/components/schemas/ImageComponentResponse","properties":{}},"type":"array"},"locale":{"description":"Locale value that was passed in request.","enum":["ar-AE","de-DE","en-AE","en-AU","en-CA","en-GB","en-IN","en-JP","en-NL","en-SA","en-US","es-ES","es-MX","es-US","fr-CA","fr-FR","it-IT","ja-JP","ko-KR","nl-NL","pt-BR","tr-TR","zh-CN"],"type":"string"},"preModerationId":{"description":"Unique Id for the moderation Request.","type":"string"},"recordId":{"description":"Id of the brand/advertiser.","type":"string"},"textComponents":{"description":"Pre moderation result of the text components. It will have information regarding the policy violations present if any.","items":{"$ref":"#/components/schemas/TextComponentResponse","properties":{}},"type":"array"},"videoComponents":{"description":"Pre moderation result of the video components. It will have information regarding the policy violations present if any.","items":{"$ref":"#/components/schemas/VideoComponentResponse","properties":{}},"type":"array"}},"type":"object"},"TextComponent":{"description":"Text component which needs to be pre moderated","properties":{"componentType":{"description":"Type of text component.","enum":["BRAND_NAME","HEADLINE","OTHER_TEXT"],"type":"string"},"id":{"description":"Id of the component. The same will be returned as part of the response as well. This can be used to uniquely identify the component from the pre moderation response.","type":"string"},"text":{"description":"Text which needs to be moderated.","type":"string"}},"required":["componentType","id","text"],"type":"object"},"TextComponentResponse":{"description":"Pre moderation result for a text component","properties":{"componentType":{"description":"Type of the text component.","enum":["BRAND_NAME","HEADLINE","OTHER_TEXT"],"type":"string"},"corrections":{"description":"A list of corrected text without any policy violation. You could consider replacing the component with one of the corrected texts","items":{"properties":{},"type":"string"},"type":"array"},"id":{"description":"Id of the component. This is the same id sent as part of the request. This can be used to uniquely identify the component.","type":"string"},"policyViolations":{"description":"A list of policy violations for the component that were detected during pre moderation. Note that this field is present in the response only when preModerationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/TextPolicyViolation","properties":{}},"type":"array"},"preModerationStatus":{"description":"The pre moderation status of the component.","enum":["APPROVED","FAILED","REJECTED","RETRYABLE_FAILURE"],"type":"string"},"text":{"description":"Text which got pre moderated.","type":"string"}},"type":"object"},"TextEvidence":{"description":"Structure of a text evidence","properties":{"position":{"description":"Position in the textComponent where the policy violation is detected.","properties":{"end":{"description":"Zero-based index into the text in textComponent where the text specified in violatingText ends.","properties":{},"type":"integer"},"start":{"description":"Zero-based index into the text in textComponent where the text specified in violatingText starts.","properties":{},"type":"integer"}},"type":"object"},"violatingText":{"description":"The specific text determined to violate the specified policy in reviewedText.","type":"string"}},"type":"object"},"TextPolicyViolation":{"description":"Structure of policy violation for a text component","properties":{"name":{"description":"A policy violation code.","type":"string"},"policyDescription":{"description":"A human-readable description of the policy.","type":"string"},"policyLinkUrl":{"description":"Address of the policy documentation. Follow the link to learn more about the specified policy.","type":"string"},"textEvidences":{"description":"List of text evidences","items":{"$ref":"#/components/schemas/TextEvidence","properties":{}},"type":"array"},"type":{"description":"Type of policy violation.","enum":["REJECTED","WARNING"],"type":"string"}},"type":"object"},"VideoComponent":{"description":"Video component which needs to be pre moderated. A publicly accessible videoUrl must be sent.","properties":{"componentType":{"description":"Type of the video component.","enum":["DSP_VIDEO","OTHER_VIDEO","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_TV_VIDEO"],"type":"string"},"id":{"description":"Id of the component. The same will be returned as part of the response as well. This can be used to uniquely identify the component from the pre moderation response.","type":"string"},"landingPage":{"$ref":"#/components/schemas/LandingPage"},"url":{"description":"Url of the video to be pre moderated. The url must be publicly accessible.","type":"string"}},"required":["componentType","id","url"],"type":"object"},"VideoComponentResponse":{"description":"Pre moderation result for a video component","properties":{"componentType":{"description":"Type of the video component.","enum":["DSP_VIDEO","OTHER_VIDEO","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_TV_VIDEO"],"type":"string"},"id":{"description":"Id of the component. This is the same id sent as part of the request. This can be used to uniquely identify the component.","type":"string"},"landingPage":{"$ref":"#/components/schemas/LandingPage"},"policyViolations":{"description":"A list of policy violations for the component that were detected during pre moderation. Note that this field is present in the response only when preModerationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/VideoPolicyViolation","properties":{}},"type":"array"},"preModerationStatus":{"description":"The pre moderation status of the component.","enum":["APPROVED","FAILED","REJECTED","RETRYABLE_FAILURE"],"type":"string"},"specViolations":{"description":"A list of specification violations for the component that were detected during pre moderation. Note that this field is present in the response only when preModerationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/VideoSpecViolation","properties":{}},"type":"array"},"url":{"description":"Publicly accessible url of the video that got pre moderated.","type":"string"}},"type":"object"},"VideoEvidence":{"description":"Structure of a video evidence","properties":{"end":{"description":"The end position (in seconds) of the content that violates the specified policy within the video.","type":"integer"},"start":{"description":"The start position (in seconds) of the content that violates the specified policy within the video.","type":"integer"}},"type":"object"},"VideoPolicyViolation":{"description":"Structure of policy violation for a video component","properties":{"name":{"description":"A policy violation code.","type":"string"},"policyDescription":{"description":"A human-readable description of the policy.","type":"string"},"policyLinkUrl":{"description":"Address of the policy documentation. Follow the link to learn more about the specified policy.","type":"string"},"type":{"description":"Type of policy violation.","enum":["REJECTED","WARNING"],"type":"string"},"videoEvidences":{"description":"List of evidences for the policy violations detected on the video component.","items":{"$ref":"#/components/schemas/VideoEvidence","properties":{}},"type":"array"}},"type":"object"},"VideoSpecComputed":{"description":"Structure of actual specification of a video component, computed by moderation system.","properties":{"videoEvidences":{"description":"List of evidences for the the computed specification value on the video component.","items":{"$ref":"#/components/schemas/VideoEvidence","properties":{}},"maxItems":5,"minItems":0,"type":"array"},"violationDescription":{"description":"A human-readable description of the computed specification for a video component, which violates the requirement.","type":"string"}},"type":"object"},"VideoSpecViolation":{"description":"Structure of specification violation for a video component.","properties":{"computedViolations":{"description":"Structure of specifications for a video component, computed by moderation system, which violates the requirement in spec description","items":{"$ref":"#/components/schemas/VideoSpecComputed","properties":{}},"maxItems":5,"minItems":1,"type":"array"},"name":{"description":"A spec violation code.","enum":["AUDIO_CODEC","AUDIO_FORMAT","AUDIO_SAMPLE_RATE","AUDIO_STREAM_COUNT","CHROMA_SUBSAMPLING","LETTERBOX_FORMAT","MAX_FILE_SIZE","MAX_VIDEO_RESOLUTION_HEIGHT","MIN_AUDIO_BITRATE","MIN_AUDIO_CHANNEL_COUNT","MIN_AUDIO_SAMPLE_RATE","MIN_VIDEO_BITRATE","MIN_VIDEO_FRAME_RATE","MIN_VIDEO_RESOLUTION","VIDEO_ASPECT_RATIO","VIDEO_CODEC","VIDEO_CONTAINER_FORMAT","VIDEO_DURATION","VIDEO_DURATION_RANGE","VIDEO_FRAME_RATE","VIDEO_RESOLUTION","VIDEO_STREAM_COUNT"],"type":"string"},"specDescription":{"description":"A human-readable description of the spec requirement.","type":"string"},"specLinkUrl":{"description":"Address of the ad specification documentation. Follow the link to learn more about the required ad specification.","type":"string"},"type":{"description":"Type of spec violation.","enum":["REJECTED","WARNING"],"type":"string"}},"type":"object"}},"securitySchemes":{}},"info":{"title":"PreModeration","version":"3.0"},"openapi":"3.0.1","paths":{"/preModeration":{"post":{"description":"This API will be accepting different components of the ad/page and will be automatically validating the components and send back the policy violations if any.","operationId":"preModeration","parameters":[{"description":"The header used to pass global account associated with the advertiser account. Use `GET` method on the Global Ads Account resource to list the global ads account associated with the access token passe...","in":"header","name":"Amazon-Ads-AccountId","required":false,"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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreModerationRequest"}}},"description":"Request body for preModeration API.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreModerationResponse"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModerationError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModerationError"}}},"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/ModerationError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModerationError"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModerationError"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModerationError"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Pre moderate the components","tags":["Pre Moderation"]}}}}