{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AdGroupFrequencyGetV1":{"properties":{"frequencyType":{"$ref":"#/components/schemas/AdGroupFrequencyTypeV1"},"levelType":{"$ref":"#/components/schemas/AdGroupFrequencyLevelTypeGetV1"},"maxImpressions":{"description":"The maximum number of times an impression is served per user.","maximum":500,"minimum":1,"type":"number"},"timeUnit":{"$ref":"#/components/schemas/AdGroupFrequencyTimeUnitGetV1"},"timeUnitCount":{"description":"The count of time units.","maximum":60,"minimum":1,"type":"number"}},"required":["frequencyType"],"type":"object"},"AdGroupFrequencyLevelTypeGetV1":{"description":"The level unit.","enum":["HOUSEHOLD","USER"],"type":"string"},"AdGroupFrequencyLevelTypePutV1":{"description":"The level unit.","enum":["HOUSEHOLD","USER"],"type":"string"},"AdGroupFrequencyPutV1":{"properties":{"frequencyType":{"$ref":"#/components/schemas/AdGroupFrequencyTypeV1"},"levelType":{"$ref":"#/components/schemas/AdGroupFrequencyLevelTypePutV1"},"maxImpressions":{"description":"The maximum number of times an impression is served per user. Required when `frequencyType`\u003d`CUSTOM`.","maximum":500,"minimum":1,"type":"number"},"timeUnit":{"$ref":"#/components/schemas/AdGroupFrequencyTimeUnitPutV1"},"timeUnitCount":{"description":"The count of time units. Required when `frequencyType`\u003d`CUSTOM`.","maximum":60,"minimum":1,"type":"number"}},"required":["frequencyType"],"type":"object"},"AdGroupFrequencyTimeUnitGetV1":{"description":"The time unit.","enum":["DAYS","HOURS","MINUTES","OTHER"],"type":"string"},"AdGroupFrequencyTimeUnitPutV1":{"description":"The time unit.","enum":["DAYS","HOURS","MINUTES"],"type":"string"},"AdGroupFrequencyTypeV1":{"description":"The type of advertising frequency cap. If UNCAPPED, no other fields are used.","enum":["CUSTOM","UNCAPPED"],"type":"string"},"AmazonViewabilityGetV1":{"properties":{"includeUnmeasurableImpressions":{"description":"Must be false if `viewabilityTier` is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/ViewabilityTierGetV1"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"AmazonViewabilityPatchV1":{"properties":{"includeUnmeasurableImpressions":{"description":"Must be false if `viewabilityTier` is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/ViewabilityTierPatchV1"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"AmazonViewabilityPostV1":{"properties":{"includeUnmeasurableImpressions":{"description":"Must be false if `viewabilityTier` is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/ViewabilityTierPostV1"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"AutomatedAdGroupCreationSettingsV1":{"description":"[UNSUPPORTED] This field is no longer supported as Legacy Performance Plus has been deprecated, and all values will be ignored.","properties":{"performancePlus":{"$ref":"#/components/schemas/PerformancePlusV1"}},"type":"object"},"AutomatedTargetingTacticGetV1":{"description":"Represents a targeting strategy for adGroup which can be employed to drive better outcomes.","enum":["AWARENESS","MAXIMIZE_PERFORMANCE","OTHER","PROSPECTING","REMARKETING","RETENTION","SEARCH","UPPER_FUNNEL_PROSPECTING","WIN_BACK"],"type":"string"},"BidStrategyGetV1":{"description":"Specifies how we determine bids and budget on your behalf. It cannot be changed after the campaign starts.\u003cbr\u003e\u003cbr\u003e* SPEND_BUDGET_IN_FULL: Optimizes bidding to deliver budget in full over achieving the KPI target.\u003cbr\u003e* PRIORITIZE_KPI_TARGET: Optimizes bidding to achieve target KPI over budget delivery. Note that for legacy campaigns that lack a target KPI, we maximize performance based on the selected Goal KPI alone.\u003cbr\u003e* PRIORITIZE_BRAND_OUTCOME: Prioritize spending full budget while maximizing reach to high-intent users likely to engage.","enum":["OTHER","PRIORITIZE_KPI_TARGET","SPEND_BUDGET_IN_FULL"],"type":"string"},"BidStrategyPatchV1":{"description":"A bid strategy specifies how we determine bids on your behalf. It cannot be changed after the campaign starts. Required on creation of the campaign.\u003cbr\u003e\u003cbr\u003eSPEND_BUDGET_IN_FULL: Optimizes bidding to deliver budget in full over achieving the KPI target.\u003cbr\u003ePRIORITIZE_KPI_TARGET: Optimizes bidding to achieve target KPI over budget delivery. If you select this, monitor the campaign regularly to ensure sufficient budget delivery.\u003cbr\u003ePRIORITIZE_BRAND_OUTCOME: Prioritize spending full budget while maximizing reach to high-intent users likely to engage.","enum":["PRIORITIZE_KPI_TARGET","SPEND_BUDGET_IN_FULL"],"type":"string"},"BudgetCapsGetV1":{"properties":{"amount":{"description":"The spending limit amount.","format":"double","type":"number"},"currencyCode":{"description":"ISO 4217 standard currency code for all currency-related attributes.","type":"string"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/RecurrenceTimePeriodGetV1"}},"type":"object"},"BudgetCapsPutV1":{"properties":{"amount":{"description":"The spending limit expressed in the currency of the ad group.","format":"double","minimum":1,"type":"number"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/RecurrenceTimePeriodPutV1"}},"required":["amount","recurrenceTimePeriod"],"type":"object"},"CampaignBudgetCapGetV1":{"properties":{"amount":{"description":"The spending limit amount.","format":"double","type":"number"},"currencyCode":{"description":"ISO 4217 standard currency code for all currency-related attributes.","type":"string"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/CampaignRecurrenceTimePeriodGetV1"}},"type":"object"},"CampaignBudgetCapPutV1":{"properties":{"amount":{"description":"The spending limit amount.","format":"double","minimum":1,"type":"number"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/CampaignRecurrenceTimePeriodPutV1"}},"required":["amount","recurrenceTimePeriod"],"type":"object"},"CampaignFrequencyGetV1":{"properties":{"frequencyType":{"$ref":"#/components/schemas/CampaignFrequencyTypeV1"},"levelType":{"$ref":"#/components/schemas/CampaignFrequencyLevelTypeGetV1"},"maxImpressions":{"description":"The maximum number of times this campaign serves an impression to a user.","maximum":99000,"minimum":1,"type":"number"},"timeUnit":{"$ref":"#/components/schemas/CampaignFrequencyTimeUnitGetV1"},"timeUnitCount":{"description":"The count of time units.","maximum":60,"minimum":1,"type":"number"}},"required":["frequencyType"],"type":"object"},"CampaignFrequencyLevelTypeGetV1":{"description":"The level unit.","enum":["HOUSEHOLD","USER"],"type":"string"},"CampaignFrequencyLevelTypePutV1":{"description":"The level unit.","enum":["HOUSEHOLD","USER"],"type":"string"},"CampaignFrequencyPutV1":{"properties":{"frequencyType":{"$ref":"#/components/schemas/CampaignFrequencyTypeV1"},"levelType":{"$ref":"#/components/schemas/CampaignFrequencyLevelTypePutV1"},"maxImpressions":{"description":"The maximum number of times an impression is served per user.","maximum":99000,"minimum":1,"type":"number"},"timeUnit":{"$ref":"#/components/schemas/CampaignFrequencyTimeUnitPutV1"},"timeUnitCount":{"description":"The count of time units.","maximum":60,"minimum":1,"type":"number"}},"required":["frequencyType"],"type":"object"},"CampaignFrequencyTimeUnitGetV1":{"description":"The time unit.","enum":["DAYS","HOURS","MINUTES","OTHER"],"type":"string"},"CampaignFrequencyTimeUnitPutV1":{"description":"The time unit.","enum":["DAYS","HOURS","MINUTES"],"type":"string"},"CampaignFrequencyTypeV1":{"description":"The type of advertising frequency. If UNCAPPED, no other fields are used.","enum":["CUSTOM","UNCAPPED"],"type":"string"},"CampaignRecurrenceTimePeriodGetV1":{"enum":["DAILY","MONTHLY","OTHER"],"type":"string"},"CampaignRecurrenceTimePeriodPutV1":{"enum":["DAILY","MONTHLY"],"type":"string"},"ConversionSettings":{"description":"Structure defining weights for different conversion types in campaign optimization. Controls the weight attached to conversions in CPA calculations. For the initial launch, only binary weights (0.0 or 1.0) are allowed. Field is only applicable when goalSettings.kpi is CPA-related.","properties":{"viewWeight":{"description":"Weight applied to view conversions. For initial launch: 0.0 \u003d clicks only, 1.0 \u003d clicks and views. In the future, we will support all values between 0.0 and 1.0.","format":"double","type":"number"}},"type":"object"},"CreativeRotationTypeGetV1":{"description":"The creative rotation type. Applies to all creatives associated to the ad group.","enum":["OTHER","RANDOM","WEIGHTED"],"type":"string"},"CreativeRotationTypePatchV1":{"description":"The creative rotation type. Applies to all creatives associated to the ad group.","enum":["RANDOM","WEIGHTED"],"type":"string"},"CreativeRotationTypePostV1":{"description":"The creative rotation type. Applies to all creatives associated to the ad group.","enum":["RANDOM","WEIGHTED"],"type":"string"},"DefaultAudienceTargetingMatchTypeGetV1":{"description":"Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the ad group level, not at individual audience level. (Default: EXACT).\n* SIMILAR Reach more audiences who are similar to your included audiences (if any).\n* EXACT Target the exact audiences specified in the ad group audience targeting (if any).","enum":["EXACT","SIMILAR"],"type":"string"},"DefaultAudienceTargetingMatchTypePatchV1":{"description":"Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the ad group level, not at individual audience level. (Default: EXACT).\n* SIMILAR Reach more audiences who are similar to your included audiences (if any).\n* EXACT Target the exact audiences specified in the ad group audience targeting (if any).","enum":["EXACT","SIMILAR"],"type":"string"},"DefaultAudienceTargetingMatchTypePostV1":{"description":"Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the ad group level, not at individual audience level. (Default: EXACT).\n* SIMILAR Reach more audiences who are similar to your included audiences (if any).\n* EXACT Target the exact audiences specified in the ad group audience targeting (if any).","enum":["EXACT","SIMILAR"],"type":"string"},"DspAdGroupDeliveryStatusV1":{"description":"The system-derived delivery status.","enum":["CREATIVES_NOT_RUNNING","DELIVERING","ENDED","INACTIVE","OTHER","READY_TO_DELIVER"],"type":"string"},"DspAdGroupError":{"properties":{"index":{"type":"number"},"statusCode":{"type":"number"},"subErrors":{"items":{"$ref":"#/components/schemas/DspSubError"},"type":"array"}},"required":["index","subErrors"],"type":"object"},"DspAdGroupStateV1":{"description":"The user-defined activation status.","enum":["ACTIVE","INACTIVE"],"type":"string"},"DspAdGroupSuccess":{"description":"Success response","properties":{"adGroupId":{"type":"string"},"index":{"type":"number"}},"required":["index"],"type":"object"},"DspBadRequestExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspBatchPatchAdGroupV1RequestContent":{"description":"Updates one or more ad groups synchronously.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e","properties":{"adGroups":{"items":{"$ref":"#/components/schemas/DspPatchAdGroup"},"maxItems":20,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"DspBatchPatchAdGroupV1ResponseContent":{"description":"Multi-status. This holds arrays of items which represent success or failure corresponding to the\n    index in the request body","properties":{"error":{"description":"List of error operations","items":{"$ref":"#/components/schemas/DspAdGroupError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"},"success":{"description":"List of successful operations","items":{"$ref":"#/components/schemas/DspAdGroupSuccess"},"maxItems":100,"minItems":1,"type":"array"}},"required":["requestId"],"type":"object"},"DspBatchPatchCampaignV1RequestContent":{"description":"Updates one or more campaigns.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e","properties":{"campaigns":{"items":{"$ref":"#/components/schemas/DspPatchCampaign"},"maxItems":5,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"DspBatchPatchCampaignV1ResponseContent":{"description":"Multi-status. This holds arrays of items which represent success or failure corresponding to the\n    index in the request body","properties":{"error":{"description":"List of error operations","items":{"$ref":"#/components/schemas/DspCampaignError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"},"success":{"description":"List of successful operations","items":{"$ref":"#/components/schemas/DspCampaignSuccess"},"maxItems":100,"minItems":1,"type":"array"}},"required":["requestId"],"type":"object"},"DspBatchPostAdGroupV1RequestContent":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/DspPostAdGroup"},"maxItems":20,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"DspBatchPostAdGroupV1ResponseContent":{"description":"Multi-status. This holds arrays of items which represent success or failure corresponding to the\n    index in the request body","properties":{"error":{"description":"List of error operations","items":{"$ref":"#/components/schemas/DspAdGroupError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"},"success":{"description":"List of successful operations","items":{"$ref":"#/components/schemas/DspAdGroupSuccess"},"maxItems":100,"minItems":1,"type":"array"}},"required":["requestId"],"type":"object"},"DspBatchPostCampaignV1RequestContent":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/DspPostCampaign"},"maxItems":5,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"DspBatchPostCampaignV1ResponseContent":{"description":"Multi-status. This holds arrays of items which represent success or failure corresponding to the\n    index in the request body","properties":{"error":{"description":"List of error operations","items":{"$ref":"#/components/schemas/DspCampaignError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"},"success":{"description":"List of successful operations","items":{"$ref":"#/components/schemas/DspCampaignSuccess"},"maxItems":100,"minItems":1,"type":"array"}},"required":["requestId"],"type":"object"},"DspBidStrategyV1":{"description":"A bid strategy specifies how we determine bids on your behalf for each opportunity to serve an impression. We recommend using the campaign bid strategy. If the strategies differ, the campaign may under perform or it won\u0027t spend the full budget.\n\u003cp\u003eSPEND_BUDGET_IN_FULL: Our algorithm will focus on spending the full budget. Performance will be the second priority.\n\u003cp\u003ePRIORITIZE_KPI_TARGET: Optimizes bidding to achieve target KPI over budget delivery. If you select this, monitor the campaign regularly to ensure sufficient budget delivery. You must set a targetKPI on the campaign to select this option.\n\u003cp\u003eUSE_CAMPAIGN_STRATEGY: The ad group will inherit the campaigns bid strategy.","enum":["PRIORITIZE_KPI_TARGET","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"],"type":"string"},"DspCampaignDeliveryStatusV1":{"description":"The system-derived delivery status.","enum":["ADGROUPS_NOT_RUNNING","DELIVERING","ENDED","INACTIVE","OTHER","READY_TO_DELIVER","SUSPENDED"],"type":"string"},"DspCampaignError":{"properties":{"index":{"type":"number"},"statusCode":{"type":"number"},"subErrors":{"items":{"$ref":"#/components/schemas/DspSubError"},"type":"array"}},"required":["index","subErrors"],"type":"object"},"DspCampaignFlight":{"properties":{"flightId":{"type":"string"},"index":{"type":"number"}},"required":["index"],"type":"object"},"DspCampaignStateV1":{"description":"The user-defined activation status.","enum":["ACTIVE","INACTIVE"],"type":"string"},"DspCampaignSuccess":{"description":"Success response","properties":{"campaignId":{"type":"string"},"flights":{"items":{"$ref":"#/components/schemas/DspCampaignFlight"},"type":"array"},"index":{"type":"number"}},"required":["index"],"type":"object"},"DspConflictExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspCreateAdGroupBidRequestContentV1":{"properties":{"baseBid":{"description":"This is the ideal amount you\u0027d like to pay (per thousand impressions) for your ad inventory expressed in the currency of the campaign. This price isn\u0027t guaranteed, but we optimize the bidding strategy to try to meet this goal. This field is optional for ad groups that use automated bid optimization; when omitted, the system manages bidding on your behalf. It remains required when automated bid optimization is false, or if automated bid optimization is not available (e.g. programmatic guaranteed deal).","format":"double","type":"number"},"maxAverageCPM":{"description":"The maximum average cost per thousand impressions expressed in the currency of the campaign. If this field is left blank, we automatically optimize the CPM based on your budget and goals. This field is not required before an ad group can be published or activated.","format":"double","type":"number"}},"type":"object"},"DspCreateAdGroupOptimizationRequestContentV1":{"properties":{"automateBudgetAllocation":{"description":"Set to true to automatically allocate budgets to better performing ad groups based on your selected goal KPI. To opt into automatic budget optimization, this setting must be set to true at both the campaign and ad group levels. Set to false to manually allocate budget for this ad group.","type":"boolean"},"bidStrategy":{"$ref":"#/components/schemas/DspBidStrategyV1"},"dailyMinSpendAmount":{"description":"Denotes the daily minimum spend on the line item in local currency.","format":"double","type":"number"}},"required":["bidStrategy"],"type":"object"},"DspCreateAdGroupPacingV1":{"properties":{"catchUpBoostPercentage":{"description":"Available when deliveryProfile is \u0027EVEN\u0027. A catch up boost offsets any drops that may occur while ad groups are delivering during weekends, holidays, or other busy time periods. A 300 boost means ad groups can deliver up to three times faster than they normally would within their budget to catch up. A 0 means no boost will be applied. The only acceptable values are 0, 200, 300, and 400.","type":"number"},"deliveryProfile":{"$ref":"#/components/schemas/DspPatchAdGroupDeliveryProfileV1"}},"required":["catchUpBoostPercentage","deliveryProfile"],"type":"object"},"DspCreateCampaignFlight":{"properties":{"budgetAmount":{"description":"The total flight budget amount. Currency is derived from the advertiser level.","format":"double","minimum":1,"type":"number"},"endDateTime":{"description":"The flight end timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"name":{"description":"The flight name.","type":"string"},"startDateTime":{"description":"The flight start timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"}},"required":["budgetAmount","endDateTime","startDateTime"],"type":"object"},"DspCreateCampaignFlightsContent":{"properties":{"flights":{"items":{"$ref":"#/components/schemas/DspCreateCampaignFlight"},"maxItems":150,"minItems":1,"type":"array"}},"required":["flights"],"type":"object"},"DspCreateCampaignOptimizationRequestContentV1":{"properties":{"automateBudgetAllocation":{"description":"Set to `true` to automatically adjust budgets towards better performing ad groups based on your selected goal KPI. Set to `false` to manually allocate budget for ad groups in this campaign.","type":"boolean"},"automatedAdGroupCreationSettings":{"$ref":"#/components/schemas/AutomatedAdGroupCreationSettingsV1"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategyPatchV1"},"conversionSettings":{"$ref":"#/components/schemas/ConversionSettings"},"flightBudgetRolloverSetting":{"$ref":"#/components/schemas/FlightBudgetRolloverSettingV1"},"goalSetting":{"$ref":"#/components/schemas/GoalSettingCreateV1"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryTypePatchV1"},"type":"array"}},"required":["bidStrategy","goalSetting"],"type":"object"},"DspFeesV1":{"properties":{"agencyFeePercentage":{"description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can\u0027t be changed after an ad group has been added to a campaign. To nullify, send a value of 0.","format":"double","maximum":99,"minimum":0,"type":"number"}},"type":"object"},"DspForbiddenExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspGetAdGroup":{"properties":{"adGroupId":{"type":"string"},"advertisedProductCategoryIds":{"description":"We use categories to determine whether a campaign is eligible to run on a given set of inventory. These categories are used as metadata passed to ad exchanges. We recommend choosing a subcategory that best aligns with the products being advertised. When inventoryType\u003dVIDEO, sub-categories from only one parent product category are allowed. Retrieve product categories by using the GET operation for dsp/productCategories.","items":{"type":"string"},"type":"array"},"bid":{"$ref":"#/components/schemas/DspGetAdGroupBidRequestContentV1"},"budgetAmount":{"description":"The maximum budget allowed for the ad group expressed in the currency of the campaign. Total ad group spend will never exceed this amount.\u003cp\u003eRequired on initial creation if the campaign and ad group do not use automated budget optimization. This field must be omitted if the campaign and ad group use automated budget optimization.","format":"double","type":"number"},"budgetCaps":{"description":"The per day or per month spending limit. An empty array indicates that no budget caps are applied.","items":{"$ref":"#/components/schemas/BudgetCapsGetV1"},"type":"array"},"campaignId":{"description":"The campaign to which the ad group is associated.","type":"string"},"comments":{"description":"The ad group comments.","type":"string"},"creationDateTime":{"description":"The date the campaign was created. Time zone is always UTC.","format":"date-time","type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationTypeGetV1"},"deliveryStatus":{"$ref":"#/components/schemas/DspAdGroupDeliveryStatusV1"},"endDateTime":{"description":"The ad group end timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"fees":{"description":"The list of fees associated with the ad group.","items":{"$ref":"#/components/schemas/FeeGetV1"},"maxItems":100,"minItems":0,"type":"array"},"frequencies":{"description":"The maximum number of times an impression is served per user.","items":{"$ref":"#/components/schemas/AdGroupFrequencyGetV1"},"type":"array"},"inventoryType":{"$ref":"#/components/schemas/InventoryTypeGetV1"},"lastUpdatedDateTime":{"description":"The date the campaign was last updated. Time zone is always UTC.","format":"date-time","type":"string"},"name":{"description":"A name for the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/DspGetAdGroupOptimizationResponseContentV1"},"pacing":{"$ref":"#/components/schemas/DspGetAdGroupPacingV1"},"purchaseOrderNumber":{"description":"The purchase order number.","type":"string"},"startDateTime":{"description":"The ad group start timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DspAdGroupStateV1"},"targetingSettings":{"$ref":"#/components/schemas/TargetingSettingsGetV1"}},"required":["adGroupId"],"type":"object"},"DspGetAdGroupBidRequestContentV1":{"properties":{"baseBid":{"description":"This is the ideal amount you\u0027d like to pay (per thousand impressions) for your ad inventory. This price isn\u0027t guaranteed, but we optimize the bidding strategy to try to meet this goal.","format":"double","type":"number"},"currencyCode":{"description":"ISO 4217 standard currency code for all currency-related attributes.","type":"string"},"maxAverageCPM":{"description":"The maximum average cost per thousand impressions. If this field is left blank, we automatically optimize the CPM based on your budget and goals.","format":"double","type":"number"}},"type":"object"},"DspGetAdGroupDeliveryProfileV1":{"description":"Determines how the system will spend budget and deliver impressions over the ad group’s flight. The following options are available:\n\nEVEN: Even pacing spends your budget consistently across the length of the campaign. We recommend turning catch up boost off to ensure consistent delivery.\n\nPACE_AHEAD: Pace Ahead can deliver up to 25% more than the daily Even pace targets.\n\nASAP: Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there\u0027s no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately.\n\nSTRICT_EVEN: pacing spends your budget consistently across the length of the campaign.\n\nOTHER: Returned by GET operations as a substitute for values that are incompatible with the requested GET API version.","enum":["ASAP","EVEN","OTHER","PACE_AHEAD","STRICT_EVEN"],"type":"string"},"DspGetAdGroupOptimizationResponseContentV1":{"properties":{"automateBudgetAllocation":{"description":"Set to true to automatically allocate budgets to better performing ad groups based on your selected goal KPI. To opt into automatic budget optimization, this setting must be set to true at both the campaign and ad group levels. Set to false to manually allocate budget for this ad group.","type":"boolean"},"bidStrategy":{"$ref":"#/components/schemas/DspBidStrategyV1"},"dailyMinSpendAmount":{"description":"Denotes the daily minimum spend on the line item in local currency.","format":"double","type":"number"}},"type":"object"},"DspGetAdGroupPacingV1":{"properties":{"catchUpBoostPercentage":{"description":"Available when deliveryProfile is \u0027EVEN\u0027. A catch up boost offsets any drops that may occur while ad groups are delivering during weekends, holidays, or other busy time periods. A 300 boost means ad groups can deliver up to three times faster than they normally would within their budget to catch up. A 0 means no boost will be applied. The only acceptable values are 0, 200, 300, and 400.","type":"number"},"deliveryProfile":{"$ref":"#/components/schemas/DspGetAdGroupDeliveryProfileV1"}},"type":"object"},"DspGetCampaign":{"properties":{"advertiserId":{"description":"The advertiser to which the campaign is associated.","type":"string"},"budgetCaps":{"description":"The per day or per month spending limit. An empty array indicates that no budget caps are applied.","items":{"$ref":"#/components/schemas/CampaignBudgetCapGetV1"},"type":"array"},"campaignId":{"type":"string"},"comments":{"description":"The campaign comments.","type":"string"},"country":{"description":"The ISO Alpha-2 country code to which the campaign is associated.","type":"string"},"creationDateTime":{"description":"The date the campaign was created. Time zone is always UTC.","format":"date-time","type":"string"},"deliveryStatus":{"$ref":"#/components/schemas/DspCampaignDeliveryStatusV1"},"endDateTime":{"description":"The campaign end timestamp.","format":"date-time","type":"string"},"fees":{"$ref":"#/components/schemas/DspFeesV1"},"flights":{"items":{"$ref":"#/components/schemas/DspListCampaignFlight"},"type":"array"},"frequencies":{"description":"The maximum number of times this campaign serves an impression to a user.","items":{"$ref":"#/components/schemas/CampaignFrequencyGetV1"},"type":"array"},"lastUpdatedDateTime":{"description":"The date the campaign was last updated. Time zone is always UTC.","format":"date-time","type":"string"},"name":{"description":"A name for the campaign.","type":"string"},"optimization":{"$ref":"#/components/schemas/DspGetCampaignOptimizationOutputV1"},"purchaseOrderNumber":{"description":"The PO number associated to the campaign.","type":"string"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDateTime":{"description":"The campaign start timestamp.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DspCampaignStateV1"},"targetsAmazonDeal":{"description":"If the campaign is targeting an Amazon deal, the value will be true, and the campaign and ad group(s) will be read-only.","type":"boolean"}},"required":["campaignId"],"type":"object"},"DspGetCampaignOptimizationOutputV1":{"properties":{"automateBidAllocation":{"description":"Automatically adjust bids for impressions that are more likely to improve your selected goal KPI. This setting is on a path to deprecation. The value will be null for new campaigns.","type":"boolean"},"automateBudgetAllocation":{"description":"Set to true to automatically allocate budgets to better performing ad groups based on your selected goal KPI. To opt into automatic budget optimization, this setting must also be set to true at the ad group level. Set to false to manually allocate budget for ad groups under this campaign.","type":"boolean"},"automatedAdGroupCreationSettings":{"$ref":"#/components/schemas/AutomatedAdGroupCreationSettingsV1"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategyGetV1"},"conversionSettings":{"$ref":"#/components/schemas/ConversionSettings"},"flightBudgetRolloverSetting":{"$ref":"#/components/schemas/FlightBudgetRolloverSettingV1"},"goalSetting":{"$ref":"#/components/schemas/GoalSettingGetV1"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryTypeGetV1"},"type":"array"}},"type":"object"},"DspInternalServerExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspListAdGroupV1RequestContent":{"properties":{"adGroupIdFilter":{"description":"A comma-delimited list of ad group identifiers. Cannot be used with campaignIdFilter.","items":{"type":"string"},"type":"array"},"campaignIdFilter":{"description":"A comma-delimited list of campaign identifiers. Cannot be used with adGroupIdFilter.","items":{"type":"string"},"type":"array"},"includeRegional":{"description":"Flag to enable returning of adGroups related to cross region campaigns. Default false.","type":"boolean"},"maxResults":{"description":"Number of records to include in the paginated response.","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"To retrieve the next page of paginated results, specify this token in the request.","type":"string"}},"type":"object"},"DspListAdGroupV1ResponseContent":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/DspGetAdGroup"},"type":"array"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","type":"string"}},"type":"object"},"DspListCampaignFlight":{"properties":{"budgetAmount":{"description":"The total flight budget amount.","format":"double","type":"number"},"currencyCode":{"description":"ISO 4217 standard currency code for all currency-related campaign attributes.","type":"string"},"endDateTime":{"description":"The flight end date. When listing flights UTC time zone will be used.","format":"date-time","type":"string"},"flightId":{"description":"The flight identifier.","type":"string"},"name":{"description":"The flight name.","type":"string"},"startDateTime":{"description":"The flight start date. When listing flights UTC time zone will be used.","format":"date-time","type":"string"}},"type":"object"},"DspListCampaignV1RequestContent":{"properties":{"campaignIdFilter":{"description":"A comma-delimited list of campaign identifiers.","items":{"type":"string"},"type":"array"},"includeRegional":{"description":"Flag to enable returning of cross region campaigns. Default false.","type":"boolean"},"maxResults":{"description":"Number of records to include in the paginated response.","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"To retrieve the next page of paginated results, specify this token in the request.","type":"string"}},"type":"object"},"DspListCampaignV1ResponseContent":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/DspGetCampaign"},"type":"array"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","type":"string"}},"type":"object"},"DspNotFoundExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspPatchAdGroup":{"properties":{"adGroupId":{"type":"string"},"advertisedProductCategoryIds":{"description":"We use categories to determine whether a campaign is eligible to run on a given set of inventory. These categories are used as metadata passed to ad exchanges. We recommend choosing a subcategory that best aligns with the products being advertised. When inventoryType\u003dVIDEO, sub-categories from only one parent product category are allowed. Retrieve product categories by using the GET operation for dsp/productCategories.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"bid":{"$ref":"#/components/schemas/DspPatchAdGroupBidRequestContentV1"},"budgetAmount":{"description":"The maximum budget allowed for the ad group expressed in the currency of the campaign. Total ad group spend will never exceed this amount.\u003cp\u003eRequired on initial creation if the campaign and ad group do not use automated budget optimization. This field must be omitted if the campaign and ad group use automated budget optimization.","format":"double","type":"number"},"budgetCaps":{"description":"The per day or per month spending limit. You may have up to 1 DAILY and/or 1 MONTHLY cap. An empty array indicates that no budget caps are applied.","items":{"$ref":"#/components/schemas/BudgetCapsPutV1"},"maxItems":2,"minItems":0,"type":"array"},"comments":{"description":"The ad group comments. To nullify, set the value to an empty string.","type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationTypePatchV1"},"endDateTime":{"description":"The ad group end timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"fees":{"description":"Apply third-party data fees to the ad group to have fees displayed in reports.","items":{"$ref":"#/components/schemas/FeePatchV1"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"The maximum number of times an impression is served per user.","items":{"$ref":"#/components/schemas/AdGroupFrequencyPutV1"},"maxItems":3,"minItems":1,"type":"array"},"inventoryType":{"$ref":"#/components/schemas/InventoryTypePatchV1"},"name":{"description":"A name for the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/DspUpdateAdGroupOptimizationRequestContentV1"},"pacing":{"$ref":"#/components/schemas/DspPatchAdGroupPacingV1"},"purchaseOrderNumber":{"description":"The purchase order number. If you’re using an ID to track this order elsewhere, you can enter it here. It is commonly referred to as externalId. To nullify, set the value to an empty string.","type":"string"},"startDateTime":{"description":"The ad group start timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DspAdGroupStateV1"},"targetingSettings":{"$ref":"#/components/schemas/TargetingSettingsPatchV1"}},"required":["adGroupId"],"type":"object"},"DspPatchAdGroupBidRequestContentV1":{"properties":{"baseBid":{"description":"This is the ideal amount you\u0027d like to pay (per thousand impressions) for your ad inventory expressed in the currency of the campaign. This price isn\u0027t guaranteed, but we optimize the bidding strategy to try to meet this goal. This field is required on creation of an ad group but not on updates.","format":"double","type":"number"},"maxAverageCPM":{"description":"The maximum average cost per thousand impressions expressed in the currency of the campaign. If this field is left blank, we automatically optimize the CPM based on your budget and goals. To remove a value for this field, set the value to 0. This field is not required before an ad group can be published or activated.","format":"double","type":"number"}},"type":"object"},"DspPatchAdGroupDeliveryProfileV1":{"description":"Determines how the system will spend budget and deliver impressions over the ad group’s flight. The following options are available:\n\nEVEN: Even pacing spends your budget consistently across the length of the campaign. We recommend turning catch up boost off to ensure consistent delivery.\n\nPACE_AHEAD: Pace Ahead can deliver up to 25% more than the daily Even pace targets.\n\nASAP: Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there\u0027s no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately.\n\nSTRICT_EVEN: Strict even pacing spends your budget consistently across the length of the campaign.\n\nAllowed values when inventoryType is:\n\u003cul\u003e\n\u003cli\u003eAMAZON_MOBILE_DISPLAY: EVEN, PACE_AHEAD, ASAP\u003c/li\u003e\n\u003cli\u003eAAP_MOBILE_APP: EVEN, PACE_AHEAD, ASAP\u003c/li\u003e\n\u003cli\u003eSTANDARD_DISPLAY: EVEN, PACE_AHEAD, ASAP\u003c/li\u003e\n\u003cli\u003eVIDEO: EVEN, PACE_AHEAD, ASAP\u003c/li\u003e\n\u003cli\u003eAUDIO: EVEN, PACE_AHEAD, ASAP\u003c/li\u003e\n\u003cli\u003ePODCAST: STRICT_EVEN\u003c/li\u003e\n\u003c/ul\u003e","enum":["ASAP","EVEN","PACE_AHEAD","STRICT_EVEN"],"type":"string"},"DspPatchAdGroupPacingV1":{"properties":{"catchUpBoostPercentage":{"description":"Available when deliveryProfile is \u0027EVEN\u0027. A catch up boost offsets any drops that may occur while ad groups are delivering during weekends, holidays, or other busy time periods. A 300 boost means ad groups can deliver up to three times faster than they normally would within their budget to catch up. A 0 means no boost will be applied. The only acceptable values are 0, 200, 300, and 400.","type":"number"},"deliveryProfile":{"$ref":"#/components/schemas/DspPatchAdGroupDeliveryProfileV1"}},"type":"object"},"DspPatchCampaign":{"properties":{"budgetCaps":{"description":"The per day or per month spending limit. You may have up to 1 DAILY and/or 1 MONTHLY cap. An empty array indicates that no budget caps are applied.","items":{"$ref":"#/components/schemas/CampaignBudgetCapPutV1"},"maxItems":2,"minItems":0,"type":"array"},"campaignId":{"type":"string"},"comments":{"description":"The campaign comments. To nullify, set the value to an empty string.","maxLength":255,"minLength":0,"type":"string"},"fees":{"$ref":"#/components/schemas/DspFeesV1"},"flights":{"$ref":"#/components/schemas/DspPutCampaignFlightsContent"},"frequencies":{"description":"The maximum number of times this campaign serves an impression to a user.","items":{"$ref":"#/components/schemas/CampaignFrequencyPutV1"},"maxItems":3,"minItems":1,"type":"array"},"name":{"description":"A name for the campaign. This can’t be changed after the campaign ends.","maxLength":255,"minLength":1,"type":"string"},"optimization":{"$ref":"#/components/schemas/DspPatchCampaignOptimizationRequestContentV1"},"purchaseOrderNumber":{"description":"If you’re using an ID to track this order elsewhere, you can enter it here. It will be available in all dashboards and downloadable reports. This field is required if \"Mandatory PO numbers\" is set at the entity level. To nullify, set the value to an empty string.","maxLength":255,"minLength":0,"type":"string"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated. To nullify, set the value to an empty string.","maxLength":255,"minLength":0,"type":"string"},"state":{"$ref":"#/components/schemas/DspCampaignStateV1"}},"required":["campaignId"],"type":"object"},"DspPatchCampaignOptimizationRequestContentV1":{"properties":{"automateBudgetAllocation":{"description":"Set to true to automatically allocate budgets to better performing ad groups based on your selected goal KPI. To opt into automatic budget optimization, this setting must also be set to true at the ad group level. Set to false to manually allocate budget for ad groups under this campaign.","type":"boolean"},"automatedAdGroupCreationSettings":{"$ref":"#/components/schemas/AutomatedAdGroupCreationSettingsV1"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategyPatchV1"},"conversionSettings":{"$ref":"#/components/schemas/ConversionSettings"},"flightBudgetRolloverSetting":{"$ref":"#/components/schemas/FlightBudgetRolloverSettingV1"},"goalSetting":{"$ref":"#/components/schemas/GoalSettingPatchV1"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryTypePatchV1"},"type":"array"}},"type":"object"},"DspPostAdGroup":{"properties":{"advertisedProductCategoryIds":{"description":"We use categories to determine whether a campaign is eligible to run on a given set of inventory. These categories are used as metadata passed to ad exchanges. We recommend choosing a subcategory that best aligns with the products being advertised. When inventoryType\u003dVIDEO, sub-categories from only one parent product category are allowed. Retrieve product categories by using the GET operation for dsp/productCategories.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"bid":{"$ref":"#/components/schemas/DspCreateAdGroupBidRequestContentV1"},"budgetAmount":{"description":"The maximum budget allowed for the ad group expressed in the currency of the campaign. Total ad group spend will never exceed this amount.\u003cp\u003eRequired on initial creation if the campaign and ad group do not use automated budget optimization. This field must be omitted if the campaign and ad group use automated budget optimization.","format":"double","type":"number"},"budgetCaps":{"description":"The per day or per month spending limit. You may have up to 1 DAILY and/or 1 MONTHLY cap. An empty array indicates that no budget caps are applied.","items":{"$ref":"#/components/schemas/BudgetCapsPutV1"},"maxItems":2,"minItems":0,"type":"array"},"campaignId":{"description":"The campaign to which the ad group is associated.","type":"string"},"comments":{"description":"The ad group comments.","maxLength":255,"minLength":0,"type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationTypePostV1"},"endDateTime":{"description":"The ad group end timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"fees":{"description":"Apply third-party data fees to the ad group to have fees displayed in reports.","items":{"$ref":"#/components/schemas/FeePostV1"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"The maximum number of times an impression is served per user.","items":{"$ref":"#/components/schemas/AdGroupFrequencyPutV1"},"maxItems":3,"minItems":1,"type":"array"},"inventoryType":{"$ref":"#/components/schemas/InventoryTypePostV1"},"name":{"description":"A name for the ad group.","maxLength":255,"minLength":1,"type":"string"},"optimization":{"$ref":"#/components/schemas/DspCreateAdGroupOptimizationRequestContentV1"},"pacing":{"$ref":"#/components/schemas/DspCreateAdGroupPacingV1"},"purchaseOrderNumber":{"description":"The purchase order number. If you’re using an ID to track this order elsewhere, you can enter it here. It will be available in all dashboards and downloadable reports. For advertisers in Europe, this ID will be used as the PO number that appears in invoices. It is commonly referred to as externalId.","type":"string"},"startDateTime":{"description":"The ad group start timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"targetingSettings":{"$ref":"#/components/schemas/TargetingSettingsPostV1"}},"required":["advertisedProductCategoryIds","bid","campaignId","creativeRotationType","endDateTime","frequencies","inventoryType","name","optimization","pacing","startDateTime","targetingSettings"],"type":"object"},"DspPostCampaign":{"properties":{"advertiserId":{"description":"The advertiser to which the campaign is associated.","type":"string"},"budgetCaps":{"description":"The per day or per month spending limit. You may have up to 1 DAILY and/or 1 MONTHLY cap. An empty array indicates that no budget caps are applied.","items":{"$ref":"#/components/schemas/CampaignBudgetCapPutV1"},"maxItems":2,"minItems":0,"type":"array"},"comments":{"description":"The campaign comments.","maxLength":255,"minLength":0,"type":"string"},"country":{"description":"The ISO Alpha-2 country code to which the campaign is associated. If empty, advertiser must have a default country set.","type":"string"},"fees":{"$ref":"#/components/schemas/DspFeesV1"},"flights":{"$ref":"#/components/schemas/DspCreateCampaignFlightsContent"},"frequencies":{"description":"The maximum number of times this campaign serves an impression to a user.","items":{"$ref":"#/components/schemas/CampaignFrequencyPutV1"},"maxItems":3,"minItems":1,"type":"array"},"name":{"description":"A name for the campaign. This can’t be changed after the campaign ends.","maxLength":255,"minLength":1,"type":"string"},"optimization":{"$ref":"#/components/schemas/DspCreateCampaignOptimizationRequestContentV1"},"purchaseOrderNumber":{"description":"If you’re using an ID to track this order elsewhere, you can enter it here. It will be available in all dashboards and downloadable reports. This field is required if \"Mandatory PO numbers\" is set at the entity level.","maxLength":255,"minLength":0,"type":"string"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated. To nullify, set the value to an empty string.","maxLength":255,"minLength":0,"type":"string"}},"required":["advertiserId","flights","frequencies","name","optimization"],"type":"object"},"DspPutCampaignFlight":{"properties":{"budgetAmount":{"description":"The total flight budget amount. Currency is derived from the advertiser level.","format":"double","minimum":1,"type":"number"},"endDateTime":{"description":"The flight end timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"flightId":{"description":"The flight identifier. Only required when changing an existing flight.","type":"string"},"name":{"description":"The flight name.","type":"string"},"startDateTime":{"description":"The flight start timestamp. The format must be the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"}},"required":["budgetAmount","endDateTime","startDateTime"],"type":"object"},"DspPutCampaignFlightsContent":{"description":"The flights array acts as a full replacement of all flights on a campaign. To add, delete, and/or update flights, include the full list of existing flights and only update those you wish to change. To update existing flights, include all fields including flightId. To add new flights, include all fields except flightId. To remove flights, do not include them. If you do not want to make any changes to flights, leave the array null.","properties":{"flights":{"items":{"$ref":"#/components/schemas/DspPutCampaignFlight"},"maxItems":150,"minItems":1,"type":"array"}},"type":"object"},"DspSubError":{"properties":{"errorCode":{"type":"string"},"errorId":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"type":"object"},"DspTooManyRequestsExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnauthorizedExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnsupportedMediaTypeExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUpdateAdGroupOptimizationRequestContentV1":{"properties":{"automateBudgetAllocation":{"description":"Set to true to automatically allocate budgets to better performing ad groups based on your selected goal KPI. To opt into automatic budget optimization, this setting must be set to true at both the campaign and ad group levels. Set to false to manually allocate budget for this ad group.","type":"boolean"},"bidStrategy":{"$ref":"#/components/schemas/DspBidStrategyV1"},"dailyMinSpendAmount":{"description":"Denotes the daily minimum spend on the line item in local currency.","format":"double","type":"number"}},"type":"object"},"FeeCurrencyCodeV1":{"description":"ISO 4217 standard currency code for all currency-related attributes. Applicable when feeValueType is `FIXED_CPM`. Note that the currencyCode represents the currency that the fee was originally set in. This may or may not be the same currency as the one selected by the advertiser. However, reports and invoices will reflect spends for the fees in advertisers selected currencies of preference.","enum":["AED","ARS","AUD","BGN","BHD","BOB","BRL","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","DZD","EGP","EUR","GBP","GTQ","HKD","HNL","HRK","HUF","IDR","ILS","INR","JMD","JOD","JPY","KRW","KWD","MAD","MXN","MYR","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SEK","SGD","THB","TND","TRY","TWD","UAH","USD","UYU","VND","ZAR"],"type":"string"},"FeeGetV1":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"currencyCode":{"$ref":"#/components/schemas/FeeCurrencyCodeV1"},"feeType":{"$ref":"#/components/schemas/FeeTypeGetV1"},"feeValue":{"description":"The fee amount expressed as the `feeValueType`. `AMAZON_AUDIENCE_FEE` AND `THIRD_PARTY_AUDIENCE_FEE` is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 0.15 represents 15%.","type":"string"},"feeValueType":{"$ref":"#/components/schemas/FeeValueTypeGetV1"},"thirdPartyProvider":{"$ref":"#/components/schemas/ThirdPartyProviderGetV1"}},"required":["feeType","feeValue","feeValueType"],"type":"object"},"FeePatchV1":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"feeType":{"$ref":"#/components/schemas/FeeTypePatchV1"},"feeValue":{"description":"The fee amount expressed as a CPM. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other third-party fees are in the currency of the advertiser.","type":"string"},"thirdPartyProvider":{"$ref":"#/components/schemas/ThirdPartyProviderPatchV1"}},"required":["addToBudgetSpentAmount","feeType","feeValue","thirdPartyProvider"],"type":"object"},"FeePostV1":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"feeType":{"$ref":"#/components/schemas/FeeTypePostV1"},"feeValue":{"description":"The fee amount expressed as a CPM. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other third-party fees are in the currency of the advertiser.","type":"string"},"thirdPartyProvider":{"$ref":"#/components/schemas/ThirdPartyProviderPostV1"}},"required":["addToBudgetSpentAmount","feeType","feeValue","thirdPartyProvider"],"type":"object"},"FeeTypeGetV1":{"description":"The type of the fee.\n* AMAZON_DSP_FEE: A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost.\n* AMAZON_AUDIENCE_FEE: CPM fee for using Amazon audiences.\n* THIRD_PARTY_AUDIENCE_FEE: CPM fee for using a third party audience.\n* OMNICHANNEL_METRICS_FEE: Fee for using Amazon Omnichannel Metrics.\n* THIRD_PARTY_APPLIED_FEE: User added CPM fee for using third-party data to track CPM costs. This fee is applied as a percent of supply cost.\n* THIRD_PARTY_TARGETING_FEE: CPM fee for using targeting provided by a third-party data provider.\n* MANAGED_SERVICE_FEE: The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service.","enum":["AMAZON_AUDIENCE_FEE","AMAZON_DSP_FEE","MANAGED_SERVICE_FEE","OMNICHANNEL_METRICS_FEE","THIRD_PARTY_APPLIED_FEE","THIRD_PARTY_AUDIENCE_FEE","THIRD_PARTY_TARGETING_FEE"],"type":"string"},"FeeTypePatchV1":{"description":"The type of the fee.\n* THIRD_PARTY_APPLIED_FEE: If this ad group uses third-party data and needs to track CPM costs, then apply any applicable data fee CPMs here. Amazon will automatically calculate your third-party fees in reporting. Please read carefully the two options for fee allocation and select the one that best fits your needs. Note: Amazon doesn’t facilitate the payment of these fees.","enum":["THIRD_PARTY_APPLIED_FEE"],"type":"string"},"FeeTypePostV1":{"description":"The type of the fee.\n* THIRD_PARTY_APPLIED_FEE: If this ad group uses third-party data and needs to track CPM costs, then apply any applicable data fee CPMs here. Amazon will automatically calculate your third-party fees in reporting. Please read carefully the two options for fee allocation and select the one that best fits your needs. Note: Amazon doesn’t facilitate the payment of these fees.","enum":["THIRD_PARTY_APPLIED_FEE"],"type":"string"},"FeeValueTypeGetV1":{"description":"* FIXED_CPM: Charged based on a fixed CPM. The currency depends on the feeType.\n* PERCENT_OF_SUPPLY_COST: Charged as a percent of supply (media) cost. Ranges from 0 to 1 where 0.15 represents 15%.","enum":["FIXED_CPM","PERCENT_OF_SUPPLY_COST"],"type":"string"},"FlightBudgetRolloverSettingV1":{"description":"Flight budget rollover settings for un-used budget of ended flights.","properties":{"rolloverStrategy":{"$ref":"#/components/schemas/RolloverStrategyV1"}},"type":"object"},"GoalGetV1":{"description":"The primary goal you are trying to achieve with this campaign. Only `AWARENESS`, `CONSIDERATION` and `CONVERSION` are supported on new campaigns. This field is read-only and is derived from the selected \"kpi\".","enum":["AWARENESS","CONSIDERATION","CONSIDERATIONS_ON_AMAZON","CONVERSION","CONVERSIONS_OFF_AMAZON","ENGAGEMENT_WITH_MY_AD","MOBILE_APP_INSTALLS","OTHER","PURCHASES_ON_AMAZON","PURCHASES_ON_OFF_AMAZON"],"type":"string"},"GoalSettingCreateV1":{"properties":{"kpi":{"$ref":"#/components/schemas/KpiPatchV1"},"targetKpi":{"description":"The key performance metric that will be used to measure success of your campaign. Depending on the `kpi` selected, this will be either currency based, percentage based, or an integer. To nullify, send a value of -1. If FREQUENCY is selected, this field will only accept values between 2 and 5 inclusive.","format":"float","type":"number"}},"required":["kpi"],"type":"object"},"GoalSettingGetV1":{"properties":{"currencyCode":{"description":"ISO 4217 standard currency code for all currency-related attributes.","type":"string"},"goal":{"$ref":"#/components/schemas/GoalGetV1"},"kpi":{"$ref":"#/components/schemas/KpiGetV1"},"targetKpi":{"description":"The key performance metric that will be used to measure success of your campaign. Depending on the `kpi` selected, this will be either currency based, percentage based, or an integer. To nullify, send a value of -1. If FREQUENCY is selected, this field will only accept values between 2 and 5 inclusive.","format":"float","type":"number"}},"type":"object"},"GoalSettingPatchV1":{"properties":{"kpi":{"$ref":"#/components/schemas/KpiPatchV1"},"targetKpi":{"description":"The key performance metric that will be used to measure success of your campaign. Depending on the `kpi` selected, this will be either currency based, percentage based, or an integer. To nullify, send a value of -1. If FREQUENCY is selected, this field will only accept values between 2 and 5 inclusive.","format":"float","type":"number"}},"type":"object"},"InventoryTypeGetV1":{"description":"Determines what inventory to display creatives on. Inventory refers to the channel (desktop sites, mobile sites, and apps) and specific sites and apps within those channels where ads can run. Once the ad group is created, this field is no longer editable. STANDARD_DISPLAY, AAP_MOBILE_APP, AMAZON_MOBILE_DISPLAY, and VIDEO will be deprecated on June 30, 2025. We recommend only using DISPLAY, ONLINE_VIDEO, and STREAMING_TV. AUDIO and PODCAST are new: Do not use these types until we announce the launch in our release notes.","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","AUDIO_AMAZON_DEAL","DIGITAL_OUT_OF_HOME","DISPLAY","LIVE_EVENTS","ONLINE_VIDEO","OTHER","PODCAST","STANDARD_DISPLAY","STREAMING_TV","STREAMING_TV_AMAZON_DEAL","VIDEO"],"type":"string"},"InventoryTypePatchV1":{"description":"Determines what inventory to display creatives on. Inventory refers to the channel (desktop sites, mobile sites, and apps) and specific sites and apps within those channels where ads can run. Once the ad group is created, this field is no longer editable. STANDARD_DISPLAY, AAP_MOBILE_APP, AMAZON_MOBILE_DISPLAY, and VIDEO will be deprecated on June 30, 2025. We recommend only using DISPLAY, ONLINE_VIDEO, and STREAMING_TV. AUDIO and PODCAST are new: Do not use these types until we announce the launch in our release notes.","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","DISPLAY","LIVE_EVENTS","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","VIDEO"],"type":"string"},"InventoryTypePostV1":{"description":"Determines what inventory to display creatives on. Inventory refers to the channel (desktop sites, mobile sites, and apps) and specific sites and apps within those channels where ads can run. Once the ad group is created, this field is no longer editable. STANDARD_DISPLAY, AAP_MOBILE_APP, AMAZON_MOBILE_DISPLAY, and VIDEO will be deprecated on June 30, 2025. We recommend only using DISPLAY, ONLINE_VIDEO, and STREAMING_TV. AUDIO and PODCAST are new: Do not use these types until we announce the launch in our release notes.","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","DISPLAY","LIVE_EVENTS","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","VIDEO"],"type":"string"},"InventoryTypesV1":{"description":"Specifies the inventory type of the ad groups that are auto-created upon Performance+ campaign creation. This field cannot be edited after campaign creation.","enum":["DISPLAY","VIDEO"],"type":"string"},"KpiGetV1":{"description":"The KPI the campaign will optimize toward.","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY","OTHER","REACH","RETURN_ON_AD_SPEND","ROAS_OFF_AMAZON","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"],"type":"string"},"KpiPatchV1":{"description":"The KPI the campaign will optimize toward. The KPI can be changed mid-flight but will reset any learnings built up by the campaign. Required on creation of the campaign. The \"goal\" displayed in the UI and campaign list operation will be derived from this kpi.","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY","REACH","RETURN_ON_AD_SPEND","ROAS_OFF_AMAZON","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"],"type":"string"},"PerformancePlusV1":{"description":"Set the required fields to generate a Performance+ campaign and ad groups with custom predictive audiences.","properties":{"inventoryTypes":{"items":{"$ref":"#/components/schemas/InventoryTypesV1"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"PrimaryInventoryTypeGetV1":{"description":"Primary inventory types for filtering Goal KPIs and automated tactics recommendations.","enum":["AUDIO","DISPLAY","OTHER","VIDEO_OLV","VIDEO_STV"],"type":"string"},"PrimaryInventoryTypePatchV1":{"description":"Primary inventory types for filtering Goal KPIs and automated tactics recommendations.","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"],"type":"string"},"RecurrenceTimePeriodGetV1":{"description":"The type of recurrence for the spending limit.","enum":["DAILY","MONTHLY","OTHER"],"type":"string"},"RecurrenceTimePeriodPutV1":{"description":"The type of recurrence for the spending limit.","enum":["DAILY","MONTHLY"],"type":"string"},"RolloverStrategyV1":{"description":"Strategy to apply for rolling over un-used flight budget. There are 3 options: Do not change flight budgets, Roll prior flight unused budget, Roll cumulative unused budget. If no value is set then default of NO_ROLLOVER is used.","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"],"type":"string"},"SiteLanguageGetV1":{"description":"The ISO 639-1 language code. Only applicable and required when `inventoryType` is STANDARD_DISPLAY or VIDEO. One language may be chosen from the list below depending on the advertiser\u0027s country.\n* US: EN, ES\n* CA: EN, FR\n* NL: NL, EN, FR\n* DE: DE, EN, CS, PL, TR, FR, IT, ES\n* ES: ES, PT, FR, EN, DE, IT\n* AE: EN, AR\n* SA: AR, EN\n* JP: JA, EN, ZH\n* FR: FR, EN, DE, IT, ES\n* IT: IT, EN, FR, DE, ES\n* UK: EN, FR, DE, IT, ES\n* IN: EN, HI, TA, TE, KN, MR, ML, BN, GU, PA\n* AU: EN\n* MX: ES, EN\n* BR: PT, EN\n* SE: SV, EN, NO, FI, DA\n* TR: TR\u003c/li\u003e\u003c/ul\u003e","enum":["AR","BN","CS","DA","DE","EN","ES","FI","FR","GU","HI","IT","JA","KN","ML","MR","NL","NO","OTHER","PA","PL","PT","SV","TA","TE","TR","ZH"],"type":"string"},"TacticsConvertersExclusionTypeGetV1":{"description":"Represents the exclusion criteria applied to purchasers of your tactics ad groups.\n* NO_EXCLUSION Do not exclude anyone from your targeting.\n* RECENT_PURCHASERS Exclude recent shoppers who bought your product recently.\n\nNon-endemic advertisers must have an off-Amazon purchase or signup conversion event type associated with the order to exclude past purchasers","enum":["NO_EXCLUSION","RECENT_PURCHASERS"],"type":"string"},"TacticsConvertersExclusionTypePatchV1":{"description":"Represents the exclusion criteria applied to purchasers of your tactics ad groups.\n* NO_EXCLUSION Do not exclude anyone from your targeting.\n* RECENT_PURCHASERS Exclude recent shoppers who bought your product recently.\n\nNon-endemic advertisers must have an off-Amazon purchase or signup conversion event type associated with the order to exclude past purchasers","enum":["NO_EXCLUSION","RECENT_PURCHASERS"],"type":"string"},"TacticsConvertersExclusionTypePostV1":{"description":"Represents the exclusion criteria applied to purchasers of your tactics ad groups.\n* NO_EXCLUSION Do not exclude anyone from your targeting.\n* RECENT_PURCHASERS Exclude recent shoppers who bought your product recently.\n\nNon-endemic advertisers must have an off-Amazon purchase or signup conversion event type associated with the order to exclude past purchasers","enum":["NO_EXCLUSION","RECENT_PURCHASERS"],"type":"string"},"TargetingSettingsGetV1":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/AmazonViewabilityGetV1"},"automatedTargetingTactic":{"$ref":"#/components/schemas/AutomatedTargetingTacticGetV1"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchTypeGetV1"},"enableLanguageTargeting":{"description":"If enabled, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"siteLanguage":{"$ref":"#/components/schemas/SiteLanguageGetV1"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionTypeGetV1"},"targetedPGDealId":{"description":"Programmatic Guaranteed DealId targeted by the Ad Group.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/TimeZoneTypeGetV1"},"userLocation":{"$ref":"#/components/schemas/UserLocationGetV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalGetV1"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTierGetV1"}},"type":"object"},"TargetingSettingsPatchV1":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/AmazonViewabilityPatchV1"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchTypePatchV1"},"enableLanguageTargeting":{"description":"If enabled, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionTypePatchV1"},"targetedPGDealId":{"description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/TimeZoneTypePatchV1"},"userLocation":{"$ref":"#/components/schemas/UserLocationPatchV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalPatchV1"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTierPatchV1"}},"type":"object"},"TargetingSettingsPostV1":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/AmazonViewabilityPostV1"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchTypePostV1"},"enableLanguageTargeting":{"description":"If enabled, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionTypePostV1"},"targetedPGDealId":{"description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/TimeZoneTypePostV1"},"userLocation":{"$ref":"#/components/schemas/UserLocationPostV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalPostV1"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTierPostV1"}},"required":["amazonViewability","timeZoneType","userLocationSignal"],"type":"object"},"ThirdPartyProviderGetV1":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. Represents the data provider for the applied fee in reporting.","enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"],"type":"string"},"ThirdPartyProviderPatchV1":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. Represents the data provider for the applied fee in reporting. Each provider is allowed one entry in the fees list.","enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"],"type":"string"},"ThirdPartyProviderPostV1":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. Represents the data provider for the applied fee in reporting. Each provider is allowed one entry in the fees list.","enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"],"type":"string"},"TimeZoneTypeGetV1":{"description":"The time zone associated with ad group delivery when daypart targeting is applied.\n* VIEWER is the time zone of the person viewing the ad.\n* ADVERTISER_REGION refers to one of these three options based on the region of the advertiser:\n  * US/Eastern: The time zone of the US East Coast which can be EST (UTC-5) or EDT (UTC-4).\n  * Europe/London: The time zone of London which can be GMT (UTC) or BST (UTC+1).\n  * Asia/Japan: Japan Standard Time (UTC+9).","enum":["ADVERTISER_REGION","OTHER","VIEWER"],"type":"string"},"TimeZoneTypePatchV1":{"description":"The time zone associated with ad group delivery when daypart targeting is applied.\n* VIEWER is the time zone of the person viewing the ad.\n* ADVERTISER_REGION refers to one of these three options based on the region of the advertiser:\n  * US/Eastern: The time zone of the US East Coast which can be EST (UTC-5) or EDT (UTC-4).\n  * Europe/London: The time zone of London which can be GMT (UTC) or BST (UTC+1).\n  * Asia/Japan: Japan Standard Time (UTC+9).","enum":["ADVERTISER_REGION","VIEWER"],"type":"string"},"TimeZoneTypePostV1":{"description":"The time zone associated with ad group delivery when daypart targeting is applied.\n* VIEWER is the time zone of the person viewing the ad.\n* ADVERTISER_REGION refers to one of these three options based on the region of the advertiser:\n  * US/Eastern: The time zone of the US East Coast which can be EST (UTC-5) or EDT (UTC-4).\n  * Europe/London: The time zone of London which can be GMT (UTC) or BST (UTC+1).\n  * Asia/Japan: Japan Standard Time (UTC+9).","enum":["ADVERTISER_REGION","VIEWER"],"type":"string"},"UserLocationGetV1":{"description":"[UNSUPPORTED] This field is no longer supported, and all values will be ignored. To target a user based on their location, create a geo location target using /dsp/v1/targets.","enum":["AE","AU","BR","CA","DE","ES","EVERYWHERE","FR","IN","IT","JP","MX","NL","NON_US","OTHER","PL","SA","SE","SG","TR","UK","US"],"type":"string"},"UserLocationPatchV1":{"description":"[UNSUPPORTED] This field is no longer supported, and all values will be ignored. To target a user based on their location, create a geo location target using /dsp/v1/targets.","enum":["AE","AU","BR","CA","DE","ES","EVERYWHERE","FR","IN","IT","JP","MX","NL","NON_US","PL","SA","SE","SG","TR","UK","US"],"type":"string"},"UserLocationPostV1":{"description":"[UNSUPPORTED] This field is no longer supported, and all values will be ignored. To target a user based on their location, create a geo location target using /dsp/v1/targets.","enum":["AE","AU","BR","CA","DE","ES","EVERYWHERE","FR","IN","IT","JP","MX","NL","NON_US","PL","SA","SE","SG","TR","UK","US"],"type":"string"},"UserLocationSignalGetV1":{"description":"The type of signal used to determine a users location when geo location targeting is applied.\n* CURRENT: Includes people who are currently in this location.\n* MULTIPLE_SIGNALS: Multiple location signals are used, including current and home location.","enum":["CURRENT","MULTIPLE_SIGNALS","OTHER"],"type":"string"},"UserLocationSignalPatchV1":{"description":"The type of signal used to determine a users location when geo location targeting is applied.\n* CURRENT: Includes people who are currently in this location.\n* MULTIPLE_SIGNALS: Multiple location signals are used, including current and home location.","enum":["CURRENT","MULTIPLE_SIGNALS"],"type":"string"},"UserLocationSignalPostV1":{"description":"The type of signal used to determine a users location when geo location targeting is applied.\n* CURRENT: Includes people who are currently in this location.\n* MULTIPLE_SIGNALS: Multiple location signals are used, including current and home location.","enum":["CURRENT","MULTIPLE_SIGNALS"],"type":"string"},"VideoCompletionTierGetV1":{"description":"Only applicable when inventoryType is `VIDEO`, `STREAMING_TV`, or `ONLINE_VIDEO`. To increase video completion rate, select a video completion targeting tier.\n* These aren\u0027t guaranteed and actual video completion achieved may vary. Selecting a high completion tier may limit overall reach/scale.\n* Video completion targeting is available across Amazon owned and operated inventory and third-party inventory covering video on web, mobile app, and Streaming TV.\n* Values provided for non-video ad groups will be ignored.","enum":["ALL_TIERS","GREATER_THAN_10_PERCENT","GREATER_THAN_20_PERCENT","GREATER_THAN_30_PERCENT","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","GREATER_THAN_80_PERCENT","GREATER_THAN_90_PERCENT"],"type":"string"},"VideoCompletionTierPatchV1":{"description":"Only applicable when inventoryType is `VIDEO`, `STREAMING_TV`, or `ONLINE_VIDEO`. To increase video completion rate, select a video completion targeting tier.\n* These aren\u0027t guaranteed and actual video completion achieved may vary. Selecting a high completion tier may limit overall reach/scale.\n* Video completion targeting is available across Amazon owned and operated inventory and third-party inventory covering video on web, mobile app, and Streaming TV.\n* Values provided for non-video ad groups will be ignored.","enum":["ALL_TIERS","GREATER_THAN_10_PERCENT","GREATER_THAN_20_PERCENT","GREATER_THAN_30_PERCENT","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","GREATER_THAN_80_PERCENT","GREATER_THAN_90_PERCENT"],"type":"string"},"VideoCompletionTierPostV1":{"description":"Only applicable when inventoryType is `VIDEO`, `STREAMING_TV`, or `ONLINE_VIDEO`. To increase video completion rate, select a video completion targeting tier.\n* These aren\u0027t guaranteed and actual video completion achieved may vary. Selecting a high completion tier may limit overall reach/scale.\n* Video completion targeting is available across Amazon owned and operated inventory and third-party inventory covering video on web, mobile app, and Streaming TV.\n* Values provided for non-video ad groups will be ignored.","enum":["ALL_TIERS","GREATER_THAN_10_PERCENT","GREATER_THAN_20_PERCENT","GREATER_THAN_30_PERCENT","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","GREATER_THAN_80_PERCENT","GREATER_THAN_90_PERCENT"],"type":"string"},"ViewabilityTierGetV1":{"description":"The targeted viewability tier. These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT","OTHER"],"type":"string"},"ViewabilityTierPatchV1":{"description":"The targeted viewability tier. These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT"],"type":"string"},"ViewabilityTierPostV1":{"description":"The targeted viewability tier. These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT"],"type":"string"}},"securitySchemes":{}},"info":{"description":"Create, read, and update campaigns and ad groups.","title":"Ad Group and Campaign - V1","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/v1/adGroups":{"patch":{"description":"Updates one or more ad groups.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e\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_edit\"]","operationId":"DspBatchPatchAdGroupV1","parameters":[{"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"}},{"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.","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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPatchAdGroupV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPatchAdGroupV1ResponseContent"}}},"description":"DspBatchPatchAdGroupV1 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"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."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"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."}},"tags":["Ad Group"]},"post":{"description":"Creates one or more ad groups synchronously. Returns one or more ad group identifiers if successful.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e\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_edit\"]","operationId":"DspBatchPostAdGroupV1","parameters":[{"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"}},{"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.","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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPostAdGroupV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPostAdGroupV1ResponseContent"}}},"description":"DspBatchPostAdGroupV1 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"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."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"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."}},"tags":["Ad Group"]}},"/dsp/v1/adGroups/list":{"post":{"description":"Gets one or more ad groups.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e\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":"DspListAdGroupV1","parameters":[{"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"}},{"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.","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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspListAdGroupV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspListAdGroupV1ResponseContent"}}},"description":"DspListAdGroupV1 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"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."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"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."}},"tags":["Ad Group"]}},"/dsp/v1/campaigns":{"patch":{"description":"Partially updates one or more campaigns.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e\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_edit\"]","operationId":"DspBatchPatchCampaignV1","parameters":[{"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"}},{"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.","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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPatchCampaignV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPatchCampaignV1ResponseContent"}}},"description":"DspBatchPatchCampaignV1 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"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."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"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."}},"tags":["Campaign"]},"post":{"description":"Creates one or more campaigns. Returns one or more campaign identifiers if successful.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e\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_edit\"]","operationId":"DspBatchPostCampaignV1","parameters":[{"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"}},{"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.","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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPostCampaignV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBatchPostCampaignV1ResponseContent"}}},"description":"DspBatchPostCampaignV1 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"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."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"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."}},"tags":["Campaign"]}},"/dsp/v1/campaigns/list":{"post":{"description":"Gets one or more campaigns.\\\n    \u003cb\u003eFind more details\u003c/b\u003e\\\n    See the Amazon DSP Support Center for more details. If you need access, please contact your Account Manager.\\\n    \u003ca target\u003d\"_blank\" class\u003d\"opblock-external-docs__link link\" href\u003d\"https://advertising.amazon.com/dsp/help\" rel\u003d\"noopener noreferrer\"\u003ehttps://advertising.amazon.com/dsp/help\u003c/a\u003e\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":"DspListCampaignV1","parameters":[{"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"}},{"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.","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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspListCampaignV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspListCampaignV1ResponseContent"}}},"description":"DspListCampaignV1 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"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."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionResponseContent"}}},"description":"DspConflictException 409 response"},"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."}},"tags":["Campaign"]}}}}