{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessDeniedErrorCode":{"enum":["ACCESS_DENIED"],"type":"string"},"AccessDeniedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/AccessDeniedErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"AdProduct":{"enum":["SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"],"type":"string"},"InternalErrorErrorCode":{"enum":["INTERNAL_ERROR"],"type":"string"},"InternalServerExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InternalErrorErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"InvalidArgumentErrorCode":{"enum":["INVALID_ARGUMENT"],"type":"string"},"InvalidArgumentExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"ListTargetableEntitiesRequestContent":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"locale":{"$ref":"#/components/schemas/Locale"},"maxResults":{"description":"Number of records to include in the paginated response.","maximum":250,"minimum":1,"type":"number"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"parentBrowseNodeIdFilter":{"description":"Filter by parent browse node IDs. Returns entities whose parent category matches any of the provided IDs.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"pathsFilter":{"description":"Get direct descendant sub paths that fall under the paths specified in the field value.\nThe value is a list of paths, where each object is a path hierarchy represented as a list of strings.\nFor Example: If you would like to get direct descendants under the path \"Apps \u0026 Games\"\nthen the field value would be [[\"Apps \u0026 Games\"]]","items":{"description":"Path hierarchy to filter on.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"maxItems":10,"minItems":0,"type":"array"},"productCategoryIdFilter":{"description":"Filter by product category IDs (browse node IDs). Returns entities matching any of the provided IDs.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"searchQueryFilter":{"description":"The query string used to filter targetable entities. Search for terms or phrases\nthat are relevant to your advertising goals. For example, if you sell running shoes,\nyou might search for \"Runners\", \"Athletic Apparel\", or \"Fitness Enthusiasts\" to find\nthe best targetable entities for your advertising goals.","type":"string"},"targetTypeFilter":{"description":"A list of targeting types. If an empty list is provided, it is equivalent\nto passing all targeting types.","items":{"$ref":"#/components/schemas/TargetType"},"maxItems":4,"minItems":0,"type":"array"}},"required":["adProduct"],"type":"object"},"ListTargetableEntitiesResponseContent":{"properties":{"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"targetableEntities":{"description":"The list of targetable entities.","items":{"$ref":"#/components/schemas/TargetableEntity"},"maxItems":250,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of entities.","type":"number"}},"type":"object"},"ListTargetableEntityPathsRequestContent":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"locale":{"$ref":"#/components/schemas/Locale"},"pathsFilter":{"description":"Get direct descendant sub paths that fall under the paths specified in the field value.\nThe value is a list of paths, where each object is a path hierarchy represented as a list of strings.\nFor Example: If you would like to get direct descendants under the path \"Apps \u0026 Games\"\nthen the field value would be [[\"Apps \u0026 Games\"]]","items":{"description":"Path hierarchy to filter on.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"maxItems":10,"minItems":0,"type":"array"}},"required":["adProduct"],"type":"object"},"ListTargetableEntityPathsResponseContent":{"properties":{"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"paths":{"description":"The direct descendants of the paths specified in the\nrequest\u0027s pathsFilter field.","items":{"description":"A path in Amazon\u0027s taxonomy.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"maxItems":10,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of entities.","type":"number"}},"type":"object"},"Locale":{"enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","en_ZA","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"],"type":"string"},"TargetType":{"description":"A targeting type","enum":["AUDIENCE","CONTENT_CATEGORY","PRODUCT_CATEGORY","PRODUCT_CATEGORY_AUDIENCE"],"type":"string"},"TargetableEntity":{"description":"A targetable entity.","properties":{"audienceId":{"description":"The identifier for a target of type AUDIENCE.","type":"string"},"audienceResolved":{"description":"The resolved name of audienceId.","type":"string"},"audienceTooltip":{"description":"The tooltip description to describe the amazon audience targetable entity.","type":"string"},"behaviouralTargetingEligibility":{"description":"The behavioural targeting eligibility for this browse node category.\nValues from Tamber browse-node-targeting-policy-validation dataset:\n\"All\" (eligible for behavioural targeting), \"None\" (not eligible).","type":"string"},"childCount":{"description":"The number of direct child categories.","type":"number"},"contentCategoryId":{"description":"The identifier for a target of type CONTENT_CATEGORY.","type":"string"},"contentCategoryResolved":{"description":"The resolved name of contentCategoryId.","type":"string"},"parentBrowseNodeId":{"description":"The browse node ID of the parent category.","type":"string"},"path":{"description":"The location of the targetable entity in Amazon\u0027s taxonomy.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"pathNodeIds":{"description":"The browse node IDs for each segment in the path hierarchy.","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"productCategoryId":{"description":"The identifier for a target of either type PRODUCT_CATEGORY or PRODUCT_CATEGORY_AUDIENCE.","type":"string"},"productCategoryResolved":{"description":"The resolved name of productCategoryId.","type":"string"},"targetType":{"$ref":"#/components/schemas/TargetType"}},"required":["path","targetType"],"type":"object"},"ThrottledErrorCode":{"enum":["THROTTLED"],"type":"string"},"ThrottlingExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ThrottledErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedErrorCode":{"description":"Error codes reported on top level exceptions\nthey correspond HTTP protocol level response codes","enum":["UNAUTHORIZED"],"type":"string"},"UnauthorizedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/UnauthorizedErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{}},"info":{"description":"Discover targetable entities","title":"Targetable Entities","version":"3.0"},"openapi":"3.0.1","paths":{"/targetableEntities/list":{"post":{"description":"\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListTargetableEntities","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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"in":"header","name":"Amazon-Advertising-AccountId","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.Mindreader.TargetableEntitiesResource.v1+json":{"schema":{"$ref":"#/components/schemas/ListTargetableEntitiesRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.Mindreader.TargetableEntitiesResource.v1+json":{"schema":{"$ref":"#/components/schemas/ListTargetableEntitiesResponseContent"}}},"description":"ListTargetableEntities 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}}}},"/targetableEntities/paths/list":{"post":{"description":"\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListTargetableEntityPaths","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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"in":"header","name":"Amazon-Advertising-AccountId","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.Mindreader.TargetableEntitiesResource.v1+json":{"schema":{"$ref":"#/components/schemas/ListTargetableEntityPathsRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.Mindreader.TargetableEntitiesResource.v1+json":{"schema":{"$ref":"#/components/schemas/ListTargetableEntityPathsResponseContent"}}},"description":"ListTargetableEntityPaths 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentExceptionResponseContent"}}},"description":"InvalidArgumentException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}}}}}}