{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ScopeHeaderOptional":{"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","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"| ErrorCode | Description |\n|------|------|\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `DATE_CANNOT_BE_IN_PAST` | Update the date to be in the future. |\n| `DATE_CANNOT_BE_NULL` | Update the date. |\n| `DATE_TOO_SOON` | Update the date to be further in the future. |\n| `DUPLICATE_FIELD_VALUE_FOUND` | Multiple resources share the non-unique field values. Remove the non-unique field value. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `DURATION_TOO_SHORT` | Update the length to be within the required range. |\n| `FEATURE_DISCONTINUED` | Feature has been discontinued. |\n| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["BAD_REQUEST","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SBAlternateBrandIdType":{"description":"The type of identifier for the alternate brand identifier.\n\n| AlternateBrandIdType | Description |\n|------|------|\n| `BRAND_REGISTRY` | Previous version of brand identifier retrieved from BrandRegistry. Identifiers of this type are returned by the GET /brands operation. |\n","enum":["BRAND_REGISTRY"],"type":"string"},"SBBrandAlternateId":{"description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandId":{"description":"The alternative brand identifier for the brandId.","type":"string"},"alternateBrandIdType":{"$ref":"#/components/schemas/SBAlternateBrandIdType"}},"required":["alternateBrandId","alternateBrandIdType"],"type":"object"},"SBBrandedKeyword":{"properties":{"brandAlternateId":{"$ref":"#/components/schemas/SBBrandAlternateId"},"keyword":{"description":"Branded keyword","type":"string"}},"required":["brandAlternateId","keyword"],"type":"object"},"SBBrandedKeywordList":{"properties":{"associatedBrandIds":{"description":"Brand IDs associated with the branded keyword list","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"brandedKeyword":{"description":"Branded keywords are specific words or phrases that include a company\u0027s brand name or a registered trademark of a brand","items":{"$ref":"#/components/schemas/SBBrandedKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SBBrandedKeywordRecommendationTypeDetails":{"properties":{"brandAlternateId":{"items":{"$ref":"#/components/schemas/SBBrandAlternateId"},"maxItems":1,"minItems":1,"type":"array"},"brandIds":{"description":"The brand ID to scope branded keyword recommendations for","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brandAlternateId"],"type":"object"},"SBCreateBrandAlternateId":{"description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandId":{"description":"The alternative brand identifier for the brandId.","type":"string"},"alternateBrandIdType":{"$ref":"#/components/schemas/SBAlternateBrandIdType"}},"required":["alternateBrandId","alternateBrandIdType"],"type":"object"},"SBCreateBrandedKeywordRecommendationTypeDetails":{"properties":{"brandAlternateId":{"items":{"$ref":"#/components/schemas/SBCreateBrandAlternateId"},"maxItems":1,"minItems":1,"type":"array"},"brandIds":{"description":"The brand ID to scope branded keyword recommendations for","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brandAlternateId"],"type":"object"},"SBCreateRecommendationRequest":{"properties":{"recommendations":{"items":{"$ref":"#/components/schemas/SBRecommendationCreate"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"SBCreateRecommendationTypeDetails":{"oneOf":[{"properties":{"brandedKeywordRecommendationTypeDetails":{"$ref":"#/components/schemas/SBCreateBrandedKeywordRecommendationTypeDetails"}},"required":["brandedKeywordRecommendationTypeDetails"],"title":"brandedKeywordRecommendationTypeDetails","type":"object"}]},"SBObjectSettings":{"oneOf":[{"properties":{"brandedKeywordList":{"$ref":"#/components/schemas/SBBrandedKeywordList"}},"required":["brandedKeywordList"],"title":"brandedKeywordList","type":"object"}]},"SBRecommendation":{"properties":{"recommendationId":{"description":"The identifier of the recommendation","type":"string"},"recommendationType":{"description":"A unique value to indicate similar recommendations, used for internal purposes only","type":"string"},"recommendationTypeDetails":{"$ref":"#/components/schemas/SBRecommendationTypeDetails"},"recommendedObjects":{"description":"The target objects of the recommendation","items":{"$ref":"#/components/schemas/SBRecommendedObject"},"maxItems":10,"minItems":1,"type":"array"}},"required":["recommendationId","recommendationType","recommendedObjects"],"type":"object"},"SBRecommendationCreate":{"properties":{"recommendationType":{"description":"A unique value to indicate similar recommendations, used for internal purposes only","type":"string"},"recommendationTypeDetails":{"$ref":"#/components/schemas/SBCreateRecommendationTypeDetails"}},"required":["recommendationType"],"type":"object"},"SBRecommendationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SBRecommendationMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"SBRecommendationMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"},"recommendation":{"$ref":"#/components/schemas/SBRecommendation"}},"required":["index","recommendation"],"type":"object"},"SBRecommendationTypeDetails":{"oneOf":[{"properties":{"brandedKeywordRecommendationTypeDetails":{"$ref":"#/components/schemas/SBBrandedKeywordRecommendationTypeDetails"}},"required":["brandedKeywordRecommendationTypeDetails"],"title":"brandedKeywordRecommendationTypeDetails","type":"object"}]},"SBRecommendationTypeEnum":{"description":"The unique identifier of the recommendation type. Used to classify and group similar recommendations (e.g. \u0027BRANDED_KEYWORD\u0027).\n**RecommendationTypeEnum Enum:**\n| RecommendationTypeEnum | Description |\n| --- | --- |\n| `BRANDED_KEYWORD` | Suggests branded keywords for advertiser campaigns based on associated brands. Requires BrandedKeywordRecommendationTypeDetails to scope suggestions by brand alternate IDs. |","enum":["BRANDED_KEYWORD"],"type":"string"},"SBRecommendedObject":{"description":"Details of the recommended object","properties":{"recommendedObjectSettings":{"$ref":"#/components/schemas/SBObjectSettings"}},"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"SB Recommendations API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/recommendations/sb":{"post":{"description":"Create recommendations\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"SBCreateRecommendation","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBCreateRecommendationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SBRecommendationMultiStatusResponse"}}},"description":"SBCreateRecommendation 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Recommendations"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}