{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"clientHeader":{"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"}},"profileHeader":{"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"ComponentModerationResults":{"description":"The moderation results of the individual components in the ad. This is currently only available for the SPONSORED_PRODUCTS adProgramType.","properties":{"imageComponents":{"items":{"$ref":"#/components/schemas/ImageComponentModerationResult"},"maxItems":200,"minItems":0,"type":"array"},"textComponents":{"items":{"$ref":"#/components/schemas/TextComponentModerationResult"},"maxItems":200,"minItems":0,"type":"array"},"videoComponents":{"items":{"$ref":"#/components/schemas/VideoComponentModerationResult"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"Id":{"description":"The unique identifier of the ad which can be obtained after the ad is created using create APIs.","type":"string"},"IdType":{"description":"The unique identifiers type based on the adProgram of the ad.","enum":["AD_ID"],"type":"string"},"ImageComponentModerationResult":{"properties":{"id":{"description":"The ID of the image component.","type":"string"},"imageUrl":{"description":"The URL of the image component.","type":"string"},"moderationStatus":{"$ref":"#/components/schemas/ModerationStatus","description":"The moderation status of the image component."},"policyViolations":{"description":"A list of policy violations for an image component that has failed moderation. Note that this field is present in the response only when moderationStatus of the image component is set to REJECTED.","items":{"$ref":"#/components/schemas/PolicyViolation"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"ImageCrop":{"properties":{"height":{"description":"Policy violated region\u0027s height in pixel.","format":"int64","type":"integer"},"topLeftX":{"description":"Policy violated region\u0027s top left X-axis pixel value.","format":"int64","type":"integer"},"topLeftY":{"description":"Policy violated region\u0027s top left Y-axis pixel value.","format":"int64","type":"integer"},"width":{"description":"Policy violated region\u0027s width in pixel.","format":"int64","type":"integer"}},"type":"object"},"ModerationResult":{"properties":{"componentModerationResults":{"$ref":"#/components/schemas/ComponentModerationResults"},"etaForModeration":{"description":"Expected date and time by which moderation will be complete. The format is ISO 8601 in UTC time zone. Note that this field is present in the response only when moderationStatus is set to IN_PROGRESS.","type":"string"},"id":{"$ref":"#/components/schemas/Id"},"idType":{"$ref":"#/components/schemas/IdType"},"moderationStatus":{"$ref":"#/components/schemas/ModerationStatus"},"policyViolations":{"description":"A list of policy violations for a campaign that has failed moderation. Note that this field is present in the response only when moderationStatus is set to REJECTED.","items":{"$ref":"#/components/schemas/PolicyViolation"},"maxItems":200,"minItems":0,"type":"array"},"versionId":{"$ref":"#/components/schemas/VersionId"}},"type":"object"},"ModerationResultsAccessDeniedError":{"properties":{"code":{"description":"Access denied error code.","enum":["ACCESS_DENIED"],"type":"string"},"details":{"description":"A human-readable description of the error response.","type":"string"}},"type":"object"},"ModerationResultsAdProgramType":{"description":"The program type of the ad.","enum":["SB_PRODUCT_COLLECTION","SB_STORE_SPOTLIGHT","SB_VIDEO","SPONSORED_DISPLAY","SPONSORED_PRODUCTS"],"type":"string"},"ModerationResultsBadRequestError":{"properties":{"code":{"description":"Bad request error code.","enum":["BAD_REQUEST"],"type":"string"},"details":{"description":"A human-readable description of the error response.","type":"string"}},"type":"object"},"ModerationResultsInternalServerError":{"properties":{"code":{"description":"Internal error code.","enum":["INTERNAL_ERROR"],"type":"string"},"details":{"description":"A human-readable description of the error response.","type":"string"}},"type":"object"},"ModerationResultsNotAcceptableError":{"properties":{"code":{"description":"Not acceptable error code.","enum":["NOT_ACCEPTABLE"],"type":"string"},"details":{"description":"A human-readable description of the error response.","type":"string"}},"type":"object"},"ModerationResultsNotFoundError":{"properties":{"code":{"description":"Not found error code.","enum":["NOT_FOUND"],"type":"string"},"details":{"description":"A human-readable description of the error response.","type":"string"}},"type":"object"},"ModerationResultsRequest":{"properties":{"adProgramType":{"$ref":"#/components/schemas/ModerationResultsAdProgramType"},"id":{"$ref":"#/components/schemas/Id"},"idType":{"$ref":"#/components/schemas/IdType"},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","format":"int32","maximum":10,"minimum":1,"type":"integer"},"moderationStatusFilter":{"description":"Filter by specific moderation status.","items":{"$ref":"#/components/schemas/ModerationStatus"},"maxItems":20,"minItems":0,"type":"array","uniqueItems":true},"nextToken":{"$ref":"#/components/schemas/NextToken"},"versionIdFilter":{"description":"Filter by specific version id of the ad. The API will return the ad\u0027s all versions moderation status if this field is empty.","items":{"$ref":"#/components/schemas/VersionId"},"maxItems":200,"minItems":0,"type":"array","uniqueItems":true}},"required":["adProgramType","id","idType","maxResults"],"type":"object"},"ModerationResultsResponse":{"properties":{"moderationResults":{"items":{"$ref":"#/components/schemas/ModerationResult"},"maxItems":10,"minItems":1,"type":"array"},"nextToken":{"$ref":"#/components/schemas/NextToken"}},"type":"object"},"ModerationResultsThrottlingError":{"properties":{"code":{"description":"Throttled error code.","enum":["THROTTLED"],"type":"string"},"details":{"description":"A human-readable description of the error response.","type":"string"}},"type":"object"},"ModerationStatus":{"description":"The moderation status of the ad.","enum":["APPROVED","FAILED","IN_PROGRESS","REJECTED"],"type":"string"},"NextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"PolicyViolation":{"properties":{"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"},"violatingAsinContents":{"items":{"$ref":"#/components/schemas/ViolatingAsinContent"},"maxItems":200,"minItems":0,"type":"array"},"violatingImageContents":{"items":{"$ref":"#/components/schemas/ViolatingImageContent"},"maxItems":200,"minItems":0,"type":"array"},"violatingTextContents":{"items":{"$ref":"#/components/schemas/ViolatingTextContent"},"maxItems":200,"minItems":0,"type":"array"},"violatingVideoContents":{"items":{"$ref":"#/components/schemas/ViolatingVideoContent"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"TextComponentModerationResult":{"properties":{"id":{"description":"The ID of the text component.","type":"string"},"moderationStatus":{"$ref":"#/components/schemas/ModerationStatus","description":"The moderation status of the text component."},"policyViolations":{"description":"A list of policy violations for a text component that has failed moderation. Note that this field is present in the response only when moderationStatus of the text component is set to REJECTED.","items":{"$ref":"#/components/schemas/PolicyViolation"},"maxItems":200,"minItems":0,"type":"array"},"text":{"description":"The text value of the text component.","type":"string"}},"type":"object"},"TextPosition":{"properties":{"end":{"description":"Zero-based index into the text in reviewedText where the text specified in violatingText ends.","format":"int64","type":"integer"},"start":{"description":"Zero-based index into the text in reviewedText where the text specified in violatingText starts.","format":"int64","type":"integer"}},"type":"object"},"VersionId":{"description":"The version identifier that helps to keep track of multiple versions of a submitted ad. In case of Sponsored Brands this is the creative version id.","type":"string"},"VideoComponentModerationResult":{"properties":{"id":{"description":"The ID of the video component.","type":"string"},"moderationStatus":{"$ref":"#/components/schemas/ModerationStatus","description":"The moderation status of the video component."},"policyViolations":{"description":"A list of policy violations for a video component that has failed moderation. Note that this field is present in the response only when moderationStatus of the video component is set to REJECTED.","items":{"$ref":"#/components/schemas/PolicyViolation"},"maxItems":200,"minItems":0,"type":"array"},"videoUrl":{"description":"The URL of the video component.","type":"string"}},"type":"object"},"VideoPosition":{"properties":{"end":{"description":"End time of the video having the policy violation.","format":"int64","type":"integer"},"start":{"description":"Start time of the video having the policy violation.","format":"int64","type":"integer"}},"type":"object"},"ViolatingAsinContent":{"properties":{"moderatedComponent":{"description":"Moderation component which marked the policy violation.","type":"string"},"violatingAsinEvidences":{"items":{"$ref":"#/components/schemas/ViolatingAsinEvidence"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"ViolatingAsinEvidence":{"properties":{"asin":{"description":"ASIN which has the ad policy violation.","type":"string"}},"type":"object"},"ViolatingImageContent":{"properties":{"moderatedComponent":{"description":"Moderation component which marked the policy violation.","type":"string"},"reviewedImageUrl":{"description":"URL of the image which has the ad policy violation.","type":"string"},"violatingImageEvidences":{"items":{"$ref":"#/components/schemas/ViolatingImageEvidence"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"ViolatingImageEvidence":{"properties":{"violatingImageCrop":{"$ref":"#/components/schemas/ImageCrop"}},"type":"object"},"ViolatingTextContent":{"description":"Information about the specific text that violates the specified policy in the campaign.","properties":{"moderatedComponent":{"description":"Moderation component which marked the policy violation.","type":"string"},"reviewedText":{"description":"The actual text on which the moderation was done.","type":"string"},"violatingTextEvidences":{"items":{"$ref":"#/components/schemas/ViolatingTextEvidence"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"ViolatingTextEvidence":{"properties":{"violatingText":{"description":"The specific text determined to violate the specified policy in reviewedText.","type":"string"},"violatingTextPosition":{"$ref":"#/components/schemas/TextPosition"}},"type":"object"},"ViolatingVideoContent":{"properties":{"moderatedComponent":{"description":"Moderation component which marked the policy violation.","type":"string"},"reviewedVideoUrl":{"description":"URL of the video which has the ad policy violation.","type":"string"},"violatingVideoEvidences":{"items":{"$ref":"#/components/schemas/ViolatingVideoEvidence"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"ViolatingVideoEvidence":{"properties":{"violatingVideoPosition":{"$ref":"#/components/schemas/VideoPosition"}},"type":"object"}},"securitySchemes":{}},"info":{"title":"Moderation","version":"3.0"},"openapi":"3.0.1","paths":{"/moderation/results":{"post":{"description":"API to get the moderation results for the ad. Currently this API supports only SponsoredBrands, SponsoredProducts and SponsoredDisplay ad type.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"moderationResults","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"}],"requestBody":{"content":{"application/vnd.moderationresultsrequest.v4.1+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsRequest"}}},"description":"The ad identifier along with adProgram for which the moderation results are required.","required":true},"responses":{"200":{"content":{"application/vnd.moderationresultsresponse.v4.0+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsResponse"}}},"description":"Success."},"400":{"content":{"application/vnd.moderationresultsbadrequesterror.v4.0+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsBadRequestError"}}},"description":"Bad request. The input failed to satisfy the constraints."},"403":{"content":{"application/vnd.moderationresultsaccessdeniederror.v4.0+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsAccessDeniedError"}}},"description":"Access denied. Requester does not have sufficient access to the resource."},"404":{"content":{"application/vnd.moderationresultsnotfounderror.v4.0+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsNotFoundError"}}},"description":"Not Found. Identifier not found."},"406":{"content":{"application/vnd.moderationresultsnotacceptableerror.v4.0+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsNotAcceptableError"}}},"description":"Not Acceptable. The accept header is not supported."},"429":{"content":{"application/vnd.moderationresultsthrottlingerror.v4.0+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsThrottlingError"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.moderationresultsinternalservererror.v4.0+json":{"schema":{"$ref":"#/components/schemas/ModerationResultsInternalServerError"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Moderation Results"]}}}}