{"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"}},"ManagerAccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Manager Account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AdProduct":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","enum":["AMAZON_DSP"],"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"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n| ErrorCode | Description |\n| --- | --- |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |","enum":["BAD_REQUEST","FIELD_VALUE_IS_INVALID","FIELD_VALUE_NOT_FOUND","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","RESOURCE_ID_NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"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"},"Publisher":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"isActive":{"description":"Whether this publisher is active.","type":"boolean"},"isConfidential":{"description":"Whether identity is confidential.","type":"boolean"},"name":{"description":"Normalized publisher name. NULL when isConfidential is true.","type":"string"},"publisherId":{"description":"The unique identifier of the publisher (Long serialized as String).","type":"string"},"publisherOwnerId":{"description":"The identifier of the company that owns this publisher\u0027s content rights.","type":"string"},"rootDomain":{"description":"Root domain from ads.txt. PSL+1 root. NULL for app-only publishers.","type":"string"}},"required":["adProduct","publisherId"],"type":"object"},"PublisherAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PublisherNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/PublisherNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"PublisherNameFilterType":{"description":"**PublisherNameFilterType Enum:**\n| PublisherNameFilterType | Description |\n| --- | --- |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH"],"type":"string"},"PublisherPublisherIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PublisherPublisherOwnerIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PublisherRootDomainFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/PublisherRootDomainFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"PublisherRootDomainFilterType":{"description":"**PublisherRootDomainFilterType Enum:**\n| PublisherRootDomainFilterType | Description |\n| --- | --- |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH"],"type":"string"},"PublisherSortOption":{"properties":{"by":{"$ref":"#/components/schemas/PublisherSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"PublisherSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| name | ASCENDING,DESCENDING |","enum":["name"],"type":"string"},"PublisherSuccessResponse":{"properties":{"nextToken":{"type":"string"},"publishers":{"items":{"$ref":"#/components/schemas/Publisher"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"QueryPublisherRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/PublisherAdProductFilter"},"maxResults":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/PublisherNameFilter"},"nextToken":{"type":"string"},"publisherIdFilter":{"$ref":"#/components/schemas/PublisherPublisherIdFilter"},"publisherOwnerIdFilter":{"$ref":"#/components/schemas/PublisherPublisherOwnerIdFilter"},"rootDomainFilter":{"$ref":"#/components/schemas/PublisherRootDomainFilter"},"sort":{"items":{"$ref":"#/components/schemas/PublisherSortOption"},"maxItems":1,"minItems":0,"type":"array"}},"required":["adProductFilter"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SortDirection":{"description":"**SortDirection Enum:**\n| SortDirection | Description |\n| --- | --- |\n| `ASCENDING` | Sort in ascending order |\n| `DESCENDING` | Sort in descending order |","enum":["ASCENDING","DESCENDING"],"type":"string"},"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":"Publishers API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/publishers":{"post":{"description":"Query publishers. A publisher is a business entity that operates the apps, sites, or video streams where ads are displayed. Use this API to search publishers by ID or name, for example to understand and compare where your ads run.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QueryPublisher","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPublisherRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublisherSuccessResponse"}}},"description":"QueryPublisher 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"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Publishers"]}}},"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"}]}