{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessDeniedExceptionResponseContent":{"description":"Exception for AccessDeniedException 403 response.","properties":{"message":{"type":"string"}},"type":"object"},"AdRepositoryResponseMap":{"properties":{"advertisementPurpose":{"description":"Displays the intent of the advertisement.","type":"string"},"advertiserName":{"description":"Name of the Advertiser.","type":"string"},"contentUrls":{"description":"List of strings containing link to (1) the store product detail page of products shown in an ad, (2) the store brand page of the brand shown in an ad, or (3) the image of the ad.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"deliveryAfterDateUtc":{"description":"The specified start date of the delivered ads.The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16.","format":"date-time","type":"string"},"deliveryBeforeDateUtc":{"description":"The specified end date of the delivered ads.The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16.","format":"date-time","type":"string"},"id":{"description":"Globally unique identifier for the advertisement, to support lookups in the repository.  It represents the combination of an ad-creative identifier, its marketplace and source of record.","type":"string"},"illegalContentReport":{"description":"Describes whether the ad was removed as a result of an illegal content report.","type":"boolean"},"isRestricted":{"description":"Whether the ad was paused, removed or suppressed based on alleged illegality or incompatibility with terms and conditions.","type":"boolean"},"payerName":{"description":"Name of the entity who paid for the Ad.","type":"string"},"restrictionCategory":{"description":"Reason(s) why an ad was paused, removed, or suppressed.","type":"string"},"restrictionDetectionAutomated":{"description":"Describes whether automation was used to identify the restricted ad.","type":"boolean"},"subjectMatterUrl":{"description":"Subject matter of the advertisement (link to image or rendering).","type":"string"},"targetingMethods":{"description":"This field lists the targeted advertising methods with the descriptions.\n    The targeted advertising methods includes:\n        1: \u0027LOCATION\u0027: \u0027Their estimated location\u0027,\n        2: \u0027PAST_ACTIVITY\u0027: \u0027Their past activity on Amazon websites or services\u0027,\n        3: \u0027ADS_PREFERENCES\u0027: \u0027Their data sharing or personalized ads preferences\u0027,\n        4: \u0027SEARCH_TERMS\u0027: \u0027The search terms they used or the content or products they were viewing\u0027,","items":{"$ref":"#/components/schemas/TargetMethodRecipientGroup"},"maxItems":10,"minItems":0,"type":"array"},"totalRecipientsRange":{"$ref":"#/components/schemas/TotalRecipientsRange"},"totalRecipientsRangeBySite":{"$ref":"#/components/schemas/RecipientsBySite"},"type":{"$ref":"#/components/schemas/Type"}},"required":["advertisementPurpose","advertiserName","deliveryAfterDateUtc","deliveryBeforeDateUtc","id","isRestricted","subjectMatterUrl","targetingMethods","totalRecipientsRange","totalRecipientsRangeBySite","type"],"type":"object"},"GetAdsByIDResponseContent":{"properties":{"ad":{"$ref":"#/components/schemas/AdRepositoryResponseMap"}},"required":["ad"],"type":"object"},"InternalServerExceptionResponseContent":{"description":"Unexpected error during processing of request.","properties":{"message":{"type":"string"}},"type":"object"},"InvalidInputExceptionResponseContent":{"description":"Exception for malformed input.","properties":{"message":{"type":"string"}},"type":"object"},"ListAdsRequestContent":{"properties":{"advertisementPurpose":{"description":"This parameter will limit results to those matching the requested advertisement purpose. This includes the name of the product, service, or brand within the ad or affiliate marketing content.","type":"string"},"advertiserName":{"description":"The person or entity on whose behalf the ad or affiliate marketing content is presented. This parameter will limit results to advertisement summaries matching the requested advertiser name.","type":"string"},"deliveryAfterDateUtc":{"description":"When specified, limits results to those with delivery date after the specified date string. The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16.","format":"date-time","type":"string"},"deliveryBeforeDateUtc":{"description":"When specified, limits results to those with a delivery date prior to the specified date string. The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16.","format":"date-time","type":"string"},"isRestricted":{"description":"Whether the advertisement was paused, removed or suppressed based on alleged illegality or incompatibility with terms and conditions. Limits results based on their restriction status.","type":"boolean"},"maxResults":{"description":"Defaults to 10, with supported values between 1 and 1000.\n    If the size of the result set is larger than the limit, callers will retrieve additional results through pagination parameters.","maximum":1000,"minimum":1,"type":"number"},"nameMatchType":{"$ref":"#/components/schemas/NameMatchType"},"nextToken":{"description":"Pagination token to retrieve the next set of results.\n    Callers must make use of the token provided in a previous response to use this parameter.","type":"string"},"siteName":{"description":"When specified, limits results based on their delivery to a particular Amazon EU store (e.g., amazon.de, amazon.fr).","type":"string"}},"type":"object"},"ListAdsResponseContent":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/AdRepositoryResponseMap"},"maxItems":1000,"minItems":0,"type":"array"},"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"},"totalResults":{"description":"Total number of return results for the query input.","type":"number"}},"required":["ads","totalResults"],"type":"object"},"NameMatchType":{"enum":["CONTAINS","EXACT_MATCH"],"type":"string"},"RecipientsBySite":{"properties":{"amazonBe":{"$ref":"#/components/schemas/TotalRecipientsRange"},"amazonDe":{"$ref":"#/components/schemas/TotalRecipientsRange"},"amazonEs":{"$ref":"#/components/schemas/TotalRecipientsRange"},"amazonFr":{"$ref":"#/components/schemas/TotalRecipientsRange"},"amazonIt":{"$ref":"#/components/schemas/TotalRecipientsRange"},"amazonNl":{"$ref":"#/components/schemas/TotalRecipientsRange"},"amazonPl":{"$ref":"#/components/schemas/TotalRecipientsRange"},"amazonSe":{"$ref":"#/components/schemas/TotalRecipientsRange"}},"type":"object"},"ResourceNotFoundExceptionResponseContent":{"description":"Request references a resource which does not exist.","properties":{"message":{"type":"string"}},"type":"object"},"TargetMethodRecipientGroup":{"enum":["ADS_PREFERENCES","LOCATION","PAST_ACTIVITY","SEARCH_TERMS"],"type":"string"},"ThrottlingExceptionResponseContent":{"description":"Exception for ThrottlingException 429 response.","properties":{"message":{"type":"string"}},"type":"object"},"TotalRecipientsRange":{"properties":{"max":{"maximum":9223372036854775807,"minimum":0,"type":"number"},"min":{"maximum":9223372036854775807,"minimum":0,"type":"number"}},"required":["max","min"],"type":"object"},"Type":{"enum":["AD","AFFILIATE_MARKETING_CONTENT"],"type":"string"},"UnauthorizedExceptionResponseContent":{"description":"Exception for UnauthorizedException 401 response.","properties":{"message":{"type":"string"}},"type":"object"}},"securitySchemes":{}},"info":{"title":"Ad Library API","version":"3.0"},"openapi":"3.0.1","paths":{"/adRepository/ads/list":{"post":{"description":"This is the primary paginated API for retrieving, listing, and searching through the ad repository. By default, a request without any parameters specified will list all items in the repository.\n\n**Requires one of these permissions**:\n[]","operationId":"ListAds","parameters":[{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required header for advertisers and integrators using the Advertising API.","type":"string"}}],"requestBody":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/ListAdsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/ListAdsResponseContent"}}},"description":"ListAds 200 response"},"400":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/InvalidInputExceptionResponseContent"}}},"description":"InvalidInputException 400 response"},"401":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response"},"500":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}}}},"/adRepository/ads/{id}":{"get":{"description":"This is the API for retrieving a single advertisement metadata specified by its id from the ad repository.\n\n**Requires one of these permissions**:\n[]","operationId":"GetAdsByID","parameters":[{"description":"This parameter will limit results to a single advertisement summary matching the requested identifier.","in":"path","name":"id","required":true,"schema":{"description":"This parameter will limit results to a single advertisement summary matching the requested identifier.","type":"string"}},{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required header for advertisers and integrators using the Advertising API.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/GetAdsByIDResponseContent"}}},"description":"GetAdsByID 200 response"},"400":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/InvalidInputExceptionResponseContent"}}},"description":"InvalidInputException 400 response"},"401":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response"},"500":{"content":{"application/vnd.adsrepository.v1.1+json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}}}}}}