{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AlternateBrandIdType":{"description":"\u003cp\u003eThe type of identifier for the alternate brand identifier.\n\u003cstrong\u003eAlternateBrandIdType Enum:\u003c/strong\u003e\n| AlternateBrandIdType | Description |\n| --- | --- |\n| \u003ccode\u003eLINEAR_TV_ID\u003c/code\u003e | Linear TV measurement provider brand identifier. Used to determine brand eligibility for Complete TV campaigns. |\u003c/p\u003e","enum":["LINEAR_TV_ID"],"type":"string"},"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"},"Brand":{"properties":{"brandAlternateIds":{"description":"\u003cp\u003eOther types of brand identifiers for the brand that are used with other operations.\u003c/p\u003e","items":{"$ref":"#/components/schemas/BrandAlternateId"},"maxItems":100,"minItems":0,"type":"array"},"brandId":{"description":"\u003cp\u003eThe unique identifier for a brand.\u003c/p\u003e","type":"string"},"brandLogos":{"description":"\u003cp\u003eLogos of the brand.\u003c/p\u003e","items":{"$ref":"#/components/schemas/BrandLogo"},"maxItems":100,"minItems":0,"type":"array"},"brandName":{"description":"\u003cp\u003eDisplay name of the brand.\u003c/p\u003e","type":"string"},"brandStatus":{"$ref":"#/components/schemas/BrandStatus"},"brandWebsites":{"description":"\u003cp\u003eWebsites of the brand.\u003c/p\u003e","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["brandId","brandName","brandStatus"],"type":"object"},"BrandAdvertiserAssociation":{"properties":{"advertiserAccountId":{"description":"\u003cp\u003eThe identifier of the advertiser account in the relationship.\u003c/p\u003e","type":"string"},"associationStatus":{"$ref":"#/components/schemas/BrandAdvertiserAssociationStatus"},"brandAssociationId":{"description":"\u003cp\u003eThe unique identifier for a brand advertiser association.\u003c/p\u003e","type":"string"},"brandId":{"description":"\u003cp\u003eThe identifier of the brand in the relationship.\u003c/p\u003e","type":"string"},"relationship":{"$ref":"#/components/schemas/BrandAdvertiserRelationshipType"}},"required":["advertiserAccountId","associationStatus","brandAssociationId","brandId","relationship"],"type":"object"},"BrandAdvertiserAssociationStatus":{"description":"\u003cp\u003eThe current status of the brand to advertiser relationship.\n\u003cstrong\u003eBrandAdvertiserAssociationStatus Enum:\u003c/strong\u003e\n| BrandAdvertiserAssociationStatus | Description |\n| --- | --- |\n| \u003ccode\u003ePENDING_REVIEW\u003c/code\u003e | The requested relationship is under review by Amazon. |\n| \u003ccode\u003eNOT_APPROVED\u003c/code\u003e | The requested relationship has not been approved by Amazon. |\n| \u003ccode\u003eAPPROVED\u003c/code\u003e | The requested relationship has been created successfully. |\u003c/p\u003e","enum":["APPROVED","NOT_APPROVED","PENDING_REVIEW"],"type":"string"},"BrandAdvertiserRelationshipType":{"description":"\u003cp\u003eThe relationship between the brand and the advertiser account.\n\u003cstrong\u003eBrandAdvertiserRelationshipType Enum:\u003c/strong\u003e\n| BrandAdvertiserRelationshipType | Description |\n| --- | --- |\n| \u003ccode\u003eOWNER\u003c/code\u003e | The advertiser is the owner or employee of the brand. |\n| \u003ccode\u003eRESELLER\u003c/code\u003e | The advertiser is a reseller for the brand. |\n| \u003ccode\u003eADVERTISER\u003c/code\u003e | The advertiser is known to advertise for a brand, but no legal documentation is available. |\u003c/p\u003e","enum":["ADVERTISER","OWNER","RESELLER"],"type":"string"},"BrandAlternateId":{"description":"\u003cp\u003eOther types of brand identifiers for a brand that are used with other operations.\u003c/p\u003e","properties":{"alternateBrandId":{"description":"\u003cp\u003eThe alternative brand identifier for the brandId.\u003c/p\u003e","type":"string"},"alternateBrandIdType":{"$ref":"#/components/schemas/AlternateBrandIdType"},"countryCode":{"description":"\u003cp\u003eThe country where the alternate brand identifier is valid.\u003c/p\u003e","type":"string"}},"required":["alternateBrandId","alternateBrandIdType","countryCode"],"type":"object"},"BrandLogo":{"description":"\u003cp\u003eMetadata for a brand logo.\u003c/p\u003e","properties":{"brandLogoAssetId":{"description":"\u003cp\u003eAdvertising Asset Library Id for a brand logo.\u003c/p\u003e","type":"string"}},"type":"object"},"BrandMultiStatusSuccess":{"properties":{"brand":{"$ref":"#/components/schemas/Brand"},"index":{"maximum":99,"minimum":0,"type":"number"}},"required":["brand","index"],"type":"object"},"BrandStatus":{"description":"\u003cp\u003eThe current status of the brand.\n\u003cstrong\u003eBrandStatus Enum:\u003c/strong\u003e\n| BrandStatus | Description |\n| --- | --- |\n| \u003ccode\u003ePENDING_REVIEW\u003c/code\u003e | The brand creation request is under review by Amazon. |\n| \u003ccode\u003eNOT_APPROVED\u003c/code\u003e | The brand creation request has not been approved by Amazon. |\n| \u003ccode\u003eREGISTERED\u003c/code\u003e | The brand has been created successfully. |\n| \u003ccode\u003eSUSPENDED\u003c/code\u003e | The brand has been suspended. |\n| \u003ccode\u003eMERGED\u003c/code\u003e | The brand has been merged with another brand. |\u003c/p\u003e","enum":["MERGED","NOT_APPROVED","PENDING_REVIEW","REGISTERED","SUSPENDED"],"type":"string"},"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":"\u003cp\u003e\u003cstrong\u003eErrorCode Enum:\u003c/strong\u003e\n| ErrorCode | Description |\n| --- | --- |\n| \u003ccode\u003eINTERNAL_ERROR\u003c/code\u003e | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| \u003ccode\u003eUNAUTHORIZED\u003c/code\u003e | The request lacks the necessary credentials. |\n| \u003ccode\u003eFORBIDDEN\u003c/code\u003e | The caller is not authorized to make the given request. |\n| \u003ccode\u003eTOO_MANY_REQUESTS\u003c/code\u003e | There have been too many requests, please slow down your call rate. |\n| \u003ccode\u003eCONTENT_TOO_LARGE\u003c/code\u003e | The request is too large. Consider splitting it into multiple requests. |\n| \u003ccode\u003eNOT_FOUND\u003c/code\u003e | The requested resource does not exist. |\n| \u003ccode\u003eBAD_REQUEST\u003c/code\u003e | The request is not valid considering the documented schema. |\u003c/p\u003e","enum":["BAD_REQUEST","CONTENT_TOO_LARGE","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"maximum":99,"minimum":0,"type":"number"}},"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"},"QueryBrandAdvertiserAssociationRequestContent":{"properties":{"maxResults":{"maximum":100,"minimum":1,"type":"number"},"nextToken":{"type":"string"}},"type":"object"},"QueryBrandAdvertiserAssociationResponseContent":{"properties":{"brandAdvertiserAssociations":{"items":{"$ref":"#/components/schemas/BrandAdvertiserAssociation"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"RetrieveBrandRequestContent":{"properties":{"brandIds":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["brandIds"],"type":"object"},"RetrieveBrandResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/BrandMultiStatusSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"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":{}},"info":{"description":"Retrieve and curate advertiser brand relationships.","title":"BrandAidV2","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/brandAdvertiserAssociations":{"post":{"description":"\u003cp\u003eQuery brands associated to an advertiser account.\u003c/p\u003e\n\n**Authorized resource type**:\nGlobal Ad Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_view\"]\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\"]","operationId":"QueryBrandAdvertiserAssociation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandAdvertiserAssociationRequestContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandAdvertiserAssociationResponseContent"}}},"description":"QueryBrandAdvertiserAssociation 200 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"}}}},"/adsApi/v1/retrieve/brands":{"post":{"description":"\u003cp\u003eGet brand details for the specified brand identifiers.\u003c/p\u003e\n\n**Requires one of these permissions**:\n[]","operationId":"RetrieveBrand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBrandRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBrandResponseContent"}}},"description":"RetrieveBrand 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"}}}}}}