{"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"},"AdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"priceType":{"$ref":"#/components/schemas/AdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"required":["currencyCode","priceType","value"],"type":"object"},"AdvertisingDealPriceType":{"description":"**AdvertisingDealPriceType Enum:**\n| AdvertisingDealPriceType | Description |\n| --- | --- |\n| `FLAT_FEE` | This value is deprecated. Please use FIXED_PRICE. |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `FIXED_CPM` | Fixed cost per thousand impressions. Buyer pays this exact CPM for every impression won. Used for PREFERRED and PROGRAMMATIC_GUARANTEED deals. |\n| `FLOOR_RATE` | Minimum bid price for auction. Buyer must bid at or above this floor to compete. Used for PRIVATE_AUCTION deals. |","enum":["FIXED_CPM","FIXED_PRICE","FLAT_FEE","FLOOR_RATE"],"type":"string"},"AdvertisingDealTerms":{"description":"Terms for a deal. Supports PA \u0026 PD deals along with both spend-based guarantees (standard PG) and share-of-voice based guarantees (PG-SOV).","properties":{"budget":{"$ref":"#/components/schemas/MonetaryBudget"},"guaranteed":{"description":"If true, deal is PG Deal.","type":"boolean"},"impressions":{"description":"Representing the number of impressions for the deal. If the deal is guaranteed, this number should be provided. If the deal is non-guaranteed, this can be used to indicate how many impressions can be expected for the deal (as guidance).","format":"int32","type":"integer"},"marketplaceDeal":{"description":"If true, deal is available to all Amazon DSP entities globally. Marketplace deals cannot be edited by individual buyers.","type":"boolean"},"price":{"$ref":"#/components/schemas/AdvertisingDealPrice"},"shareOfVoicePercentage":{"description":"Guaranteed Share-of-voice Percentage of the advertising deal. Used for SOV-based PG deals. Value must be \u003e 0 and \u003c\u003d 100. Mutually exclusive with budget.","format":"double","type":"number"}},"required":["guaranteed","marketplaceDeal","price"],"type":"object"},"AdvertisingDealType":{"enum":["PREFERRED","PRIVATE_AUCTION","PROGRAMMATIC_GUARANTEED","SHARE_OF_VOICE"],"type":"string"},"AmazonMediaProposedDealExtension":{"description":"Amazon Media specific proposed deal attributes.","properties":{"brandName":{"description":"The brand name associated with the deals buyer.","pattern":"^[ -:\u003c-z|]+$","type":"string"},"productCategoryId":{"description":"A list of ADSP product categories. Only required for PG deals.","items":{"type":"string"},"maxItems":49,"minItems":0,"type":"array"}},"type":"object"},"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"},"CountryCode":{"enum":["AD","AE","AF","AG","AI","AU","BR","CA","DE","ES","FR","GB","IT","JP","KR","MX","US"],"type":"string"},"CurrencyCode":{"description":"**CurrencyCode Enum:**\n| CurrencyCode | Description |\n| --- | --- |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `JPY` | Japanese Yen |\n| `KRW` | South Korean Won |\n| `MXN` | Mexican Peso |\n| `USD` | United States Dollar |","enum":["AUD","BRL","CAD","EUR","GBP","JPY","KRW","MXN","USD"],"type":"string"},"DayOfWeek":{"description":"**DayOfWeek Enum:**\n| DayOfWeek | Description |\n| --- | --- |\n| `MONDAY` | Monday. |\n| `TUESDAY` | Tuesday. |\n| `WEDNESDAY` | Wednesday. |\n| `THURSDAY` | Thursday. |\n| `FRIDAY` | Friday. |\n| `SATURDAY` | Saturday. |\n| `SUNDAY` | Sunday. |","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"],"type":"string"},"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. |","enum":["BAD_REQUEST","FORBIDDEN","INTERNAL_ERROR","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"},"MonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"ruleValue":{"description":"The monetary amount of the budget when a budget rule is applied.","format":"double","type":"number"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NoteOrigin":{"enum":["BUYER","SUPPLIER"],"type":"string"},"Notes":{"description":"Notes for an object with origin information.","properties":{"note":{"description":"The note content.","type":"string"},"origin":{"$ref":"#/components/schemas/NoteOrigin"}},"required":["note","origin"],"type":"object"},"QuerySupplierProposedDealHistoricalVersionRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SupplierProposedDealHistoricalVersionAdProductFilter"},"maxResults":{"default":50,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"supplierProposalDestinationIdFilter":{"$ref":"#/components/schemas/SupplierProposedDealHistoricalVersionSupplierProposalDestinationIdFilter"},"supplierProposedDealIdFilter":{"$ref":"#/components/schemas/SupplierProposedDealHistoricalVersionSupplierProposedDealIdFilter"}},"required":["adProductFilter","supplierProposalDestinationIdFilter","supplierProposedDealIdFilter"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"State":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**State Enum:**\n| State | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `PROPOSED` | Indicates an entity staged for review and adoption by advertisers. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","enum":["ARCHIVED","DRAFT","PROPOSED"],"type":"string"},"SubmissionFailure":{"description":"Information about submission failure.","properties":{"failures":{"description":"List of submission failure details.","items":{"$ref":"#/components/schemas/SubmissionFailureField"},"maxItems":49,"minItems":0,"type":"array"},"traceId":{"description":"Trace identifier for the submission failure.","type":"string"}},"type":"object"},"SubmissionFailureField":{"description":"Details of a specific submission failure.","properties":{"code":{"description":"The failure code.","type":"string"},"message":{"description":"The failure message.","type":"string"}},"type":"object"},"SupplierAppTarget":{"description":"Target based on a specified app ID.","properties":{"groupId":{"description":"The string identifying a group of apps. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add apps to a new group, choose any string not currently being used on this ad group. To add apps to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The app to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierArchiveReason":{"enum":["CREATED_ACCIDENTALLY","CREATED_FOR_TESTING","DUPLICATE","NEGOTIATIONS_TERMINATED","NOT_DELIVERING","PROLONGED_PAUSE","UNDERDELIVERING"],"type":"string"},"SupplierAudienceAgeTarget":{"description":"Target based on a specified audience age ID.","properties":{"groupId":{"description":"The string identifying a group of audience ages. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience ages to a new group, choose any string not currently being used on this ad group. To add audience ages to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience age to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceEducationTarget":{"description":"Target based on a specified audience education ID.","properties":{"groupId":{"description":"The string identifying a group of audience educations. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience educations to a new group, choose any string not currently being used on this ad group. To add audience educations to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience education to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceGenderTarget":{"description":"Target based on a specified audience gender ID.","properties":{"groupId":{"description":"The string identifying a group of audience genders. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience genders to a new group, choose any string not currently being used on this ad group. To add audience genders to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience gender to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceHomeownershipTarget":{"description":"Target based on a specified audience homeownership ID.","properties":{"groupId":{"description":"The string identifying a group of audience homeownerships. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience homeownerships to a new group, choose any string not currently being used on this ad group. To add audience homeownerships to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience homeownership to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceHouseholdCompositionTarget":{"description":"Target based on a specified audience household composition ID.","properties":{"groupId":{"description":"The string identifying a group of audience household compositions. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience household compositions to a new group, choose any string not currently being used on this ad group. To add audience household compositions to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience household composition to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceHouseholdIncomeTarget":{"description":"Target based on a specified audience household income ID.","properties":{"groupId":{"description":"The string identifying a group of audience household incomes. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience household incomes to a new group, choose any string not currently being used on this ad group. To add audience household incomes to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience household income to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceInMarketTarget":{"description":"Target based on a specified audience in-market ID.","properties":{"groupId":{"description":"The string identifying a group of audience in-market segments. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience in-market segments to a new group, choose any string not currently being used on this ad group. To add audience in-market segments to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience in-market segment to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceInterestsTarget":{"description":"Target based on a specified audience interest ID.","properties":{"groupId":{"description":"The string identifying a group of audience interests. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience interests to a new group, choose any string not currently being used on this ad group. To add audience interests to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience interest to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceMaritalStatusTarget":{"description":"Target based on a specified audience marital status ID.","properties":{"groupId":{"description":"The string identifying a group of audience marital statuses. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience marital statuses to a new group, choose any string not currently being used on this ad group. To add audience marital statuses to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience marital status to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceMoodTarget":{"description":"Target based on a specified audience mood ID.","properties":{"groupId":{"description":"The string identifying a group of audience moods. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience moods to a new group, choose any string not currently being used on this ad group. To add audience moods to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience mood to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceSocioeconomicGroupTarget":{"description":"Target based on a specified audience socioeconomic group ID.","properties":{"groupId":{"description":"The string identifying a group of audience socioeconomic groups. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience socioeconomic groups to a new group, choose any string not currently being used on this ad group. To add audience socioeconomic groups to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience socioeconomic group to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierContentCategoryTarget":{"description":"Target based on a specified content category ID.","properties":{"groupId":{"description":"The string identifying a group of content categories. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content categories to a new group, choose any string not currently being used on this ad group. To add content categories to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content category to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierContentGenreTarget":{"description":"Target based on a specified content genre ID.","properties":{"groupId":{"description":"The string identifying a group of content genres. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content genres to a new group, choose any string not currently being used on this ad group. To add content genres to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content genre to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierContentRatingTarget":{"description":"Target based on a specified content rating ID.","properties":{"groupId":{"description":"The string identifying a group of content ratings. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content ratings to a new group, choose any string not currently being used on this ad group. To add content ratings to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content rating to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierContentSensitiveCategoryTarget":{"description":"Target based on a specified content sensitive category ID.","properties":{"groupId":{"description":"The string identifying a group of content sensitive categories. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content sensitive categories to a new group, choose any string not currently being used on this ad group. To add content sensitive categories to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content sensitive category to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDayPartDayTarget":{"description":"Target based on a specified daypart day ID.","properties":{"groupId":{"description":"The string identifying a group of daypart days. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add daypart days to a new group, choose any string not currently being used on this ad group. To add daypart days to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The daypart day to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDayPartTarget":{"description":"Supplier target based on time of day.","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"timeOfDay":{"$ref":"#/components/schemas/TimeOfDay"},"timeZoneType":{"$ref":"#/components/schemas/SupplierTargetingDaypartTimezoneType"}},"required":["dayOfWeek","timeOfDay"],"type":"object"},"SupplierDayPartTimeTarget":{"description":"Target based on a specified daypart time ID.","properties":{"groupId":{"description":"The string identifying a group of daypart times. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add daypart times to a new group, choose any string not currently being used on this ad group. To add daypart times to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The daypart time to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDeviceOperatingSystemTarget":{"description":"Target based on a specified device operating system ID.","properties":{"groupId":{"description":"The string identifying a group of device operating systems. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add device operating systems to a new group, choose any string not currently being used on this ad group. To add device operating systems to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The device operating system to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDeviceTypeTarget":{"description":"Target based on a specified device type ID.","properties":{"groupId":{"description":"The string identifying a group of device types. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add device types to a new group, choose any string not currently being used on this ad group. To add device types to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The device type to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierGroupDetails":{"oneOf":[{"properties":{"supplierLocationGroup":{"$ref":"#/components/schemas/SupplierLocationGroup"}},"required":["supplierLocationGroup"],"title":"supplierLocationGroup","type":"object"}]},"SupplierGroupType":{"enum":["LOCATION"],"type":"string"},"SupplierLocationGroup":{"description":"Location group details for supplier.","properties":{"onlyUseRealTimeLocation":{"description":"Only use real-time location for this group. Targeting customers based on home location may deliver when they travel and their real-time location is outside the targeted locations. This can lead to discrepancies with internal or external reports that validate location based on the real-time location. This setting may not be available to select if the selected supplier ad product requires using a specific value.","type":"boolean"}},"type":"object"},"SupplierLocationTarget":{"description":"Location target for supplier. Multiple locations can be used.","properties":{"supplierTargetItemId":{"description":"The geo location values to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierPositionVideoTarget":{"description":"Target based on a specified video position ID.","properties":{"groupId":{"description":"The string identifying a group of video positions. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add video positions to a new group, choose any string not currently being used on this ad group. To add video positions to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The video position to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierProposedDealExtension":{"oneOf":[{"properties":{"amazonMediaProposedDealExtension":{"$ref":"#/components/schemas/AmazonMediaProposedDealExtension"}},"required":["amazonMediaProposedDealExtension"],"title":"amazonMediaProposedDealExtension","type":"object"}]},"SupplierProposedDealHistoricalVersion":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertiserAccountId":{"description":"The ADSP advertiserId for this proposal. If advertiserId is null, then we treat it as manager account level proposal.","type":"string"},"countries":{"description":"The country for the proposed deal.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":49,"minItems":0,"type":"array"},"creationDateTime":{"description":"The date time that the proposed deal was created.","format":"date-time","type":"string"},"dealName":{"description":"The name of the deal.","pattern":"^[ -:\u003c-z|]+$","type":"string"},"dealStatus":{"$ref":"#/components/schemas/SupplierProposedDealStatus"},"dealType":{"$ref":"#/components/schemas/AdvertisingDealType"},"description":{"description":"The description of the deal.","type":"string"},"endDateTime":{"description":"The delivery end date.","format":"date-time","type":"string"},"externalDealId":{"description":"The supplier\u0027s deal id for this proposed deal.","type":"string"},"isBuyerApproved":{"description":"Whether the buyer has approved the proposed deal.","type":"boolean"},"isSupplierApproved":{"description":"Whether the seller has approved the proposed deal.","type":"boolean"},"lastUpdatedDateTime":{"description":"The date time that the proposed deal was last updated.","format":"date-time","type":"string"},"notes":{"description":"User provided notes for this proposed deal.","items":{"$ref":"#/components/schemas/Notes"},"maxItems":49,"minItems":0,"type":"array"},"proposalVersion":{"description":"The supplier_proposal version corresponding to this proposed deal version.","format":"int32","type":"integer"},"startDateTime":{"description":"The delivery start date.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"stateReason":{"$ref":"#/components/schemas/SupplierStateReason"},"submissionFailure":{"$ref":"#/components/schemas/SubmissionFailure"},"supplierAdProductId":{"description":"The supplier ad product unique identifier.","type":"string"},"supplierProposalDestinationId":{"description":"The supplier proposal destination id for this deal.","type":"string"},"supplierProposalId":{"description":"This proposed deal\u0027s associated supplier_proposal unique id.","type":"string"},"supplierProposedDealExtension":{"$ref":"#/components/schemas/SupplierProposedDealExtension"},"supplierProposedDealHistoricalVersionId":{"$ref":"#/components/schemas/SupplierProposedDealHistoricalVersionIdentifier"},"supplierProposedDealType":{"$ref":"#/components/schemas/SupplierProposedDealType"},"targeting":{"description":"Supplier targeting configuration.","items":{"$ref":"#/components/schemas/SupplierTargetGroup"},"maxItems":49,"minItems":0,"type":"array"},"terms":{"$ref":"#/components/schemas/AdvertisingDealTerms"},"version":{"description":"The version number of the proposed deal.","format":"int32","type":"integer"}},"required":["creationDateTime","dealName","dealStatus","dealType","endDateTime","lastUpdatedDateTime","startDateTime","supplierProposalId","supplierProposedDealExtension","supplierProposedDealHistoricalVersionId","terms"],"type":"object"},"SupplierProposedDealHistoricalVersionAdProductFilter":{"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"},"SupplierProposedDealHistoricalVersionIdentifier":{"description":"Composite identifier for proposed deal historical version.","properties":{"supplierProposedDealId":{"description":"The proposed deal identifier.","type":"string"},"version":{"description":"The version number of the proposed deal.","format":"int32","type":"integer"}},"required":["supplierProposedDealId","version"],"type":"object"},"SupplierProposedDealHistoricalVersionSuccessResponse":{"properties":{"nextToken":{"type":"string"},"supplierProposedDealHistoricalVersions":{"items":{"$ref":"#/components/schemas/SupplierProposedDealHistoricalVersion"},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"SupplierProposedDealHistoricalVersionSupplierProposalDestinationIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierProposedDealHistoricalVersionSupplierProposedDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierProposedDealStatus":{"description":"**SupplierProposedDealStatus Enum:**\n| SupplierProposedDealStatus | Description |\n| --- | --- |\n| `APPROVED` | The deal has been submitted and approved by the supplier and added to the ADSP for use. |\n| `APPROVED_CURRENT` | The deal is the current approved version after a revision was approved. |\n| `APPROVED_PENDING_REGISTRATION` | The deal has been submitted and approved by the supplier, but is in the process of being made targetable in the ADSP. |\n| `CANCELLED` | The deal has been canceled in both ADSPs and the supplier\u0027s systems. |\n| `COUNTER_DRAFT` | The deal is a counter draft. |\n| `DRAFT` | The deal has not yet been submitted to the supplier and may be edited. |\n| `DRAFT_REVISION` | The deal is a draft revision of an approved deal and may be edited. |\n| `ERROR` | Something has gone wrong during the submission of the deal and requires intervention to recover. |\n| `PENDING` | [To Be Deprecated] The deal is waiting to be updated asynchronously and is not ready to be targeted. |\n| `REJECTED` | The deal was rejected for approval by the supplier, and may be edited before being resubmitted for approval. |\n| `REJECTED_REVISED` | A previously rejected deal that has since been modified by the customer and is ready to be resubmitted for approval. |\n| `REVISED` | The deal is a previous version that has been superseded by a newer approved revision. |\n| `REVISION_APPROVED_PENDING_REGISTRATION` | The revision of the deal has been submitted and approved by the supplier, but is in the process of being made targetable in the ADSP. |\n| `SELLER_RESPONDED` | The seller responded with a new deal. Waiting for buyer\u0027s decision. |\n| `SUBMITTED` | The deal is currently being evaluated for approval by the supplier. |\n| `SUBMITTED_REVISION` | The deal revision is currently being evaluated for approval by the supplier. |\n| `SUBMITTED_TERMINATE` | The deal is currently being evaluated for termination by the supplier. |\n| `TERMINATED` | A deal has been submitted and terminated by the supplier and ingested into the ADSP to reflect the change. |\n| `TERMINATED_PENDING_REGISTRATION` | A deal has been submitted and terminated by the supplier, but is in the process of being made reflected in the ADSP. |","enum":["APPROVED","APPROVED_CURRENT","APPROVED_PENDING_REGISTRATION","CANCELLED","COUNTER_DRAFT","DRAFT","DRAFT_REVISION","ERROR","PENDING","REJECTED","REJECTED_REVISED","REVISED","REVISION_APPROVED_PENDING_REGISTRATION","SELLER_RESPONDED","SUBMITTED","SUBMITTED_REVISION","SUBMITTED_TERMINATE","TERMINATED","TERMINATED_PENDING_REGISTRATION"],"type":"string"},"SupplierProposedDealType":{"enum":["AMAZON_MEDIA"],"type":"string"},"SupplierStateReason":{"description":"Additional context for a resource\u0027s lifecycle state.","properties":{"archiveReason":{"$ref":"#/components/schemas/SupplierArchiveReason"},"description":{"description":"A free text description providing context for the state.","type":"string"}},"type":"object"},"SupplierTarget":{"description":"Marketplace targeting configuration.","properties":{"negative":{"description":"Indicates whether the target is negative or not. Negative targeting allows advertisers to provide intent where they do not want to show ads. Please ensure that the supplier for this target supports negative targeting before setting to true. If this field is not present, then negative is assumed to be false (meaning that a target is inclusive by default).","type":"boolean"},"supplierTargetDetails":{"$ref":"#/components/schemas/SupplierTargetDetails"},"supplierTargetType":{"$ref":"#/components/schemas/SupplierTargetType"}},"required":["supplierTargetDetails","supplierTargetType"],"type":"object"},"SupplierTargetDetails":{"oneOf":[{"properties":{"supplierAudienceTarget":{"$ref":"#/components/schemas/SupplierAudienceTarget"}},"required":["supplierAudienceTarget"],"title":"supplierAudienceTarget","type":"object"},{"properties":{"supplierAudienceAgeTarget":{"$ref":"#/components/schemas/SupplierAudienceAgeTarget"}},"required":["supplierAudienceAgeTarget"],"title":"supplierAudienceAgeTarget","type":"object"},{"properties":{"supplierAudienceGenderTarget":{"$ref":"#/components/schemas/SupplierAudienceGenderTarget"}},"required":["supplierAudienceGenderTarget"],"title":"supplierAudienceGenderTarget","type":"object"},{"properties":{"supplierAudienceInterestsTarget":{"$ref":"#/components/schemas/SupplierAudienceInterestsTarget"}},"required":["supplierAudienceInterestsTarget"],"title":"supplierAudienceInterestsTarget","type":"object"},{"properties":{"supplierAudienceMoodTarget":{"$ref":"#/components/schemas/SupplierAudienceMoodTarget"}},"required":["supplierAudienceMoodTarget"],"title":"supplierAudienceMoodTarget","type":"object"},{"properties":{"supplierAudienceInMarketTarget":{"$ref":"#/components/schemas/SupplierAudienceInMarketTarget"}},"required":["supplierAudienceInMarketTarget"],"title":"supplierAudienceInMarketTarget","type":"object"},{"properties":{"supplierAudienceHouseholdIncomeTarget":{"$ref":"#/components/schemas/SupplierAudienceHouseholdIncomeTarget"}},"required":["supplierAudienceHouseholdIncomeTarget"],"title":"supplierAudienceHouseholdIncomeTarget","type":"object"},{"properties":{"supplierAudienceEducationTarget":{"$ref":"#/components/schemas/SupplierAudienceEducationTarget"}},"required":["supplierAudienceEducationTarget"],"title":"supplierAudienceEducationTarget","type":"object"},{"properties":{"supplierAudienceHomeownershipTarget":{"$ref":"#/components/schemas/SupplierAudienceHomeownershipTarget"}},"required":["supplierAudienceHomeownershipTarget"],"title":"supplierAudienceHomeownershipTarget","type":"object"},{"properties":{"supplierAudienceHouseholdCompositionTarget":{"$ref":"#/components/schemas/SupplierAudienceHouseholdCompositionTarget"}},"required":["supplierAudienceHouseholdCompositionTarget"],"title":"supplierAudienceHouseholdCompositionTarget","type":"object"},{"properties":{"supplierAudienceMaritalStatusTarget":{"$ref":"#/components/schemas/SupplierAudienceMaritalStatusTarget"}},"required":["supplierAudienceMaritalStatusTarget"],"title":"supplierAudienceMaritalStatusTarget","type":"object"},{"properties":{"supplierAudienceSocioeconomicGroupTarget":{"$ref":"#/components/schemas/SupplierAudienceSocioeconomicGroupTarget"}},"required":["supplierAudienceSocioeconomicGroupTarget"],"title":"supplierAudienceSocioeconomicGroupTarget","type":"object"},{"properties":{"supplierLocationTarget":{"$ref":"#/components/schemas/SupplierLocationTarget"}},"required":["supplierLocationTarget"],"title":"supplierLocationTarget","type":"object"},{"properties":{"supplierDayPartTarget":{"$ref":"#/components/schemas/SupplierDayPartTarget"}},"required":["supplierDayPartTarget"],"title":"supplierDayPartTarget","type":"object"},{"properties":{"supplierDayPartDayTarget":{"$ref":"#/components/schemas/SupplierDayPartDayTarget"}},"required":["supplierDayPartDayTarget"],"title":"supplierDayPartDayTarget","type":"object"},{"properties":{"supplierDayPartTimeTarget":{"$ref":"#/components/schemas/SupplierDayPartTimeTarget"}},"required":["supplierDayPartTimeTarget"],"title":"supplierDayPartTimeTarget","type":"object"},{"properties":{"supplierContentCategoryTarget":{"$ref":"#/components/schemas/SupplierContentCategoryTarget"}},"required":["supplierContentCategoryTarget"],"title":"supplierContentCategoryTarget","type":"object"},{"properties":{"supplierContentGenreTarget":{"$ref":"#/components/schemas/SupplierContentGenreTarget"}},"required":["supplierContentGenreTarget"],"title":"supplierContentGenreTarget","type":"object"},{"properties":{"supplierContentRatingTarget":{"$ref":"#/components/schemas/SupplierContentRatingTarget"}},"required":["supplierContentRatingTarget"],"title":"supplierContentRatingTarget","type":"object"},{"properties":{"supplierContentSensitiveCategoryTarget":{"$ref":"#/components/schemas/SupplierContentSensitiveCategoryTarget"}},"required":["supplierContentSensitiveCategoryTarget"],"title":"supplierContentSensitiveCategoryTarget","type":"object"},{"properties":{"supplierDeviceTypeTarget":{"$ref":"#/components/schemas/SupplierDeviceTypeTarget"}},"required":["supplierDeviceTypeTarget"],"title":"supplierDeviceTypeTarget","type":"object"},{"properties":{"supplierDeviceOperatingSystemTarget":{"$ref":"#/components/schemas/SupplierDeviceOperatingSystemTarget"}},"required":["supplierDeviceOperatingSystemTarget"],"title":"supplierDeviceOperatingSystemTarget","type":"object"},{"properties":{"supplierPositionVideoTarget":{"$ref":"#/components/schemas/SupplierPositionVideoTarget"}},"required":["supplierPositionVideoTarget"],"title":"supplierPositionVideoTarget","type":"object"},{"properties":{"supplierAppTarget":{"$ref":"#/components/schemas/SupplierAppTarget"}},"required":["supplierAppTarget"],"title":"supplierAppTarget","type":"object"}]},"SupplierTargetGroup":{"properties":{"groupDetails":{"$ref":"#/components/schemas/SupplierGroupDetails"},"groupName":{"type":"string"},"groupTargets":{"items":{"$ref":"#/components/schemas/SupplierTarget"},"maxItems":49,"minItems":1,"type":"array"},"groupType":{"$ref":"#/components/schemas/SupplierGroupType"}},"required":["groupName","groupTargets"],"type":"object"},"SupplierTargetType":{"enum":["APP","AUDIENCE","AUDIENCE_AGE","AUDIENCE_EDUCATION","AUDIENCE_GENDER","AUDIENCE_HOMEOWNERSHIP","AUDIENCE_HOUSEHOLD_COMPOSITION","AUDIENCE_HOUSEHOLD_INCOME","AUDIENCE_INTERESTS","AUDIENCE_IN_MARKET","AUDIENCE_MARITAL_STATUS","AUDIENCE_MOOD","AUDIENCE_SOCIOECONOMIC_GROUP","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_RATING","CONTENT_SENSITIVE_CATEGORY","DAYPART","DAYPART_DAY","DAYPART_TIME","DEVICE_OPERATING_SYSTEM","DEVICE_TYPE","LOCATION_CITY","LOCATION_COUNTRY","LOCATION_DESIGNATED_MARKET_AREA","LOCATION_METRO","LOCATION_POSTAL_CODE","LOCATION_REGION","POSITION_VIDEO"],"type":"string"},"SupplierTargetingDaypartTimezoneType":{"description":"**SupplierTargetingDaypartTimezoneType Enum:**\n| SupplierTargetingDaypartTimezoneType | Description |\n| --- | --- |\n| `DEAL` | Set the daypart targeting to the timezone of the deal by the supplier |\n| `VIEWER` | Set the daypart targeting to the timezone of the viewer of the advertisement. |","enum":["DEAL","VIEWER"],"type":"string"},"TimeOfDay":{"properties":{"endTime":{"description":"Selected end time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"},"startTime":{"description":"Selected start time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"}},"required":["endTime","startTime"],"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":"SupplierProposedDealHistoricalVersions API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/supplierProposedDealHistoricalVersions":{"post":{"description":"Query supplier proposed deal historical versions\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QuerySupplierProposedDealHistoricalVersion","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySupplierProposedDealHistoricalVersionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierProposedDealHistoricalVersionSuccessResponse"}}},"description":"QuerySupplierProposedDealHistoricalVersion 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":["SupplierProposedDealHistoricalVersions"]}}},"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"}]}