{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"DspBadRequestExceptionResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrors"}]},"DspBadRequestExceptionV1ResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrorsV1"}]},"DspContextualDiscoveryStringArrayFilter":{"properties":{"exclude":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"DspContextualDiscoveryStringFilter":{"properties":{"exclude":{"type":"string"},"include":{"type":"string"}},"type":"object"},"DspForbiddenExceptionResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrors"}]},"DspInternalServerExceptionResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrors"}]},"DspNotFoundExceptionResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrors"}]},"DspSubError":{"description":"The sub error object.","properties":{"errorCode":{"type":"string"},"errorId":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"type":"object"},"DspSubErrorV1":{"description":"The sub error object.","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"type":"object"},"DspSubErrors":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":50,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspSubErrorsV1":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":50,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspTargetingTypesProductCategoryTargetingOptionsRequest":{"properties":{"country":{"description":"The ISO Alpha-2 code for your target marketplace country.\nUse a two-letter code to specify your desired location.\nExamples:\n- US - United States\n- UK - United Kingdom\n- DE - Germany\n- FR - France\n- IT - Italy\n","maxLength":2,"minLength":2,"type":"string"},"filters":{"description":"The filter property provides various options for filtering categories, including categoryName for fuzzy search on category name, browseNodeId for filtering by browse node (category) identifier, parentBrowseNodeId for retrieving immediate children of the specified browse node and filtering by eligibility of category which can be used for targeting or not. Different filters are combined using the AND operator, while multiple values within a filter are combined using the OR operator.","properties":{"browseNodeId":{"$ref":"#/components/schemas/DspContextualDiscoveryStringArrayFilter"},"categoryName":{"$ref":"#/components/schemas/DspContextualDiscoveryStringFilter"},"isEligible":{"type":"boolean"},"parentBrowseNodeId":{"$ref":"#/components/schemas/DspContextualDiscoveryStringArrayFilter"}},"type":"object"},"maxResults":{"default":"50","description":"Maximum number of items to fetch. Actual number returned may be less but never more.","maximum":200,"minimum":1,"type":"integer"},"nextToken":{"description":"A token representing the state of the pagination for the results. Use this token in subsequent request to fetch the next set of results. If this field is not provided, the API returns the first set of results.","type":"string"},"sortBy":{"default":"CATEGORY_NAME","description":"Field to sort by. \n- CATEGORY_NAME: sorts results alphabetically based on the categoryName field\n- RELEVANCE: sorts results based on relevance to search filters (most useful when using text-based filters like categoryName)\n  - DESC: most relevant results first (recommended for search scenarios)\n  - ASC: least relevant results first\n","enum":["CATEGORY_NAME","RELEVANCE"],"type":"string"},"sortOrder":{"default":"ASC","description":"Sort order.","enum":["ASC","DESC"],"type":"string"}},"required":["country"],"type":"object"},"DspTargetingTypesProductCategoryTargetingOptionsRequestV1":{"properties":{"filters":{"description":"The filter property provides various options for filtering categories, including categoryName for fuzzy search on category name, browseNodeId for filtering by browse node (category) identifier, parentBrowseNodeId for retrieving immediate children of the specified browse node and filtering by eligibility of category which can be used for targeting or not. Different filters are combined using the AND operator, while multiple values within a filter are combined using the OR operator.","properties":{"browseNodeId":{"$ref":"#/components/schemas/StringArrayFilterV1"},"categoryName":{"$ref":"#/components/schemas/StringFilterV1"},"isEligible":{"type":"boolean"},"parentBrowseNodeId":{"$ref":"#/components/schemas/StringArrayFilterV1"}},"type":"object"},"maxResults":{"default":"50","description":"Maximum number of items to fetch. Actual number returned may be less but never more.","maximum":200,"minimum":1,"type":"integer"},"nextToken":{"description":"A token representing the state of the pagination for the results. Use this token in subsequent request to fetch the next set of results. If this field is not provided, the API returns the first set of results.","type":"string"},"sortBy":{"default":"CATEGORY_NAME","description":"Field to sort by.","enum":["CATEGORY_NAME"],"type":"string"},"sortOrder":{"default":"ASC","description":"Sort order.","enum":["ASC","DESC"],"type":"string"}},"type":"object"},"DspTargetingTypesProductCategoryTargetingOptionsResponse":{"properties":{"nextToken":{"description":"A token used for pagination. Pagination token allows to fetch further results matching filter criteria.","type":"string"},"targetOptions":{"items":{"properties":{"eligibility":{"description":"Eligibility of given category on whether category can be used for targeting or not.","properties":{"isEligible":{"description":"Whether category is eligible or not to use for targeting.","type":"boolean"},"targetingEligibility":{"description":"The targeting type allowed for the product category. See the [universal targeting API](https://advertising.amazon.com/API/docs/en-us/dsp-universal-targeting) documentation for the specific matchTypes applicable to each targeting type.\n\n| Value | Description |\n|-------|-------------|\n| CONTEXTUAL | Categories which can only be targeted contextually |\n| MULTISIGNAL | Categories which can be targeted both behaviourally and contextually |\n","enum":["CONTEXTUAL","MULTISIGNAL"],"type":"string"}},"type":"object"},"metadata":{"properties":{"browseNodeId":{"description":"Unique identifier of browse node (category).","type":"string"},"categoryName":{"description":"Title of category.","type":"string"},"childCount":{"description":"The number of direct child nodes under this browse node (category). Returns 0 if the node has no children.","type":"number"},"parentBrowseNodeId":{"description":"Parent browse node identifier.","type":"string"},"pathNodeIds":{"description":"The hierarchical path from the root browse node to this node, represented as a sequence of browse node IDs.","items":{"description":"A browse node ID in the path from the root browse node.","type":"string"},"maxItems":20,"minItems":1,"type":"array"},"pathNodeNames":{"description":"The hierarchical path from the root browse node to this node, represented as a sequence of category names.","type":"string"}},"type":"object"}},"type":"object"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"DspTargetingTypesProductCategoryTargetingOptionsResponseV1":{"properties":{"nextToken":{"description":"A token used for pagination. Pagination token allows to fetch further results matching filter criteria.","type":"string"},"targetOptions":{"items":{"properties":{"eligibility":{"description":"Eligibility of given category on whether category can be used for targeting or not.","properties":{"isEligible":{"description":"Whether category is eligible or not to use for contextual targeting.","type":"boolean"}},"type":"object"},"metadata":{"properties":{"browseNodeId":{"description":"Unique identifier of browse node (category).","type":"string"},"categoryName":{"description":"Title of category.","type":"string"},"parentBrowseNodeId":{"description":"Parent browse node identifier.","type":"string"}},"type":"object"}},"type":"object"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"DspTargetingTypesProductTargetingOptionsRequest":{"properties":{"country":{"description":"The ISO Alpha-2 code for your target marketplace country.\nUse a two-letter code to specify your desired location.\nExamples:\n- US - United States\n- UK - United Kingdom\n- DE - Germany\n- FR - France\n- IT - Italy\n","maxLength":2,"minLength":2,"type":"string"},"filters":{"description":"\u003cul\u003e\u003cli\u003eAn array of filter objects used to refine the search results . Filters are combined using the AND operator, while multiple values within a filter are combined using the OR operator.\u003c/li\u003e\u003cli\u003eShould provide \u0027asin\u0027 or \u0027title\u0027 or both filters and one of them at least should contain non-empty \u0027include\u0027 attribute.\u003c/li\u003e\u003cli\u003eIf \u0027title\u0027 used in \u0027filters\u0027 then \u0027paginationToken\u0027 will be null\u003c/li\u003e\u003c/ul\u003e","properties":{"asin":{"$ref":"#/components/schemas/DspContextualDiscoveryStringArrayFilter"},"isEligible":{"type":"boolean"},"title":{"$ref":"#/components/schemas/DspContextualDiscoveryStringFilter"}},"type":"object"},"maxResults":{"default":"50","description":"Maximum number of items to fetch. Actual number returned may be less but never more.","maximum":50,"minimum":1,"type":"integer"},"nextToken":{"description":"A token representing the state of the pagination for the results. Use this token in subsequent request to fetch the next set of results. If this field is not provided, the API returns the first set of results.","type":"string"},"sortBy":{"default":"TITLE","description":"Field to sort by.","enum":["TITLE"],"type":"string"},"sortOrder":{"default":"ASC","description":"Sort order.","enum":["ASC","DESC"],"type":"string"}},"required":["country","filters"],"type":"object"},"DspTargetingTypesProductTargetingOptionsRequestV1":{"properties":{"filters":{"description":"\u003cul\u003e\u003cli\u003eAn array of filter objects used to refine the search results . Filters are combined using the AND operator, while multiple values within a filter are combined using the OR operator.\u003c/li\u003e\u003cli\u003eShould provide \u0027asin\u0027 or \u0027title\u0027 or both filters and one of them at least should contain non-empty \u0027include\u0027 attribute.\u003c/li\u003e\u003cli\u003eIf \u0027title\u0027 used in \u0027filters\u0027 then \u0027paginationToken\u0027 will be null\u003c/li\u003e\u003c/ul\u003e","properties":{"asin":{"$ref":"#/components/schemas/StringArrayFilterV1"},"isEligible":{"type":"boolean"},"title":{"$ref":"#/components/schemas/StringFilterV1"}},"type":"object"},"maxResults":{"default":"50","description":"Maximum number of items to fetch. Actual number returned may be less but never more.","maximum":50,"minimum":1,"type":"integer"},"nextToken":{"description":"A token representing the state of the pagination for the results. Use this token in subsequent request to fetch the next set of results. If this field is not provided, the API returns the first set of results.","type":"string"},"sortBy":{"default":"TITLE","description":"Field to sort by.","enum":["TITLE"],"type":"string"},"sortOrder":{"default":"ASC","description":"Sort order.","enum":["ASC","DESC"],"type":"string"}},"required":["filters"],"type":"object"},"DspTargetingTypesProductTargetingOptionsResponse":{"properties":{"nextToken":{"description":"A token representing the state of the pagination for the results. Use this token in subsequent request to fetch the next set of results. If nextToken value is null it means result is exhausted.","type":"string"},"targetOptions":{"items":{"properties":{"eligibility":{"description":"Eligibility of given product on whether product can be used for targeting or not.","properties":{"isEligible":{"description":"Whether product is eligible or not to use for targeting.","type":"boolean"},"targetingEligibility":{"description":"The targeting type allowed for the product. See the [universal targeting API](https://advertising.amazon.com/API/docs/en-us/dsp-universal-targeting) documentation for the specific matchTypes applicable to each targeting type.\n\n| Value | Description |\n|-------|-------------|\n| CONTEXTUAL | Products which can only be targeted contextually |\n| MULTISIGNAL | Products which can be targeted both behaviourally and contextually |\n","enum":["CONTEXTUAL","MULTISIGNAL"],"type":"string"}},"type":"object"},"metadata":{"properties":{"asin":{"description":"Amazon Standard Identification Number (ASIN) is a ten-digit alphanumeric code that identifies products on Amazon.","type":"string"},"categoryName":{"description":"The product category or subcategory in which the product is classified.","type":"string"},"imageUrl":{"description":"The URL of the product\u0027s main image.","type":"string"},"title":{"description":"The title or name of the product.","type":"string"}},"type":"object"}},"type":"object"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"DspTargetingTypesProductTargetingOptionsResponseV1":{"properties":{"nextToken":{"description":"A token representing the state of the pagination for the results. Use this token in subsequent request to fetch the next set of results. If nextToken value is null it means result is exhausted.","type":"string"},"targetOptions":{"items":{"properties":{"eligibility":{"description":"Eligibility of given product on whether product can be used for targeting or not.","properties":{"isEligible":{"description":"Whether product is eligible or not to use for contextual targeting.","type":"boolean"}},"type":"object"},"metadata":{"properties":{"asin":{"description":"Amazon Standard Identification Number (ASIN) is a ten-digit alphanumeric code that identifies products on Amazon.","type":"string"},"categoryName":{"description":"The product category or subcategory in which the product is classified.","type":"string"},"customerReview":{"description":"An object containing information about customer reviews and ratings for the product.","properties":{"rating":{"description":"The average rating of the product, based on customer reviews.","maximum":5,"minimum":0,"type":"number"},"reviewCount":{"properties":{"displayString":{"description":"A formatted string representing the number of customer reviews for the product.","type":"string"},"value":{"description":"The total number of customer reviews for the product.","type":"number"}},"type":"object"}},"type":"object"},"imageUrl":{"description":"The URL of the product\u0027s main image.","type":"string"},"price":{"description":"An object containing pricing information for the product.","properties":{"currency":{"description":"The currency code (ISO 4217) in which the product\u0027s price is denominated.","type":"string"},"displayString":{"description":"A formatted string representing the product\u0027s price.","type":"string"},"max":{"description":"The maximum price of the product, if it has a price range.","type":"number"},"min":{"description":"The minimum price of the product, if it has a price range.","type":"number"}},"type":"object"},"productBrandName":{"description":"The brand or manufacturer of the product.","type":"string"},"title":{"description":"The title or name of the product.","type":"string"}},"type":"object"}},"type":"object"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"DspTooManyRequestsExceptionResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrors"}]},"DspUnauthorizedExceptionResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrors"}]},"DspUnsupportedMediaTypeExceptionResponseContent":{"allOf":[{"$ref":"#/components/schemas/DspSubErrors"}]},"StringArrayFilterV1":{"properties":{"exclude":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"StringFilterV1":{"properties":{"exclude":{"type":"string"},"include":{"type":"string"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"Through Amazon\u0027s retail taxonomy of over 40K product categories, advertisers can select specific Amazon Products (ASINs) or Categories (Browse Nodes), and express the type of content where they want their ads shown on Amazon.com and 3rd party supply. These APIs provide all available products and categories available for use in the [targets endpoint](https://advertising.amazon.com/API/docs/en-us/dsp-universal-targeting).","title":"Discovery - Product and Product Category","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/v1/productCategories/list":{"post":{"description":"Creates a list of categories that can be used for targeting in Amazon DSP campaigns.  The API supports various filters to refine the search results, and it returns the matching categories based on the specified filters.  The response includes relevant metadata, such as browseNodeId and categoryName, and eligibility information for each category.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","externalDocs":{"description":"See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.","url":"https://advertising.amazon.com/dsp/help"},"operationId":"dspContextualTargetingProductCategoryOptionsV1","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","type":"string"}},{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}}],"requestBody":{"content":{"application/vnd.dspproductcategories.v1+json":{"examples":{"example1":{"value":{"filters":{"categoryName":{"include":"Electronics"}},"maxResults":10,"sortBy":"CATEGORY_NAME","sortOrder":"ASC"}},"example2":{"value":{"filters":{"categoryName":{"include":"Electronics"},"isEligible":true},"maxResults":5,"sortBy":"CATEGORY_NAME","sortOrder":"DESC"}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductCategoryTargetingOptionsRequestV1"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspproductcategories.v1+json":{"examples":{"responseExample1":{"value":{"nextToken":"next_token_value","targetOptions":[{"eligibility":{"isEligible":"true"},"metadata":{"browseNodeId":"54321","categoryName":"Electronics","parentBrowseNodeId":"56789"}},{"eligibility":{"isEligible":"false"},"metadata":{"browseNodeId":"65433","categoryName":"Car Electronics","parentBrowseNodeId":"56789"}}]}},"responseExample2":{"value":{"nextToken":"next_token_value","targetOptions":[{"eligibility":{"isEligible":"true"},"metadata":{"browseNodeId":"54321","categoryName":"Electronics","parentBrowseNodeId":"56789"}},{"eligibility":{"isEligible":"true"},"metadata":{"browseNodeId":"65432","categoryName":"Kids\u0027 Electronics","parentBrowseNodeId":"56789"}}]}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductCategoryTargetingOptionsResponseV1"}}},"description":"Success response."},"400":{"content":{"application/vnd.badrequest.v1+json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionV1ResponseContent"}}},"description":"Bad Request - Request either contains invalid parameters or is malformed."},"401":{"content":{"application/vnd.unauthorized.v1+json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.forbidden.v1+json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.notfound.v1+json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.unsupportedmediatype.v1+json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.toomanyrequests.v1+json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.internalservererror.v1+json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"summary":"List product category options which will be used for targeting.","tags":["ProductCategory Discovery"]}},"/dsp/v1/products/list":{"post":{"description":"Creates a list of product options that can be used for targeting in Amazon DSP campaigns.  The API allows you to refine the search results using various filters, such as title, ASIN, and eligibility.  The response includes product metadata, such as ASIN, title, brand, category, imageUrl, customerReview, price and eligibility information for each product.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","externalDocs":{"description":"See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.","url":"https://advertising.amazon.com/dsp/help"},"operationId":"dspContextualTargetingProductOptionsV1","parameters":[{"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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","type":"string"}},{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}}],"requestBody":{"content":{"application/vnd.dspproducts.v1+json":{"examples":{"example1":{"value":{"filters":{"title":{"include":"smartphone"}},"maxResults":50,"sortBy":"TITLE","sortOrder":"DESC"}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductTargetingOptionsRequestV1"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspproducts.v1+json":{"examples":{"example1":{"value":{"nextToken":"next_token_value","targetOptions":[{"eligibility":{"isEligible":"true"},"metadata":{"asin":"B01N5KHFG9","categoryName":"Electronics","customerReview":{"rating":"4.2","reviewCount":{"displayString":"1,234 customer reviews","value":"1234"}},"imageUrl":"https://example.com/image.jpg","price":{"currency":"USD","displayString":"$299.99","max":"299.99","min":"299.99"},"productBrandName":"Example Brand","title":"Example Smartphone"}}]}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductTargetingOptionsResponseV1"}}},"description":"Success response."},"400":{"content":{"application/vnd.badrequest.v1+json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request - Request either contains invalid parameters or is malformed."},"401":{"content":{"application/vnd.unauthorized.v1+json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.forbidden.v1+json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.notfound.v1+json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.unsupportedmediatype.v1+json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.toomanyrequests.v1+json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.internalservererror.v1+json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"summary":"List product options to be used for targeting.","tags":["Product Discovery"]}},"/dsp/v2/productCategories/list":{"post":{"description":"Creates a list of categories that can be used for targeting in Amazon DSP campaigns.  The API supports various filters to refine the search results, and it returns the matching categories based on the specified filters.  The response includes relevant metadata, such as browseNodeId, categoryName, childCount, pathNodeNames, pathNodeIds and eligibility information for each category. The API response is limited to 10,000 results with pagination. A parentBrowseNodeId of -1 can be used to fetch all top-level categories.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","externalDocs":{"description":"See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.","url":"https://advertising.amazon.com/dsp/help"},"operationId":"dspContextualTargetingProductCategoryOptionsV2","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","type":"string"}},{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"country":"US","filters":{"categoryName":{"include":"Electronics"}},"maxResults":10,"sortBy":"CATEGORY_NAME","sortOrder":"ASC"}},"example2":{"value":{"country":"UK","filters":{"categoryName":{"include":"Electronics"},"isEligible":true},"maxResults":5,"sortBy":"CATEGORY_NAME","sortOrder":"DESC"}},"relevanceSearchExample":{"value":{"country":"US","filters":{"categoryName":{"include":"Pet Supplies"}},"maxResults":10,"sortBy":"RELEVANCE","sortOrder":"DESC"}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductCategoryTargetingOptionsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"responseExample1":{"value":{"nextToken":"next_token_value","targetOptions":[{"eligibility":{"isEligible":"true","targetingEligibility":"CONTEXTUAL"},"metadata":{"browseNodeId":"54321","categoryName":"Electronics","childCount":"2","parentBrowseNodeId":"56789","pathNodeIds":["54321","56789"],"pathNodeNames":"Electrical \u0026 Electronics/Electronics"}},{"eligibility":{"isEligible":"false","targetingEligibility":"CONTEXTUAL"},"metadata":{"browseNodeId":"65433","categoryName":"Car Electronics","childCount":"1","parentBrowseNodeId":"56789","pathNodeIds":["56789","65433"],"pathNodeNames":"Electrical \u0026 Electronics/Car Electronics"}},{"eligibility":{"isEligible":"false","targetingEligibility":"CONTEXTUAL"},"metadata":{"browseNodeId":"43211","categoryName":"Car Amplifier Battery Wiring \u0026 Terminals","childCount":"0","parentBrowseNodeId":"54322","pathNodeIds":["43211","54322","56789","65433"],"pathNodeNames":"Electrical \u0026 Electronics/Car Electronics/Car Electronics Accessories/Car Amplifier Battery Wiring \u0026 Terminals"}}]}},"responseExample2":{"value":{"nextToken":"next_token_value","targetOptions":[{"eligibility":{"isEligible":"true","targetingEligibility":"MULTISIGNAL"},"metadata":{"browseNodeId":"54321","categoryName":"Electronics","childCount":"2","parentBrowseNodeId":"56789","pathNodeIds":["54321","56789"],"pathNodeNames":"Electrical \u0026 Electronics/Electronics"}},{"eligibility":{"isEligible":"true","targetingEligibility":"CONTEXTUAL"},"metadata":{"browseNodeId":"65432","categoryName":"Kids\u0027 Electronics","childCount":"1","parentBrowseNodeId":"56789","pathNodeIds":["56789","65432"],"pathNodeNames":"Electrical \u0026 Electronics/Kids\u0027 Electronics"}}]}},"responseRelevanceSearchExample":{"value":{"nextToken":"next_token_value","targetOptions":[{"eligibility":{"isEligible":"true","targetingEligibility":"CONTEXTUAL"},"metadata":{"browseNodeId":"123412","categoryName":"Pet Supplies","childCount":"7","pathNodeIds":["123412"],"pathNodeNames":"Pet Supplies"}},{"eligibility":{"isEligible":"true","targetingEligibility":"MULTISIGNAL"},"metadata":{"browseNodeId":"65432","categoryName":"Pet Bird Supplies","childCount":"9","parentBrowseNodeId":"123412","pathNodeIds":["123412","65432"],"pathNodeNames":"Pet Supplies/Pet Bird Supplies"}}]}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductCategoryTargetingOptionsResponse"}}},"description":"Success response."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request - Request either contains invalid parameters or is malformed."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"summary":"List product category options which will be used for targeting.","tags":["ProductCategory Discovery"]}},"/dsp/v2/products/list":{"post":{"description":"Creates a list of product options that can be used for targeting in Amazon DSP campaigns.  The API allows you to refine the search results using various filters, such as title, ASIN, and eligibility.  The response includes product metadata, such as ASIN, title, brand, category, imageUrl, customerReview, price and eligibility information for each product.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","externalDocs":{"description":"See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.","url":"https://advertising.amazon.com/dsp/help"},"operationId":"dspContextualTargetingProductOptionsV2","parameters":[{"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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"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. For DSP profiles, the type field of the accountInfo object must be set to agency and the subType must not be AMAZON_ATTRIBUTION.","type":"string"}},{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account Identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"country":"US","filters":{"title":{"include":"smartphone"}},"maxResults":50,"sortBy":"TITLE","sortOrder":"DESC"}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductTargetingOptionsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"example1":{"value":{"nextToken":"next_token_value","targetOptions":[{"eligibility":{"isEligible":"true","targetingEligibility":"CONTEXTUAL"},"metadata":{"asin":"B01N5KHFG9","categoryName":"Electronics","imageUrl":"https://example.com/image.jpg","title":"Example Smartphone"}}]}}},"schema":{"$ref":"#/components/schemas/DspTargetingTypesProductTargetingOptionsResponse"}}},"description":"Success response."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request - Request either contains invalid parameters or is malformed."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"summary":"List product options to be used for targeting.","tags":["Product Discovery"]}}}}