{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AcceptLanguageHeaderOptional":{"description":"Specifies the preferred language for response content","in":"header","name":"Accept-Language","schema":{"type":"string"}},"AccountIdHeader":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}},"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"AdProductQuery":{"description":"\n**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n","in":"query","name":"adProduct","required":true,"schema":{"$ref":"#/components/schemas/AdProduct"}},"AdvertisingDealIdQuery":{"in":"query","name":"advertisingDealId","required":true,"schema":{"type":"string"}},"BrandStoreIdQuery":{"in":"query","name":"brandStoreId","required":true,"schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"CurrencyCodeQuery":{"description":"\n**CurrencyCode Enum:**\n| CurrencyCode | Description |\n| --- | --- |\n| `AED` | United Arab Emirates Dirham |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CNY` | Chinese Yuan |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `INR` | Indian Rupee |\n| `JPY` | Japanese Yen |\n| `MXN` | Mexican Peso |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `TRY` | Turkish Lira |\n| `USD` | United States Dollar |\n","in":"query","name":"currencyCode","schema":{"$ref":"#/components/schemas/CurrencyCode"}},"ManagerAccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Manager Account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"type":"string"}},"MaxResultsQuery":{"in":"query","name":"maxResults","schema":{"default":50,"format":"int32","maximum":50,"minimum":11,"type":"integer"}},"NextTokenQuery":{"in":"query","name":"nextToken","schema":{"type":"string"}},"PerformanceEndDateQuery":{"in":"query","name":"performanceEndDate","schema":{"format":"date-time","type":"string"}},"PerformanceStartDateQuery":{"in":"query","name":"performanceStartDate","schema":{"format":"date-time","type":"string"}},"ScopeHeader":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},"ScopeHeaderOptional":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AccountCombinationInvitation":{"properties":{"accountCombinationInvitationId":{"description":"The unique identifier for the account combination invitation.","type":"string"},"accountsToCombine":{"description":"The list of accounts to combine into one Advertiser Account.","items":{"$ref":"#/components/schemas/AccountToCombine"},"maxItems":17,"minItems":1,"type":"array"},"advertiserAccountId":{"description":"The identifier of the Advertiser Account in the account combination invitation, in ACI format. Example: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq.","type":"string"},"status":{"$ref":"#/components/schemas/AccountCombinationInvitationStatus"},"statusMessage":{"description":"Additional information about the current status, including error details, rejection info and recommended actions.","type":"string"}},"required":["accountCombinationInvitationId","accountsToCombine","statusMessage"],"type":"object"},"AccountCombinationInvitationCreate":{"properties":{"accountsToCombine":{"description":"The list of accounts to combine into one Advertiser Account.","items":{"$ref":"#/components/schemas/CreateAccountToCombine"},"maxItems":17,"minItems":1,"type":"array"},"advertiserAccountId":{"description":"The identifier of the Advertiser Account in the account combination invitation, in ACI format. Example: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq.","type":"string"},"status":{"$ref":"#/components/schemas/AccountCombinationInvitationStatus"}},"required":["accountsToCombine"],"type":"object"},"AccountCombinationInvitationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":50,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitationMultiStatusSuccess"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"AccountCombinationInvitationMultiStatusSuccess":{"properties":{"accountCombinationInvitation":{"$ref":"#/components/schemas/AccountCombinationInvitation"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["accountCombinationInvitation","index"],"type":"object"},"AccountCombinationInvitationStatus":{"description":"This represents the current state of an account combination invitation.\n**AccountCombinationInvitationStatus Enum:**\n\n| AccountCombinationInvitationStatus | Description |\n|------|------|\n| `APPROVED` | The combination invitation has been approved by an admin. |\n| `PENDING` | The combination invitation is pending approval. |\n| `REJECTED` | The combination invitation was rejected by an admin. |\n| `RESENT` | The combination invitation has been re-sent after a previous attempt. |\n","enum":["APPROVED","PENDING","REJECTED","RESENT"],"type":"string"},"AccountCombinationInvitationSuccessResponse":{"properties":{"accountCombinationInvitations":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitation"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AccountCombinationInvitationUpdate":{"properties":{"accountCombinationInvitationId":{"description":"The unique identifier for the account combination invitation.","type":"string"},"accountsToCombine":{"description":"The list of accounts to combine into one Advertiser Account.","items":{"$ref":"#/components/schemas/CreateAccountToCombine"},"maxItems":17,"minItems":1,"type":"array"},"advertiserAccountId":{"description":"The identifier of the Advertiser Account in the account combination invitation, in ACI format. Example: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq.","type":"string"},"status":{"$ref":"#/components/schemas/AccountCombinationInvitationStatus"}},"required":["accountCombinationInvitationId"],"type":"object"},"AccountFunction":{"description":"All available options on how to combine an account metadata with other accounts.\n**AccountFunction Enum:**\n\n| AccountFunction | Description |\n|------|------|\n| `BILLING_PREFERENCES_SOURCE` | Inherit billing preferences from this advertising account. |\n| `BUSINESS_DETAILS_SOURCE` | Inherit business details from this DSP advertising account: business address, currency, industry, time zone. |\n","enum":["BILLING_PREFERENCES_SOURCE","BUSINESS_DETAILS_SOURCE"],"type":"string"},"AccountId":{"description":"| AccountId | Description |\n|------|------|\n| `advertiserAccountId` | This represents an advertiser account. It can be a global advertiser account that works across countries (ex: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq) or a DSP-only advertiser account (ex: 123456789012345678 or amzn1.ads1.aa1.gb.ENTITY108A02T7KWJGM). |\n","oneOf":[{"properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"],"title":"advertiserAccountId","type":"object"}]},"AccountState":{"description":"This represents the current state of an advertising account.\n**AccountState Enum:**\n\n| AccountState | Description |\n|------|------|\n| `APPROVED` | This signifies that the account has been successfully registered and is eligible to create and manage campaigns. |\n| `ARCHIVED` | This account has been permanently closed and cannot be reactivated. This may occur if the account was shut down at your request. To advertise again, you\u0027ll need to create a new account. |\n| `REGISTRATION_IN_PROGRESS` | This means the account registration request has been received and is currently in progress. |\n| `REJECTED` | This signifies that the account registration could not be completed successfully. To advertise again, you\u0027ll need to create a new account. |\n","enum":["APPROVED","ARCHIVED","REGISTRATION_IN_PROGRESS","REJECTED"],"type":"string"},"AccountToCombine":{"description":"Represents the account-to-be-combined and its attributes.","properties":{"accountFunctions":{"description":"Defines the different ways this account will be used to combine metadata with other accounts.","items":{"$ref":"#/components/schemas/AccountFunction"},"maxItems":5,"minItems":0,"type":"array"},"accountId":{"$ref":"#/components/schemas/AccountId"}},"required":["accountId"],"type":"object"},"AccountUsageType":{"enum":["PRODUCTION","TEST"],"type":"string"},"AcrossGroupOperator":{"description":"**AcrossGroupOperator Enum:**\n\n| AcrossGroupOperator | Description |\n|------|------|\n| `ALL` | Matches only if every single condition is true. AcrossGroupOperator is used among audiences between audience groups. This is a read-only field. |\n| `ANY` | Matches if at least one condition is true. AcrossGroupOperator is used among audiences between audience groups. This is a read-only field. |\n","enum":["ALL","ANY"],"type":"string"},"Ad":{"properties":{"activeCreative":{"$ref":"#/components/schemas/Creative"},"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The identifier of the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adType":{"$ref":"#/components/schemas/AdType"},"campaignId":{"description":"The campaign associated with the ad. It\u0027s a read-only field.","type":"string"},"creationDateTime":{"description":"The date time that the ad was created.","format":"date-time","type":"string"},"creative":{"$ref":"#/components/schemas/Creative"},"globalAdId":{"description":"The global ad identifier that manages this marketplace ad.","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the ad was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. For Sponsored Ads, the marketplaces included should either be same as or subset of parent ad group. For ADSP, this represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. The field represents the Amazon marketplaces for the advertised product included in the creative settings.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId","adProduct","adType","creationDateTime","creative","lastUpdatedDateTime","marketplaceScope","state"],"type":"object"},"AdAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociation":{"properties":{"adAssociationId":{"description":"The unique identifier of the ad association.","type":"string"},"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The ad Id  associated with the ad.","type":"string"},"endDateTime":{"description":"The end date time for the ad association.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the ad association.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"weight":{"description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group.","format":"int32","type":"integer"}},"required":["adAssociationId","adGroupId","adId","state"],"type":"object"},"AdAssociationAdAssociationIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociationAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociationAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAssociationCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The ad Id  associated with the ad.","type":"string"},"endDateTime":{"description":"The end date time for the ad association.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the ad association.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"weight":{"description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group.","format":"int32","type":"integer"}},"required":["adGroupId","adId","state"],"type":"object"},"AdAssociationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":20,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdAssociationMultiStatusSuccess"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"AdAssociationMultiStatusSuccess":{"properties":{"adAssociation":{"$ref":"#/components/schemas/AdAssociation"},"index":{"format":"int32","maximum":19,"minimum":0,"type":"integer"}},"required":["adAssociation","index"],"type":"object"},"AdAssociationSuccessResponse":{"properties":{"adAssociations":{"items":{"$ref":"#/components/schemas/AdAssociation"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdAssociationUpdate":{"properties":{"adAssociationId":{"description":"The unique identifier of the ad association.","type":"string"},"endDateTime":{"description":"The end date time for the ad association.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the ad association.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"weight":{"description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group.","format":"int32","type":"integer"}},"required":["adAssociationId"],"type":"object"},"AdCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdChoicesPosition":{"enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"],"type":"string"},"AdCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adType":{"$ref":"#/components/schemas/AdType"},"creative":{"$ref":"#/components/schemas/CreateCreative"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. For Sponsored Ads, the marketplaces included should either be same as or subset of parent ad group. For ADSP, this represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. The field represents the Amazon marketplaces for the advertised product included in the creative settings.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","adType","creative","state"],"type":"object"},"AdExtension":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"adExtensionSettings":{"$ref":"#/components/schemas/AdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/AdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/AdExtensionType"},"adGroupId":{"description":"A unique identifier for the ad group associated with the ad_extension.","type":"string"},"adId":{"description":"A unique identifier for the ad associated with the ad_extension.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"creationDateTime":{"description":"The date time the ad_extension was created.","format":"date-time","type":"string"},"lastUpdatedDateTime":{"description":"The date time the ad_extension was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global ad_extension is applicable. The marketplaces included should either be same as or subset of parent campaign/adGroup/ad","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"}},"required":["adExtensionId","adExtensionSettings","adExtensionType","adProduct","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","state"],"type":"object"},"AdExtensionAdExtensionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdExtensionStatusFilter":{"properties":{"include":{"description":"**AdExtensionStatus Enum:**\n| AdExtensionStatus | Description |\n| --- | --- |\n| `OPTED_OUT` | If the advertiser has opted out of this Ad Extension. |","items":{"$ref":"#/components/schemas/AdExtensionStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdExtensionTypeFilter":{"properties":{"include":{"description":"**AdExtensionType Enum:**\n| AdExtensionType | Description |\n| --- | --- |\n| `PROMPTS` | Enables Prompt based Ad Extension. |\n| `VIDEO` | Enables Video based Ad Extension. |","items":{"$ref":"#/components/schemas/AdExtensionType"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionCreate":{"properties":{"adExtensionSettings":{"$ref":"#/components/schemas/CreateAdExtensionSettings"},"adExtensionStatus":{"$ref":"#/components/schemas/AdExtensionStatus"},"adExtensionType":{"$ref":"#/components/schemas/AdExtensionType"},"adGroupId":{"description":"A unique identifier for the ad group associated with the ad_extension.","type":"string"},"adId":{"description":"A unique identifier for the ad associated with the ad_extension.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global ad_extension is applicable. The marketplaces included should either be same as or subset of parent campaign/adGroup/ad","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/CreateState"}},"required":["adExtensionSettings","adExtensionType","adProduct","marketplaceScope","marketplaces","state"],"type":"object"},"AdExtensionMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":50,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/AdExtensionPartialIndex"},"maxItems":50,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdExtensionMultiStatusSuccess"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"AdExtensionMultiStatusSuccess":{"properties":{"adExtension":{"$ref":"#/components/schemas/AdExtension"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["adExtension","index"],"type":"object"},"AdExtensionPartialIndex":{"properties":{"adExtension":{"$ref":"#/components/schemas/AdExtension"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["adExtension","errors","index"],"type":"object"},"AdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/PromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"},{"properties":{"videoExtension":{"$ref":"#/components/schemas/VideoExtension"}},"required":["videoExtension"],"title":"videoExtension","type":"object"}]},"AdExtensionStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdExtensionStatus":{"description":"Ad Extension Status.\n**AdExtensionStatus Enum:**\n\n| AdExtensionStatus | Description |\n|------|------|\n| `OPTED_OUT` | If the advertiser has opted out of this Ad Extension. |\n","enum":["OPTED_OUT"],"type":"string"},"AdExtensionSuccessResponse":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/AdExtension"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdExtensionType":{"description":"Ad Extension Type.\n**AdExtensionType Enum:**\n\n| AdExtensionType | Description |\n|------|------|\n| `PROMPTS` | Enables Prompt based Ad Extension. |\n| `VIDEO` | Enables Video based Ad Extension. |\n","enum":["PROMPTS","VIDEO"],"type":"string"},"AdExtensionUpdate":{"properties":{"adExtensionId":{"description":"A unique identifier for the ad_extension.","type":"string"},"marketplaces":{"description":"The list of marketplace in which the global ad_extension is applicable. The marketplaces included should either be same as or subset of parent campaign/adGroup/ad","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":1,"type":"array"},"state":{"$ref":"#/components/schemas/UpdateState"}},"required":["adExtensionId"],"type":"object"},"AdGroup":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adSettings":{"$ref":"#/components/schemas/AdSettings"},"advertisedProductCategoryIds":{"description":"The array of identifiers of advertised product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"bid":{"$ref":"#/components/schemas/AdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/Budget"},"maxItems":3,"minItems":0,"type":"array"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creationDateTime":{"description":"The date time that the ad group was created.","format":"date-time","type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationType"},"creativeType":{"$ref":"#/components/schemas/CreativeType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/Fee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/Frequency"},"maxItems":3,"minItems":0,"type":"array"},"globalAdGroupId":{"description":"The global adGroup identifier that manages this marketplace adGroup.","type":"string"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"lastUpdatedDateTime":{"description":"The date time that the ad group was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceAdGroupConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad group is applicable. The marketplaces included should either be same as or subset of parent campaign","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/Optimization"},"pacing":{"$ref":"#/components/schemas/Pacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/TargetingSettings"}},"required":["adGroupId","adProduct","campaignId","creationDateTime","lastUpdatedDateTime","name","state"],"type":"object"},"AdGroupAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/AdGroupBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"maxAverageBid":{"description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number).","format":"double","type":"number"}},"type":"object"},"AdGroupBidMarketplaceSetting":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"AdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"AdGroupCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adSettings":{"$ref":"#/components/schemas/CreateAdSettings"},"advertisedProductCategoryIds":{"description":"The array of identifiers of advertised product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"bid":{"$ref":"#/components/schemas/CreateAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/CreateBudget"},"maxItems":3,"minItems":0,"type":"array"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationType"},"creativeType":{"$ref":"#/components/schemas/CreativeType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/CreateFee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdGroupConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad group is applicable. The marketplaces included should either be same as or subset of parent campaign","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/CreateOptimization"},"pacing":{"$ref":"#/components/schemas/CreatePacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/CreateTargetingSettings"}},"required":["adProduct","campaignId","name","state"],"type":"object"},"AdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"}},"type":"object"},"AdGroupMarketplaceScopeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/AdGroupPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdGroupMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"AdGroupMultiStatusSuccess":{"properties":{"adGroup":{"$ref":"#/components/schemas/AdGroup"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["adGroup","index"],"type":"object"},"AdGroupNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/AdGroupNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"AdGroupNameFilterType":{"description":"**AdGroupNameFilterType Enum:**\n| AdGroupNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"AdGroupPartialIndex":{"properties":{"adGroup":{"$ref":"#/components/schemas/AdGroup"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["adGroup","errors","index"],"type":"object"},"AdGroupStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdGroupSuccessResponse":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/AdGroup"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdGroupUpdate":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adSettings":{"$ref":"#/components/schemas/UpdateAdSettings"},"advertisedProductCategoryIds":{"description":"The array of identifiers of advertised product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"bid":{"$ref":"#/components/schemas/UpdateAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/CreateBudget"},"maxItems":3,"minItems":0,"type":"array"},"creativeRotationType":{"$ref":"#/components/schemas/CreativeRotationType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/CreateFee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdGroupConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad group is applicable. The marketplaces included should either be same as or subset of parent campaign","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/UpdateOptimization"},"pacing":{"$ref":"#/components/schemas/UpdatePacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","nullable":true,"type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/UpdateTargetingSettings"}},"required":["adGroupId"],"type":"object"},"AdInitiationTarget":{"description":"Target based on how the video ad will be started.","properties":{"videoInitiationType":{"$ref":"#/components/schemas/VideoInitiationType"}},"required":["videoInitiationType"],"type":"object"},"AdMarketplaceScopeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/AdPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"AdMultiStatusSuccess":{"properties":{"ad":{"$ref":"#/components/schemas/Ad"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["ad","index"],"type":"object"},"AdNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/AdNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"AdNameFilterType":{"description":"**AdNameFilterType Enum:**\n| AdNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"AdPartialIndex":{"properties":{"ad":{"$ref":"#/components/schemas/Ad"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["ad","errors","index"],"type":"object"},"AdPlayerSize":{"description":"**AdPlayerSize Enum:**\n\n| AdPlayerSize | Description |\n|------|------|\n| `LARGE` | Large video player. |\n| `MEDIUM` | Medium video player. |\n| `SMALL` | Small video player. |\n| `UNKNOWN` | Unknown player size. |\n","enum":["LARGE","MEDIUM","SMALL","UNKNOWN"],"type":"string"},"AdPlayerSizeTarget":{"description":"Target based on the size of the ad player.","properties":{"adPlayerSize":{"$ref":"#/components/schemas/AdPlayerSize"}},"required":["adPlayerSize"],"type":"object"},"AdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"],"type":"string"},"AdProductGroup":{"description":"A group of adProducts\n**AdProductGroup Enum:**\n\n| AdProductGroup | Description |\n|------|------|\n| `ADSP` | Include adProducts: ADSP |\n","enum":["ADSP"],"type":"string"},"AdSettings":{"properties":{"productAttributeSetRefinementConfigurationId":{"description":"Identifier for the product attribute configuration set associated with this ad group.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"type":"object"},"AdStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdSuccessResponse":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/Ad"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdType":{"description":"**AdType Enum:**\n\n| AdType | Description |\n|------|------|\n| `AUDIO` | A creative that features one or more audio assets. |\n| `COMPONENT` | A creative that can features a collection of videos, images, and products. |\n| `DISPLAY` | A creative that features one or more custom images. |\n| `PRODUCT_AD` | A creative built based on a specified product. |\n| `THIRD_PARTY` | A creative that is served from a third party ad server. |\n| `VIDEO` | A creative that features one or more videos. |\n","enum":["AUDIO","COMPONENT","DISPLAY","PRODUCT_AD","THIRD_PARTY","VIDEO"],"type":"string"},"AdUpdate":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"creative":{"$ref":"#/components/schemas/UpdateCreative"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. For Sponsored Ads, the marketplaces included should either be same as or subset of parent ad group. For ADSP, this represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. The field represents the Amazon marketplaces for the advertised product included in the creative settings.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId"],"type":"object"},"Address":{"description":"The business address of advertising account.","format":"password","properties":{"addressLine1":{"description":"The address details - 1 of business.","type":"string"},"addressLine2":{"description":"The address details - 2 of business.","type":"string"},"businessName":{"description":"The name of business.","type":"string"},"city":{"description":"The city where business is located.","type":"string"},"countryCode":{"description":"The country where business is located.","type":"string"},"phoneNumber":{"description":"The phone number of business.","type":"string"},"state":{"description":"The city where business is located.","type":"string"},"zipCode":{"description":"The zipCode where business is located.","type":"string"}},"required":["addressLine1","businessName","city","countryCode"],"type":"object"},"AdjustmentTypes":{"enum":["FIXED_VALUE","MULTIPLIER","OFFSET_PERCENTAGE","OFFSET_VALUE"],"type":"string"},"AdvertisedProductMarketplaceSetting":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/GlobalStoreSettings"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The identifier of the product advertised.","type":"string"},"resolvedProductId":{"description":"The identifier of product associated with the advertised product. It\u0027s a read-only field.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"AdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/GlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/AdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"},"resolvedProductId":{"description":"The identifier of product associated with the advertised product. It\u0027s a read-only field.","type":"string"},"resolvedProductIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["productIdType"],"type":"object"},"AdvertiserAccount":{"properties":{"advertiserAccountId":{"description":"The unique identifier for the advertiser account.","type":"string"},"alternateIds":{"description":"The list of additional identifiers associated with advertising account.","items":{"$ref":"#/components/schemas/AlternateIdentifier"},"maxItems":30,"minItems":0,"type":"array"},"businessDetails":{"description":"The business details for an advertising account, containing either an address token for sellingAccount, or an address object if the sellingAccount lacks a valid address.","items":{"$ref":"#/components/schemas/BusinessDetail"},"maxItems":1,"minItems":1,"type":"array"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"displayName":{"description":"Display name for the advertiser account.","type":"string"},"industryVertical":{"$ref":"#/components/schemas/IndustryVertical"},"isGlobalAccount":{"description":"Indicates whether the advertising account is global or not.","type":"boolean"},"isTestAccount":{"description":"Indicates whether the advertising account is a test account or not.","type":"boolean"},"managerAccountId":{"description":"Manager Account ID to link to the advertiser account. Required for ADSP-enabled accounts. Without this parameter, accounts will only be enabled for Sponsored Ads.","type":"string"},"sellingAccountLinkRequests":{"description":"The selling account link requests for an advertiser account, containing details for linking.","items":{"$ref":"#/components/schemas/SellingAccountLinkRequest"},"maxItems":1,"minItems":0,"type":"array"},"status":{"$ref":"#/components/schemas/AdvertiserAccountStatus"},"timeZoneIana":{"$ref":"#/components/schemas/TimeZoneIana"}},"required":["advertiserAccountId","businessDetails","status"],"type":"object"},"AdvertiserAccountAdvertiserAccountIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertiserAccountCreate":{"properties":{"businessDetails":{"description":"The business details for an advertising account, containing either an address token for sellingAccount, or an address object if the sellingAccount lacks a valid address.","items":{"$ref":"#/components/schemas/CreateBusinessDetail"},"maxItems":1,"minItems":1,"type":"array"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"displayName":{"description":"Display name for the advertiser account.","type":"string"},"industryVertical":{"$ref":"#/components/schemas/IndustryVertical"},"isGlobalAccount":{"description":"Indicates whether the advertising account is global or not.","type":"boolean"},"isTestAccount":{"description":"Indicates whether the advertising account is a test account or not.","type":"boolean"},"managerAccountId":{"description":"Manager Account ID to link to the advertiser account. Required for ADSP-enabled accounts. Without this parameter, accounts will only be enabled for Sponsored Ads.","type":"string"},"sellingAccountLinkRequests":{"description":"The selling account link requests for an advertiser account, containing details for linking.","items":{"$ref":"#/components/schemas/CreateSellingAccountLinkRequest"},"maxItems":1,"minItems":0,"type":"array"},"timeZoneIana":{"$ref":"#/components/schemas/TimeZoneIana"}},"required":["businessDetails"],"type":"object"},"AdvertiserAccountIsGlobalAccountFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertiserAccountMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdvertiserAccountMultiStatusSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"AdvertiserAccountMultiStatusSuccess":{"properties":{"advertiserAccount":{"$ref":"#/components/schemas/AdvertiserAccount"},"index":{"format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["advertiserAccount","index"],"type":"object"},"AdvertiserAccountStatus":{"description":"The current status of an AdvertiserAccount, including a status code and a human-readable message.","properties":{"statusCode":{"$ref":"#/components/schemas/AccountState"},"statusMessage":{"description":"A human-friendly message describing the status of the advertising account.","type":"string"}},"required":["statusCode","statusMessage"],"type":"object"},"AdvertiserAccountSuccessResponse":{"properties":{"advertiserAccounts":{"items":{"$ref":"#/components/schemas/AdvertiserAccount"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdvertiserAccountUpdate":{"properties":{"advertiserAccountId":{"description":"The unique identifier for the advertiser account.","type":"string"},"businessDetails":{"description":"The business details for an advertising account, containing either an address token for sellingAccount, or an address object if the sellingAccount lacks a valid address.","items":{"$ref":"#/components/schemas/CreateBusinessDetail"},"maxItems":1,"minItems":1,"type":"array"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"displayName":{"description":"Display name for the advertiser account.","type":"string"},"industryVertical":{"$ref":"#/components/schemas/IndustryVertical"},"isGlobalAccount":{"description":"Indicates whether the advertising account is global or not.","type":"boolean"},"isTestAccount":{"description":"Indicates whether the advertising account is a test account or not.","type":"boolean"},"managerAccountId":{"description":"Manager Account ID to link to the advertiser account. Required for ADSP-enabled accounts. Without this parameter, accounts will only be enabled for Sponsored Ads.","type":"string"},"sellingAccountLinkRequests":{"description":"The selling account link requests for an advertiser account, containing details for linking.","items":{"$ref":"#/components/schemas/CreateSellingAccountLinkRequest"},"maxItems":1,"minItems":0,"type":"array"},"timeZoneIana":{"$ref":"#/components/schemas/TimeZoneIana"}},"required":["advertiserAccountId"],"type":"object"},"AdvertiserDomainList":{"description":"Targets domains based on list inherited from the advertiser.","properties":{"inheritFromAdvertiser":{"description":"Set to TRUE to inherit domain list from advertiser.","type":"boolean"}},"required":["inheritFromAdvertiser"],"type":"object"},"AdvertiserProductGroupEligibility":{"properties":{"adProductGroup":{"$ref":"#/components/schemas/AdProductGroup"},"advertiserAccountId":{"description":"The identifier of the advertiser account in the eligibility request.","type":"string"},"advertiserProductGroupEligibilityId":{"description":"The unique identifer for the advertiser product group eligibility request.","type":"string"},"creationDateTime":{"description":"Timestamp of when the eligibility request resource was created.","format":"date-time","type":"string"},"rejectedReasonDetail":{"description":"The details explaining the rejected eligibility request status.","items":{"$ref":"#/components/schemas/RejectedReasonDetail"},"maxItems":2,"minItems":0,"type":"array"},"status":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibilityStatus"}},"required":["adProductGroup","advertiserAccountId","advertiserProductGroupEligibilityId","creationDateTime","status"],"type":"object"},"AdvertiserProductGroupEligibilityAdvertiserProductGroupEligibilityStatusFilter":{"properties":{"include":{"description":"**Status Enum:**\n| Status | Description |\n| --- | --- |\n| `APPROVED` | The eligibility request is completed and approved. |\n| `PENDING` | The eligibility request is still in process and awaiting a decision. |\n| `REJECTED` | The eligibility request is completed but rejected. |","items":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibilityStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertiserProductGroupEligibilityCreate":{"properties":{"adProductGroup":{"$ref":"#/components/schemas/AdProductGroup"},"rejectedReasonDetail":{"description":"The details explaining the rejected eligibility request status.","items":{"$ref":"#/components/schemas/CreateRejectedReasonDetail"},"maxItems":2,"minItems":0,"type":"array"}},"required":["adProductGroup"],"type":"object"},"AdvertiserProductGroupEligibilityMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":5,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibilityMultiStatusSuccess"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"AdvertiserProductGroupEligibilityMultiStatusSuccess":{"properties":{"advertiserProductGroupEligibility":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibility"},"index":{"format":"int32","maximum":4,"minimum":0,"type":"integer"}},"required":["advertiserProductGroupEligibility","index"],"type":"object"},"AdvertiserProductGroupEligibilityStatus":{"description":"The current status of an eligibility request.\n**AdvertiserProductGroupEligibilityStatus Enum:**\n\n| AdvertiserProductGroupEligibilityStatus | Description |\n|------|------|\n| `APPROVED` | The eligibility request is completed and approved. |\n| `PENDING` | The eligibility request is still in process and awaiting a decision. |\n| `REJECTED` | The eligibility request is completed but rejected. |\n","enum":["APPROVED","PENDING","REJECTED"],"type":"string"},"AdvertiserProductGroupEligibilitySuccessResponse":{"properties":{"advertiserProductGroupEligibilities":{"items":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibility"},"maxItems":10,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdvertisingDeal":{"properties":{"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"advertisingDealId":{"description":"A unique identifier for a deal.","type":"string"},"creationDateTime":{"description":"The date time that the deal was created.","format":"date-time","type":"string"},"creativeRequirements":{"$ref":"#/components/schemas/CreativeRequirements"},"customPublisherDescription":{"description":"Custom description of the publisher providing inventory for this deal.","type":"string"},"dealType":{"$ref":"#/components/schemas/AdvertisingDealType"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"exchangeDealId":{"description":"A unique external identifier provided by Exchange/SSP for a Deal.","type":"string"},"exchangeId":{"description":"The exchange/SSP that provides the deal.","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/AdvertisingDealStatus"},"terms":{"$ref":"#/components/schemas/AdvertisingDealTerms"}},"required":["adProduct","advertisingDealId","creationDateTime","dealType","endDateTime","name","startDateTime","status"],"type":"object"},"AdvertisingDealAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/DSPAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealAdvertisingDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealAdvertisingDealPriceTypeFilter":{"properties":{"include":{"description":"**PriceType Enum:**\n| PriceType | Description |\n| --- | --- |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `FIXED_CPM` | Fixed cost per thousand impressions. Buyer pays this exact CPM for every impression won. Used for PREFERRED and PROGRAMMATIC_GUARANTEED deals. |\n| `FLOOR_RATE` | Minimum bid price for auction. Buyer must bid at or above this floor to compete. Used for PRIVATE_AUCTION deals. |","items":{"$ref":"#/components/schemas/AdvertisingDealPriceType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealAdvertisingDealTypeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/AdvertisingDealType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealCountryCodeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"creativeRequirements":{"$ref":"#/components/schemas/CreateCreativeRequirements"},"customPublisherDescription":{"description":"Custom description of the publisher providing inventory for this deal.","type":"string"},"dealType":{"$ref":"#/components/schemas/AdvertisingDealType"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"exchangeDealId":{"description":"A unique external identifier provided by Exchange/SSP for a Deal.","type":"string"},"exchangeId":{"description":"The exchange/SSP that provides the deal.","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"terms":{"$ref":"#/components/schemas/CreateAdvertisingDealTerms"}},"required":["adProduct","dealType","endDateTime","name","startDateTime"],"type":"object"},"AdvertisingDealCreationDateTimeRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DateTimeRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealEndDateTimeRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DateTimeRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealExchangeDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealExchangeIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealMarketplaceDealFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdvertisingDealMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"AdvertisingDealMultiStatusSuccess":{"properties":{"advertisingDeal":{"$ref":"#/components/schemas/AdvertisingDeal"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["advertisingDeal","index"],"type":"object"},"AdvertisingDealNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/AdvertisingDealNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"AdvertisingDealNameFilterType":{"description":"**AdvertisingDealNameFilterType Enum:**\n| AdvertisingDealNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |","enum":["EXACT_MATCH"],"type":"string"},"AdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"priceType":{"$ref":"#/components/schemas/AdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"required":["currencyCode","priceType","value"],"type":"object"},"AdvertisingDealPriceRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MonetaryRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealPriceType":{"description":"**AdvertisingDealPriceType Enum:**\n\n| AdvertisingDealPriceType | Description |\n|------|------|\n| `FIXED_CPM` | Fixed cost per thousand impressions. Buyer pays this exact CPM for every impression won. Used for PREFERRED and PROGRAMMATIC_GUARANTEED deals. |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `FLOOR_RATE` | Minimum bid price for auction. Buyer must bid at or above this floor to compete. Used for PRIVATE_AUCTION deals. |\n","enum":["FIXED_CPM","FIXED_PRICE","FLOOR_RATE"],"type":"string"},"AdvertisingDealSortOption":{"properties":{"by":{"$ref":"#/components/schemas/AdvertisingDealSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"AdvertisingDealSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| advertisingDealId | ASCENDING,DESCENDING |\n| creationDateTime | ASCENDING,DESCENDING |\n| dealType | ASCENDING,DESCENDING |\n| endDateTime | ASCENDING,DESCENDING |\n| exchangeDealId | ASCENDING,DESCENDING |\n| name | ASCENDING,DESCENDING |\n| price | ASCENDING,DESCENDING |\n| startDateTime | ASCENDING,DESCENDING |","enum":["advertisingDealId","creationDateTime","dealType","endDateTime","exchangeDealId","name","price","startDateTime"],"type":"string"},"AdvertisingDealStartDateTimeRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DateTimeRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealStatus":{"properties":{"status":{"$ref":"#/components/schemas/AdvertisingDealStatusEnum"}},"required":["status"],"type":"object"},"AdvertisingDealStatusEnum":{"description":"**AdvertisingDealStatusEnum Enum:**\n\n| AdvertisingDealStatusEnum | Description |\n|------|------|\n| `ACTIVE` | Deal is ready to serve from SSP perspective. SSP will send bid requests for this deal (subject to dates and other validations). |\n| `ENDED` | Deal has passed its end date and is no longer active. |\n| `PAUSED` | Deal is temporarily paused from SSP perspective. SSP will not send bid requests for this deal, regardless of dates. |\n| `SCHEDULED` | Deal is approved and scheduled but has not yet reached its start date. |\n","enum":["ACTIVE","ENDED","PAUSED","SCHEDULED"],"type":"string"},"AdvertisingDealStatusFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/AdvertisingDealStatus"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdvertisingDealSuccessResponse":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/AdvertisingDeal"},"maxItems":10000,"minItems":0,"type":"array"},"nextToken":{"type":"string"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"AdvertisingDealTerms":{"description":"Terms for a deal. Supports PA \u0026 PD deals along with both spend-based guarantees (standard PG) and share-of-voice based guarantees (PG-SOV).","properties":{"budget":{"$ref":"#/components/schemas/MonetaryBudget"},"guaranteed":{"description":"If true, deal is PG Deal.","type":"boolean"},"marketplaceDeal":{"description":"If true, deal is available to all Amazon DSP entities globally. Marketplace deals cannot be edited by individual buyers.","type":"boolean"},"price":{"$ref":"#/components/schemas/AdvertisingDealPrice"},"shareOfVoicePercentage":{"description":"Guaranteed Share-of-voice Percentage of the advertising deal. Used for SOV-based PG deals. Value must be \u003e 0 and \u003c\u003d 100. Mutually exclusive with budget.","format":"double","type":"number"}},"required":["guaranteed","marketplaceDeal","price"],"type":"object"},"AdvertisingDealType":{"enum":["PREFERRED","PRIVATE_AUCTION","PROGRAMMATIC_GUARANTEED"],"type":"string"},"AdvertisingDealUpdate":{"properties":{"advertisingDealId":{"description":"A unique identifier for a deal.","type":"string"},"creativeRequirements":{"$ref":"#/components/schemas/UpdateCreativeRequirements"},"customPublisherDescription":{"description":"Custom description of the publisher providing inventory for this deal.","type":"string"},"dealType":{"$ref":"#/components/schemas/AdvertisingDealType"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"terms":{"$ref":"#/components/schemas/UpdateAdvertisingDealTerms"}},"required":["advertisingDealId"],"type":"object"},"AlternateIdentifier":{"description":"Marketplace identifiers associated with advertising account, including profile ID, dsp advertiser ID and entity ID","properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"dspAdvertiserId":{"description":"The regional ADSP advertiser identifier of the advertising account.","type":"string"},"entityId":{"description":"The marketplace entity identifier of the advertising account.","type":"string"},"profileId":{"description":"The marketplace profile identifier of the advertising account.","type":"string"},"region":{"$ref":"#/components/schemas/RegionCode"}},"type":"object"},"AmazonConsentFormat":{"description":"Captures information as to whether a user has consented to their data being used for advertising purposes.","properties":{"amznAdStorage":{"$ref":"#/components/schemas/ConsentStatus"},"amznUserData":{"$ref":"#/components/schemas/ConsentStatus"}},"required":["amznUserData"],"type":"object"},"AmazonViewability":{"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/ViewabilityTier"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"AppListTargetingEntry":{"description":"An app list targeting entry. All entries must share the same negative value.","properties":{"appListId":{"description":"The app list to target.","type":"string"},"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["appListId","groupId"],"type":"object"},"AppTarget":{"description":"Target based on user application.","properties":{"appId":{"description":"The app identifier being targeted.","type":"string"},"appType":{"$ref":"#/components/schemas/AppType"}},"required":["appId","appType"],"type":"object"},"AppTargetingEntry":{"description":"An app targeting entry. All entries must share the same negative value.","properties":{"appId":{"description":"The app to target.","type":"string"},"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["appId","groupId"],"type":"object"},"AppType":{"description":"**AppType Enum:**\n\n| AppType | Description |\n|------|------|\n| `MOBILE` | Mobile application. |\n| `STREAMING_TV` | Streaming TV application. |\n","enum":["MOBILE","STREAMING_TV"],"type":"string"},"AssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"AssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"AssetBasedCreativeCallToActionType":{"enum":["BOOK_NOW","BUY_NOW","DISCOVER_MORE","DOWNLOAD_NOW","EXPLORE_NOW","GET_APP","GET_QUOTE","LEARN_MORE","PRE_ORDER_NOW","SEE_DETAILS","SHOP_NOW","SIGN_UP_NOW","SUBSCRIBE_NOW"],"type":"string"},"AssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"backgrounds":{"description":"The background which is displayed on the ad.","items":{"$ref":"#/components/schemas/Background"},"maxItems":1,"minItems":0,"type":"array"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/AssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/Video"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"hasTermsAndConditions":{"description":"Indicates that the ad promotes a free product or service and has qualifying terms and conditions applicable to the customer. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those.","type":"boolean"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ComponentLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"}},"required":["headlines"],"type":"object"},"AudienceBidAdjustment":{"properties":{"audienceId":{"description":"The unique identifier of the Audience to apply bid adjustment.","type":"string"},"percentage":{"description":"The selection of the percentage change associated with a given audience and bid adjustment settings.","format":"int32","type":"integer"}},"required":["audienceId","percentage"],"type":"object"},"AudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"acrossGroupOperator":{"$ref":"#/components/schemas/AcrossGroupOperator"},"audienceId":{"$ref":"#/components/schemas/MarketplaceStringValue"},"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group.","type":"string"},"inGroupOperator":{"$ref":"#/components/schemas/InGroupOperator"}},"required":["audienceId"],"type":"object"},"AudienceTargetingEntry":{"description":"An individual audience targeting entry. Entries sharing the same groupId are OR\u0027d (union). Included groups (negative\u003dfalse) are AND\u0027d (intersection) across groups. All audiences in a negative group are OR\u0027d, then excluded (AND NOT).","properties":{"audienceId":{"description":"The audience segment to target.","type":"string"},"groupId":{"description":"Identifies the group this audience belongs to. Audiences sharing the same groupId are OR\u0027d together. Use any unique string per group (e.g. \u00271\u0027, \u00272\u0027).","type":"string"},"negative":{"description":"When true, this audience belongs to a negative (exclusion) group. Defaults to false when omitted.","type":"boolean"}},"required":["audienceId","groupId"],"type":"object"},"Audio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"AudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"AudioCreative":{"description":"| AudioCreative | Description |\n|------|------|\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |\n","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/StandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"AutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"AutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"},"autoManageCampaign":{"description":"Flag that allows Amazon to manage the lifecycle of your Campaign.","type":"boolean"}},"type":"object"},"AutoScaleGlobalCampaignSetting":{"description":"**AutoScaleGlobalCampaignSetting Enum:**\n\n| AutoScaleGlobalCampaignSetting | Description |\n|------|------|\n| `AUTO` | Auto scale global campaign to new marketplaces |\n| `MANUAL` | Manually scale global campaign to new marketplaces |\n","enum":["AUTO","MANUAL"],"type":"string"},"AutomatedTargetingTactic":{"description":"**AutomatedTargetingTactic Enum:**\n\n| AutomatedTargetingTactic | Description |\n|------|------|\n| `AWARENESS` | Ad Group tactic (Complete TV) that indicates that this line item drives awareness to your selected audience on publisher streaming TV for the linked deal while fulfilling your commitment. |\n| `CUSTOMER_ACQUISITION` | Ad Group Tactic (P+) that reaches shoppers who are similar to past purchasers |\n| `MAXIMIZE_PERFORMANCE` | Ad Group Tactic (P+) that reaches shoppers who are similar to past shoppers who viewed a product detail page |\n| `PROSPECTING` | Ad Group Tactic (B+) that reaches consumers who are highly likely to show interest and engage with your brand or product |\n| `REMARKETING` | Ad Group Tactic (P+) that reaches shoppers who have viewed a product detail page, searched for your product, or visited your homepage |\n| `RETENTION` | Ad Group Tactic (P+) that reaches shoppers who have purchased your product |\n| `SEARCH` | Ad Group Tactic that targets shoppers based on search signals. |\n","enum":["AWARENESS","CUSTOMER_ACQUISITION","MAXIMIZE_PERFORMANCE","PROSPECTING","REMARKETING","RETENTION","SEARCH"],"type":"string"},"AvailsForDeviceType":{"description":"Avails breakdown for a specific device type.","properties":{"deviceType":{"$ref":"#/components/schemas/DeviceType"},"impressionOpportunities":{"description":"The number of impression opportunities per day per device.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["deviceType","impressionOpportunities"],"type":"object"},"AverageCompletionAndFullyViewableRateTargetingType":{"description":"The type of average completion and fully viewable rate targeting.\n\n\n\n\n\n","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"],"type":"string"},"Background":{"properties":{"color":{"description":"The color hex code of the background.","type":"string"}},"type":"object"},"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/AudienceBidAdjustment"},"maxItems":1,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/CreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements. Not supported for Sponsored Brands campaigns using the SALES_UP_AND_DOWN bid strategy.","items":{"$ref":"#/components/schemas/PlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/ShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"BidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/BidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"}},"type":"object"},"BidStrategy":{"description":"**BidStrategy Enum:**\n\n| BidStrategy | Description |\n|------|------|\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `NEW_TO_BRAND` | Optimizes bidding to maximize new-to-brand customer acquisitions. |\n| `PRIORITIZE_KPI_TARGET` | Optimizes bidding to achieve the KPI target specified. |\n| `RULE_BASED` | Applies bidding rules defined by the advertiser. |\n| `SALES_DOWN_ONLY` | Decreases your bids in real time when your ad is less likely to convert to a sale. Bids will never increase beyond your set bid. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SPEND_BUDGET_IN_FULL` | Prioritize spending full budget, while maximizing performance |\n| `USE_CAMPAIGN_STRATEGY` | Inherit the bid strategy from the parent campaign. |\n","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"],"type":"string"},"BrandExposureViewabilityTargetingType":{"description":"The type of brand exposure viewability targeting.\n\n\n\n\n\n","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"],"type":"string"},"BrandGalleryCardCreativeElement":{"properties":{"customImage":{"$ref":"#/components/schemas/Image"},"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"}},"required":["customImage","headline","landingPage"],"type":"object"},"BrandGalleryCreativePropertiesToOptimize":{"description":"**BrandGalleryCreativePropertiesToOptimize Enum:**\n\n| BrandGalleryCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"BrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/BrandGalleryCardCreativeElement"},"maxItems":5,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/BrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"BrandSafetyCategory":{"description":"**BrandSafetyCategory Enum:**\n\n| BrandSafetyCategory | Description |\n|------|------|\n| `ACCIDENTS_DISASTERS_AND_TRAGEDIES` | Content related to sensitive tragedies, man-made or natural disasters and calamities, including content that graphically depicts such events. |\n| `ALCOHOL_AND_RELATED_PRODUCTS` | Content related to the general consumption of alcohol. |\n| `BLOOD_GORE_VIOLENCE` | Content in a fictional entertainment context that contains blood, gore or acts of violence. |\n| `CRIME` | Content related to crime, such as law enforcement efforts, criminal behavior, crime prevention, and justice systems. |\n| `DRUG_REFERENCES_OR_USE` | Content related to substance use, drugs, and other mind-altering substances. |\n| `GAMBLING` | Content related to gambling, such as instructions on how to play, accessories like home poker sets, and industry news. It does not include online gambling services where money or items of value can be wagered in exchange for the opportunity to win prizes with real-world value. |\n| `HIGHLY_DEBATED_SOCIAL_ISSUES` | Content related to highly debated and politically or socially divisive topics, which is reasonably likely to cause offense to the average person with opposing views. |\n| `POLITICS` | Content related to politics, governments, political science, political parties, elections, and political issues of public debate. |\n| `PROFANITY` | Content containing excessive use of strong language, explicit, offensive, or sensitive words and expressions. |\n| `RELIGIOUS_CONTENT` | Content related to religious and spiritual beliefs. |\n| `SEXUAL_REFERENCES_AND_SUGGESTIVE` | Content that contains references or depictions that are mildly provocative, or mature in nature, whether real, simulated or animated. It does not contain sexually explicit content. |\n| `SHOCK_AND_HORROR` | Content that may cause shock, fear, or unease. It includes supernatural, disturbing elements, and horror themes. |\n| `TOBACCO_AND_RELATED_PRODUCTS` | Content related to the smoking of cigarettes, cigars, pipe tobacco, smokeless tobacco, and other tobacco or nicotine products. |\n| `UNRATED_MEDIA_CONTENT` | Content that has not been classified. This covers games on Twitch not rated by ESRB. |\n| `WEAPONS` | Content related to realistic weapons, such as firearms, bladed weapons, bows and arrows, and military equipment and vehicles. |\n","enum":["ACCIDENTS_DISASTERS_AND_TRAGEDIES","ALCOHOL_AND_RELATED_PRODUCTS","BLOOD_GORE_VIOLENCE","CRIME","DRUG_REFERENCES_OR_USE","GAMBLING","HIGHLY_DEBATED_SOCIAL_ISSUES","POLITICS","PROFANITY","RELIGIOUS_CONTENT","SEXUAL_REFERENCES_AND_SUGGESTIVE","SHOCK_AND_HORROR","TOBACCO_AND_RELATED_PRODUCTS","UNRATED_MEDIA_CONTENT","WEAPONS"],"type":"string"},"BrandSafetyCategoryTarget":{"description":"Target based on, if any, the classifications of unsuitable contexts that may pose a risk to a brand\u0027s reputation of content being viewed.","properties":{"brandSafetyCategory":{"$ref":"#/components/schemas/BrandSafetyCategory"}},"required":["brandSafetyCategory"],"type":"object"},"BrandSafetyTier":{"description":"**BrandSafetyTier Enum:**\n\n| BrandSafetyTier | Description |\n|------|------|\n| `EXPANDED` | Tier that maximizes reach across all ad-eligible inventory. This tier is suitable for brands with a greater risk tolerance for advertising alongside a wide variety of content. |\n| `RESTRICTIVE` | Tier that prioritizes brand suitability over reach. This tier is suitable for brands with the lowest risk tolerance for advertising alongside a wide variety of content. |\n| `STANDARD` | Tier that offers broad reach and is the default for all campaigns. This tier is suitable for brands with a moderate risk tolerance for advertising alongside a wide variety of content. |\n","enum":["EXPANDED","RESTRICTIVE","STANDARD"],"type":"string"},"BrandSafetyTierTarget":{"description":"Target based on the brand suitability risk levels of content being viewed.","properties":{"brandSafetyTier":{"$ref":"#/components/schemas/BrandSafetyTier"}},"required":["brandSafetyTier"],"type":"object"},"BrandStore":{"properties":{"pageInfos":{"description":"Collection of BrandStorePageInfo for all pages tied to the brand store","items":{"$ref":"#/components/schemas/BrandStorePageInfo"},"maxItems":30,"minItems":0,"type":"array"},"storeId":{"description":"Unique identifier for the store","type":"string"},"storeName":{"description":"The name of the store","type":"string"}},"required":["storeId"],"type":"object"},"BrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/BrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"BrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"BrandStoreCallToActionType":{"enum":["BUY_NOW","DISCOVER_MORE","LEARN_MORE","SEE_DETAILS","SHOP_NOW"],"type":"string"},"BrandStoreEdition":{"properties":{"editionId":{"description":"Unique identifier for the edition within the store","type":"string"},"editionName":{"description":"Name of the store edition","type":"string"},"storeEditionSchedule":{"$ref":"#/components/schemas/StoreEditionSchedule"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["editionId","editionName","storeId"],"type":"object"},"BrandStoreEditionPublishVersion":{"properties":{"editionId":{"description":"Reference to the store edition","type":"string"},"pages":{"description":"Collection of page versions included in this publish version","items":{"$ref":"#/components/schemas/StorePageVersion"},"maxItems":5000,"minItems":0,"type":"array"},"publishState":{"$ref":"#/components/schemas/StorePublishState"},"publishStatus":{"$ref":"#/components/schemas/StorePublishStatus"},"storeEditionPublishId":{"description":"Unique identifier for the publish version","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["editionId","publishState","publishStatus","storeEditionPublishId","storeId"],"type":"object"},"BrandStoreEditionPublishVersionBrandStoreEditionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionBrandStoreIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"BrandStoreEditionPublishVersionMultiStatusSuccess":{"properties":{"brandStoreEditionPublishVersion":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersion"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["brandStoreEditionPublishVersion","index"],"type":"object"},"BrandStoreEditionPublishVersionStorePublishStatusFilter":{"properties":{"include":{"description":"| PublishStatus | Description |\n| --- | --- |\n| `DRAFT` | Content is in draft state |\n| `REVIEW_IN_PROGRESS` | Content is pending publication for review |","items":{"$ref":"#/components/schemas/StorePublishStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionSuccessResponse":{"properties":{"brandStoreEditionPublishVersions":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersion"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandStoreEditionPublishVersionUpdate":{"properties":{"editionId":{"description":"Reference to the store edition","type":"string"},"publishState":{"$ref":"#/components/schemas/StorePublishState"},"storeEditionPublishId":{"description":"Unique identifier for the publish version","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["storeEditionPublishId"],"type":"object"},"BrandStoreEditionSuccessResponse":{"properties":{"brandStoreEditions":{"items":{"$ref":"#/components/schemas/BrandStoreEdition"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandStorePage":{"properties":{"content":{"$ref":"#/components/schemas/StorePageContent"},"editionId":{"description":"Reference to the store edition","type":"string"},"pageId":{"description":"Unique identifier for the store page","type":"string"},"pageType":{"$ref":"#/components/schemas/StorePageType"},"storeEditionPublishId":{"description":"Optional identifier for the published version of this page","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["content","editionId","pageId","pageType","storeId"],"type":"object"},"BrandStorePageBrandStoreEditionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageBrandStoreEditionPublishVersionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageBrandStoreIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageInfo":{"description":"Structure containing the basic information of a store page","properties":{"tag":{"description":"Unique tag for the store page","type":"string"},"title":{"description":"Title of the page","type":"string"}},"required":["tag","title"],"type":"object"},"BrandStorePageMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/BrandStorePageMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"BrandStorePageMultiStatusSuccess":{"properties":{"brandStorePage":{"$ref":"#/components/schemas/BrandStorePage"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["brandStorePage","index"],"type":"object"},"BrandStorePagePageIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStorePageSuccessResponse":{"properties":{"brandStorePages":{"items":{"$ref":"#/components/schemas/BrandStorePage"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandStorePageUpdate":{"properties":{"content":{"$ref":"#/components/schemas/UpdateStorePageContent"},"editionId":{"description":"Reference to the store edition","type":"string"},"pageId":{"description":"Unique identifier for the store page","type":"string"},"storeEditionPublishId":{"description":"Optional identifier for the published version of this page","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["pageId"],"type":"object"},"BrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/BrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/Image"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"BrandStoreStoreNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreSuccessResponse":{"properties":{"brandStores":{"items":{"$ref":"#/components/schemas/BrandStore"},"maxItems":30,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandSuitabilityRiskLevelType":{"description":"The Double Verify brand suitability risk level.\n\n\n\n\n\n","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"],"type":"string"},"BrandedRecipeDirection":{"description":"Represents a single step in a recipe\u0027s directions","properties":{"body":{"description":"Detailed instruction text for the direction step","type":"string"},"title":{"description":"Title or heading for the direction step","type":"string"}},"required":["body","title"],"type":"object"},"BrandedRecipeIngredient":{"description":"Represents an ingredient in a branded recipe","properties":{"asinOverrides":{"description":"List of ASIN overrides for the ingredient","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"brand":{"description":"Brand name associated with the ingredient","type":"string"},"displayText":{"description":"Formatted text for displaying the ingredient","type":"string"},"isAsinRestricted":{"description":"Flag indicating if ASIN is restricted for this ingredient","type":"boolean"},"isBrandRestricted":{"description":"Flag indicating if brand is restricted for this ingredient","type":"boolean"},"isExclusiveOverride":{"description":"Flag indicating if this ingredient has exclusive override","type":"boolean"},"name":{"description":"Name of the ingredient","type":"string"},"quantityList":{"description":"List of quantity measurements for the ingredient","items":{"$ref":"#/components/schemas/BrandedRecipeQuantityItem"},"maxItems":500,"minItems":0,"type":"array"}},"required":["brand","displayText","isAsinRestricted","isBrandRestricted","isExclusiveOverride","name"],"type":"object"},"BrandedRecipeIngredientsMetadata":{"description":"Contains metadata information for recipe ingredients","properties":{"priorityAsins":{"description":"List of priority ASINs for ingredients with detailed product information","items":{"$ref":"#/components/schemas/PriorityAsin"},"maxItems":500,"minItems":0,"type":"array"},"quantity":{"description":"Quantity amount for the ingredient","format":"double","type":"number"},"searchText":{"description":"Search text for ingredient metadata","type":"string"},"translatedUnit":{"description":"Translated unit of measurement","type":"string"}},"type":"object"},"BrandedRecipeMedia":{"description":"Represents media content associated with a recipe","properties":{"altText":{"description":"Alternative text description of the media content","type":"string"},"assetLibraryId":{"description":"Identifier for the asset.","type":"string"},"mediaUrl":{"description":"URL of the media content","type":"string"}},"type":"object"},"BrandedRecipeQuantityItem":{"description":"Represents a quantity measurement for a recipe ingredient","properties":{"amount":{"description":"Numerical amount of the ingredient","format":"double","type":"number"},"unit":{"description":"Unit of measurement for the ingredient","type":"string"}},"required":["amount","unit"],"type":"object"},"BrandedRecipeWidget":{"description":"Main widget structure for displaying a branded recipe","properties":{"availableProductAsins":{"description":"List of available product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"desktopMedia":{"$ref":"#/components/schemas/BrandedRecipeMedia"},"directions":{"description":"List of preparation directions for the recipe","items":{"$ref":"#/components/schemas/BrandedRecipeDirection"},"maxItems":500,"minItems":0,"type":"array"},"encodedIngredientComposition":{"description":"Encoded string containing ingredient composition details","type":"string"},"ingredientMetadata":{"description":"Metadata associated with recipe ingredients","items":{"$ref":"#/components/schemas/BrandedRecipeIngredientsMetadata"},"maxItems":500,"minItems":0,"type":"array"},"ingredients":{"description":"List of ingredients required for the recipe","items":{"$ref":"#/components/schemas/BrandedRecipeIngredient"},"maxItems":500,"minItems":0,"type":"array"},"isInitialLoad":{"description":"Flag indicating if recipe is set to initial load","type":"boolean"},"mobileMedia":{"$ref":"#/components/schemas/BrandedRecipeMedia"},"preparationTime":{"description":"Time required to prepare the recipe","type":"string"},"refTag":{"description":"REF tracking tag for the branded recipe","type":"string"},"servingSize":{"description":"Number of servings the recipe yields","format":"double","type":"number"},"title":{"description":"Title of the recipe","type":"string"}},"required":["preparationTime","servingSize"],"type":"object"},"Budget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/BudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"BudgetAllocation":{"description":"**BudgetAllocation Enum:**\n\n| BudgetAllocation | Description |\n|------|------|\n| `AUTO` | Automatically allocate budget to better performing ad groups based on the selected goal KPI. |\n| `MANUAL` | Manually allocate budget across ad groups. |\n","enum":["AUTO","MANUAL"],"type":"string"},"BudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"flightBudgetRolloverStrategy":{"$ref":"#/components/schemas/RolloverStrategy"},"marketplaceBudgetAllocation":{"$ref":"#/components/schemas/MarketplaceBudgetAllocation"},"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/OffAmazonBudgetControlStrategy"}},"type":"object"},"BudgetType":{"enum":["IMPRESSION","MONETARY"],"type":"string"},"BudgetValue":{"oneOf":[{"properties":{"impressionBudgetValue":{"$ref":"#/components/schemas/ImpressionBudgetValue"}},"required":["impressionBudgetValue"],"title":"impressionBudgetValue","type":"object"},{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/MonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"BusinessDetail":{"description":"The business details of advertising account.","format":"password","properties":{"address":{"$ref":"#/components/schemas/Address"},"addressToken":{"description":"The token of the business address being linked.","type":"string"},"businessRegistrationNumber":{"description":"The business registration number of the business.","type":"string"},"website":{"description":"The website of the business.","type":"string"}},"type":"object"},"CTI":{"properties":{"category":{"description":"Category identifier.","type":"string"},"item":{"description":"Item identifier.","type":"string"},"type":{"description":"Type identifier.","type":"string"}},"type":"object"},"Campaign":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adomains":{"description":"OpenRTB standard naming meaning: Advertiser domain for block list checking. This can be an array of strings for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.","items":{"type":"string"},"maxItems":2,"minItems":0,"type":"array"},"autoCreationSettings":{"$ref":"#/components/schemas/AutoCreationSettings"},"autoScaleGlobalCampaign":{"$ref":"#/components/schemas/AutoScaleGlobalCampaignSetting"},"brandId":{"description":"This is the ID of the brand that the campaign is associated with.","type":"string"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/Budget"},"maxItems":2,"minItems":0,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"costType":{"$ref":"#/components/schemas/CostType"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":249,"minItems":0,"type":"array"},"creationDateTime":{"description":"The date time that the campaign was created.","format":"date-time","type":"string"},"eligibleAutomatedTargetingTactics":{"description":"List of tactic type and inventory type pairs that are eligible for use with this campaign","items":{"$ref":"#/components/schemas/TacticKey"},"maxItems":20,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"fees":{"description":"Any fees associated with the campaign.","items":{"$ref":"#/components/schemas/CampaignFee"},"maxItems":1,"minItems":0,"type":"array"},"flights":{"description":"Flight details associated with the campaign.","items":{"$ref":"#/components/schemas/CampaignFlight"},"maxItems":150,"minItems":0,"type":"array"},"frequencies":{"description":"Any frequency caps associated with the campaign.","items":{"$ref":"#/components/schemas/Frequency"},"maxItems":3,"minItems":0,"type":"array"},"globalCampaignId":{"description":"The global campaign identifier that manages this marketplace campaign.","type":"string"},"ineligibleAutomatedTargetingTactics":{"description":"List of tactic type and inventory type pairs that are ineligible for use with this campaign, along with reasons for ineligibility","items":{"$ref":"#/components/schemas/IneligibleAutomatedTargetingTactic"},"maxItems":20,"minItems":0,"type":"array"},"isMultiAdGroupsEnabled":{"description":"A read-only field that indicates whether a campaign supports multiple adGroups.","type":"boolean"},"lastUpdatedDateTime":{"description":"The date time that the campaign was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate \u00272024-06-01\u0027 but needs to be PAUSED in DE with startDateTime \u00272024-06-02\u0027 marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: \u00272024-06-02\u0027}}]. When a marketplace-specific override is not provided, the campaign\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceCampaignConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"This represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. ADSP campaigns can be created by specifying either countries or marketplaces, but at least one of these attributes must be provided. In ADSP, this field acts as an implicit filter on your inventory targets. For example, if you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/CampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the campaign.","type":"string"},"salesChannel":{"$ref":"#/components/schemas/SalesChannel"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"},"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":["adProduct","campaignId","creationDateTime","lastUpdatedDateTime","name","state"],"type":"object"},"CampaignAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adomains":{"description":"OpenRTB standard naming meaning: Advertiser domain for block list checking. This can be an array of strings for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.","items":{"type":"string"},"maxItems":2,"minItems":0,"type":"array"},"autoCreationSettings":{"$ref":"#/components/schemas/CreateAutoCreationSettings"},"brandId":{"description":"This is the ID of the brand that the campaign is associated with.","type":"string"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/CreateBudget"},"maxItems":2,"minItems":0,"type":"array"},"costType":{"$ref":"#/components/schemas/CostType"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":249,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"fees":{"description":"Any fees associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFee"},"maxItems":1,"minItems":0,"type":"array"},"flights":{"description":"Flight details associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFlight"},"maxItems":150,"minItems":0,"type":"array"},"frequencies":{"description":"Any frequency caps associated with the campaign.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate \u00272024-06-01\u0027 but needs to be PAUSED in DE with startDateTime \u00272024-06-02\u0027 marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: \u00272024-06-02\u0027}}]. When a marketplace-specific override is not provided, the campaign\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceCampaignConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"This represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. ADSP campaigns can be created by specifying either countries or marketplaces, but at least one of these attributes must be provided. In ADSP, this field acts as an implicit filter on your inventory targets. For example, if you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/CreateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the campaign.","type":"string"},"salesChannel":{"$ref":"#/components/schemas/SalesChannel"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["adProduct","name","state"],"type":"object"},"CampaignFee":{"properties":{"feeType":{"$ref":"#/components/schemas/CampaignFeeType"},"feeValue":{"description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/CampaignFeeValueType"}},"required":["feeType","feeValue","feeValueType"],"type":"object"},"CampaignFeeType":{"description":"**CampaignFeeType Enum:**\n\n| CampaignFeeType | Description |\n|------|------|\n| `AGENCY` | A service fee that is subtracted from the campaign budget as a percent of budget. |\n","enum":["AGENCY"],"type":"string"},"CampaignFeeValueType":{"description":"**CampaignFeeValueType Enum:**\n\n| CampaignFeeValueType | Description |\n|------|------|\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |\n","enum":["PERCENTAGE_OF_BUDGET"],"type":"string"},"CampaignFlight":{"properties":{"budget":{"$ref":"#/components/schemas/FlightBudget"},"endDateTime":{"description":"The end date of the flight.","format":"date-time","type":"string"},"flightId":{"description":"The ID associated with the flight.","type":"string"},"name":{"description":"The name of the flight.","type":"string"},"startDateTime":{"description":"The start date of the flight.","format":"date-time","type":"string"}},"required":["budget","endDateTime","startDateTime"],"type":"object"},"CampaignGoalFilter":{"properties":{"include":{"description":"**Goal Enum:**\n| Goal | Description |\n| --- | --- |\n| `AWARENESS` | Indicates a goal of driving awareness. |\n| `CONSIDERATION` | Indicates a goal of driving consideration. |\n| `CONVERSIONS` | Indicates a goal of driving conversions. |","items":{"$ref":"#/components/schemas/Goal"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignLaunchFulfilmentCriterion":{"properties":{"endDateTime":{"description":"The deadline by which advertisers must create the corresponding campaign in order to qualify for the promotion offer.","format":"date-time","type":"string"},"startDateTime":{"description":"The date from which advertisers must create the corresponding campaign in order to qualify for the promotion offer.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/CriterionStatus"}},"required":["endDateTime","startDateTime","status"],"type":"object"},"CampaignMarketplaceScopeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/CampaignPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CampaignMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"CampaignMultiStatusSuccess":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["campaign","index"],"type":"object"},"CampaignNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/CampaignNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"CampaignNameFilterType":{"description":"**CampaignNameFilterType Enum:**\n| CampaignNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"CampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/BidSettings"},"budgetSettings":{"$ref":"#/components/schemas/BudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/GoalSettings"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryType"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"CampaignPartialIndex":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["campaign","errors","index"],"type":"object"},"CampaignPortfolioIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CampaignSuccessResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/Campaign"},"maxItems":5000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"CampaignUpdate":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adomains":{"description":"OpenRTB standard naming meaning: Advertiser domain for block list checking. This can be an array of strings for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.","items":{"type":"string"},"maxItems":2,"minItems":0,"type":"array"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/CreateBudget"},"maxItems":2,"minItems":0,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"costType":{"$ref":"#/components/schemas/CostType"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":249,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","nullable":true,"type":"string"},"fees":{"description":"Any fees associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFee"},"maxItems":1,"minItems":0,"type":"array"},"flights":{"description":"Flight details associated with the campaign.","items":{"$ref":"#/components/schemas/CreateCampaignFlight"},"maxItems":150,"minItems":0,"type":"array"},"frequencies":{"description":"Any frequency caps associated with the campaign.","items":{"$ref":"#/components/schemas/CreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate \u00272024-06-01\u0027 but needs to be PAUSED in DE with startDateTime \u00272024-06-02\u0027 marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: \u00272024-06-02\u0027}}]. When a marketplace-specific override is not provided, the campaign\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceCampaignConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaces":{"description":"This represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. ADSP campaigns can be created by specifying either countries or marketplaces, but at least one of these attributes must be provided. In ADSP, this field acts as an implicit filter on your inventory targets. For example, if you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"optimizations":{"$ref":"#/components/schemas/UpdateCampaignOptimizations"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","nullable":true,"type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the campaign.","nullable":true,"type":"string"},"siteRestrictions":{"description":"Restrict the ad to a particular site","items":{"$ref":"#/components/schemas/SiteRestriction"},"maxItems":1,"minItems":0,"type":"array"},"skanAppId":{"description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["campaignId"],"type":"object"},"CardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/AdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"ClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"ClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"required":["url"],"type":"object"},"ClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"ClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"CollectionLandingPageType":{"description":"**CollectionLandingPageType Enum:**\n\n| CollectionLandingPageType | Description |\n|------|------|\n| `ASIN_LIST` | A list of products based on the products promoted in the ad creative. |\n| `STORE` | A brand Store landing page. |\n","enum":["ASIN_LIST","STORE"],"type":"string"},"CommonTileProperties":{"properties":{"size":{"$ref":"#/components/schemas/StoreTileSize"},"tag":{"description":"The unique tag for the tile to help track on performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"required":["size","tag","type"],"type":"object"},"CommonWidgetProperties":{"properties":{"sectionType":{"$ref":"#/components/schemas/StoreWidgetSectionType"},"widgetTag":{"description":"The unique tag for the widget to help track on performance.","type":"string"},"widgetType":{"$ref":"#/components/schemas/StoreWidgetType"}},"required":["sectionType","widgetTag","widgetType"],"type":"object"},"ComparisonOperator":{"description":"**ComparisonOperator Enum:**\n\n| ComparisonOperator | Description |\n|------|------|\n| `EQUALS` | Exact equality match, where exactly a single value has to be provided |\n| `IN` | Exact equality match, where at least one value has to be provided |\n","enum":["EQUALS","IN"],"type":"string"},"ComparisonPredicate":{"properties":{"comparisonOperator":{"$ref":"#/components/schemas/ComparisonOperator"},"field":{"pattern":"^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$","type":"string"},"not":{"type":"boolean"},"values":{"items":{"type":"string"},"maxItems":2000,"minItems":1,"type":"array"}},"required":["comparisonOperator","field","not","values"],"type":"object"},"ComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/AssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/AutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/BrandGallerySettings"},"brandStoreSettings":{"$ref":"#/components/schemas/BrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/ManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/ProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/ProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/ResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/StoreSpotlightSettings"}},"type":"object"},"ComponentInventoryType":{"enum":["DISPLAY","NATIVE"],"type":"string"},"ComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"ComponentLandingPageType":{"description":"**ComponentLandingPageType Enum:**\n\n| ComponentLandingPageType | Description |\n|------|------|\n| `OFF_AMAZON_LINK` | An off-Amazon landing page. |\n","enum":["OFF_AMAZON_LINK"],"type":"string"},"CompositePredicate":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/Filter"},"maxItems":10,"minItems":1,"type":"array"}},"required":["filters"],"type":"object"},"Consent":{"description":"Describes consent given by the user associated with the conversion event to have their data used for advertising purposes. For EU advertisers, it is required to provide one of geo, amazonConsent, tcf, or gpp.","properties":{"amazonConsent":{"$ref":"#/components/schemas/AmazonConsentFormat"},"geo":{"$ref":"#/components/schemas/GeographicConsentData"},"gpp":{"description":"An encoded Global Privacy Platform (GPP) string describing what the user has consented to. This string encapsulates user privacy preferences and consent information in a compact format.","type":"string"},"tcf":{"description":"An encoded Transparency and Consent Framework (TCF) string describing what the user has consented to. This string contains information about user consent choices in a compressed format.","type":"string"}},"type":"object"},"ConsentStatus":{"description":"**ConsentStatus Enum:**\n| ConsentStatus | Description |\n| --- | --- |\n| `GRANTED` | Consent has been granted. |\n| `DENIED` | Consent has been denied. |","enum":["DENIED","GRANTED"],"type":"string"},"ConstituentIndexValue":{"description":"Values for a location index where the indexValue is calculated from the constituents.","properties":{"brandSales":{"description":"The brand sales value for the postal code.","format":"double","type":"number"},"categorySales":{"description":"The category sales value for the postal code.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["brandSales","categorySales","postalCode"],"type":"object"},"ConstituentIndexValues":{"properties":{"values":{"description":"List of brand and category sales values.","items":{"$ref":"#/components/schemas/ConstituentIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"ContentCategoryTarget":{"description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"description":"The content category being targeted.","type":"string"}},"required":["contentCategoryId"],"type":"object"},"ContentGenre":{"description":"Content genre for targeting. Supported values depend on the ad group\u0027s inventoryType. Using a value not supported for the given inventoryType will result in an error.\n\nSupported values per inventoryType:\n\n- `ONLINE_VIDEO`, `STREAMING_TV`, `STREAMING_TV_AMAZON_DEAL`, `VIDEO`, `LIVE_EVENTS`: ACTION, ADVENTURE, ANIMATION, BIOGRAPHY, COMEDY, CRIME, DOCUMENTARY, DRAMA, FAMILY, FANTASY, FILM_NOIR, GAME_SHOW, HISTORY, HORROR, MUSICAL, MYSTERY, NEWS, REALITY_TV, ROMANCE, SCIENCE_FICTION, SHORT, SPORT, SUPER_HERO, TALK_SHOW, THRILLER, WAR, WESTERN, GENRE_NOT_AVAILABLE\n- `AUDIO`, `AUDIO_AMAZON_DEAL`: ALTERNATIVE_ROCK, BLUES, CHILDRENS_MUSIC, CHRISTIAN_GOSPEL, CHRISTMAS_HOLIDAY, CLASSIC_ROCK, CLASSICAL, COUNTRY, DANCE_DJ, EASY_LISTENING, FOLK, HARD_ROCK_METAL, INTERNATIONAL, JAPANESE, JAZZ, LATIN_MUSIC, MISCELLANEOUS, MUSICALS_CABARET, NEW_AGE, NEWS, POP, RAP_HIP_HOP, RB, ROCK, GERMAN_ROCK_POP, EUROPEAN_POP_FOLK, SOUNDTRACKS, FRENCH_VARIETY, SPORT, COMEDY, COLLEGE_RADIO, OLDIES_ADULT_STANDARDS, REGGAE_ISLAND\n- `PODCAST`: ARTS, BUSINESS, COMEDY, EDUCATION, FICTION, GOVERNMENT, HEALTH_AND_FITNESS, HISTORY, KIDS_AND_FAMILY, LEISURE, MUSIC, NEWS, RELIGION_AND_SPIRITUALITY, SCIENCE, SOCIETY_AND_CULTURE, SPORT, TECHNOLOGY, TRUE_CRIME, TV_AND_FILM\n\n\n**ContentGenre Enum:**\n\n| ContentGenre | Description |\n|------|------|\n| `ACTION` | Action genre content. |\n| `ADVENTURE` | Adventure genre content. |\n| `ALTERNATIVE_ROCK` | Alternative rock music content. |\n| `ANIMATION` | Animation genre content. |\n| `ARTS` | Arts content. |\n| `BIOGRAPHY` | Biography genre content. |\n| `BLUES` | Blues music content. |\n| `BUSINESS` | Business content. |\n| `CHILDRENS_MUSIC` | Children\u0027s music content. |\n| `CHRISTIAN_GOSPEL` | Christian and gospel music content. |\n| `CHRISTMAS_HOLIDAY` | Christmas and holiday content. |\n| `CLASSICAL` | Classical music content. |\n| `CLASSIC_ROCK` | Classic rock music content. |\n| `COLLEGE_RADIO` | College radio content. |\n| `COMEDY` | Comedy genre content. |\n| `COUNTRY` | Country music content. |\n| `CRIME` | Crime genre content. |\n| `DANCE_DJ` | Dance and DJ music content. |\n| `DOCUMENTARY` | Documentary genre content. |\n| `DRAMA` | Drama genre content. |\n| `EASY_LISTENING` | Easy listening music content. |\n| `EDUCATION` | Education content. |\n| `EUROPEAN_POP_FOLK` | European pop and folk music content. |\n| `FAMILY` | Family genre content. |\n| `FANTASY` | Fantasy genre content. |\n| `FICTION` | Fiction genre content. |\n| `FILM_NOIR` | Film noir genre content. |\n| `FOLK` | Folk music content. |\n| `FRENCH_VARIETY` | French variety music content. |\n| `GAME_SHOW` | Game show content. |\n| `GENRE_NOT_AVAILABLE` | Content where genre is not available. |\n| `GERMAN_ROCK_POP` | German rock and pop music content. |\n| `GOVERNMENT` | Government content. |\n| `HARD_ROCK_METAL` | Hard rock and metal music content. |\n| `HEALTH_AND_FITNESS` | Health and fitness content. |\n| `HISTORY` | History genre content. |\n| `HORROR` | Horror genre content. |\n| `INTERNATIONAL` | International content. |\n| `JAPANESE` | Japanese content. |\n| `JAZZ` | Jazz music content. |\n| `KIDS_AND_FAMILY` | Kids and family content. |\n| `LATIN_MUSIC` | Latin music content. |\n| `LEISURE` | Leisure content. |\n| `MISCELLANEOUS` | Miscellaneous content. |\n| `MUSICALS_CABARET` | Musicals and cabaret content. |\n| `MUSICAL` | Musical genre content. |\n| `MUSIC` | General music content. |\n| `MYSTERY` | Mystery genre content. |\n| `NEWS` | News content. |\n| `NEW_AGE` | New age music content. |\n| `OLDIES_ADULT_STANDARDS` | Oldies and adult standards music content. |\n| `POP` | Pop music content. |\n| `RAP_HIP_HOP` | Rap and hip-hop music content. |\n| `RB` | R\u0026B music content. |\n| `REALITY_TV` | Reality TV content. |\n| `REGGAE_ISLAND` | Reggae and island music content. |\n| `RELIGION_AND_SPIRITUALITY` | Religion and spirituality content. |\n| `ROCK` | Rock music content. |\n| `ROMANCE` | Romance genre content. |\n| `SCIENCE_FICTION` | Science fiction genre content. |\n| `SCIENCE` | Science content. |\n| `SHORT` | Short-form content. |\n| `SOCIETY_AND_CULTURE` | Society and culture content. |\n| `SOUNDTRACKS` | Soundtrack music content. |\n| `SPORT` | Sports content. |\n| `SUPER_HERO` | Super hero genre content. |\n| `TALK_SHOW` | Talk show content. |\n| `TECHNOLOGY` | Technology content. |\n| `THRILLER` | Thriller genre content. |\n| `TRUE_CRIME` | True crime content. |\n| `TV_AND_FILM` | TV and film content. |\n| `WAR` | War genre content. |\n| `WESTERN` | Western genre content. |\n","enum":["ACTION","ADVENTURE","ALTERNATIVE_ROCK","ANIMATION","ARTS","BIOGRAPHY","BLUES","BUSINESS","CHILDRENS_MUSIC","CHRISTIAN_GOSPEL","CHRISTMAS_HOLIDAY","CLASSICAL","CLASSIC_ROCK","COLLEGE_RADIO","COMEDY","COUNTRY","CRIME","DANCE_DJ","DOCUMENTARY","DRAMA","EASY_LISTENING","EDUCATION","EUROPEAN_POP_FOLK","FAMILY","FANTASY","FICTION","FILM_NOIR","FOLK","FRENCH_VARIETY","GAME_SHOW","GENRE_NOT_AVAILABLE","GERMAN_ROCK_POP","GOVERNMENT","HARD_ROCK_METAL","HEALTH_AND_FITNESS","HISTORY","HORROR","INTERNATIONAL","JAPANESE","JAZZ","KIDS_AND_FAMILY","LATIN_MUSIC","LEISURE","MISCELLANEOUS","MUSIC","MUSICAL","MUSICALS_CABARET","MYSTERY","NEWS","NEW_AGE","OLDIES_ADULT_STANDARDS","POP","RAP_HIP_HOP","RB","REALITY_TV","REGGAE_ISLAND","RELIGION_AND_SPIRITUALITY","ROCK","ROMANCE","SCIENCE","SCIENCE_FICTION","SHORT","SOCIETY_AND_CULTURE","SOUNDTRACKS","SPORT","SUPER_HERO","TALK_SHOW","TECHNOLOGY","THRILLER","TRUE_CRIME","TV_AND_FILM","WAR","WESTERN"],"type":"string"},"ContentGenreTarget":{"description":"Target based on the genre of content being viewed.","properties":{"contentGenre":{"$ref":"#/components/schemas/ContentGenre"}},"required":["contentGenre"],"type":"object"},"ContentInstreamPosition":{"description":"**ContentInstreamPosition Enum:**\n\n| ContentInstreamPosition | Description |\n|------|------|\n| `MID_ROLL` | Ad plays during the main video content. |\n| `POST_ROLL` | Ad plays after the main video content. |\n| `PRE_ROLL` | Ad plays before the main video content. |\n| `UNKNOWN` | Unknown instream position. |\n","enum":["MID_ROLL","POST_ROLL","PRE_ROLL","UNKNOWN"],"type":"string"},"ContentInstreamPositionTarget":{"description":"Targets ads in the specified content instream position","properties":{"instreamPosition":{"$ref":"#/components/schemas/ContentInstreamPosition"}},"required":["instreamPosition"],"type":"object"},"ContentOutstreamPosition":{"description":"**ContentOutstreamPosition Enum:**\n\n| ContentOutstreamPosition | Description |\n|------|------|\n| `ACCOMPANYING_CONTENT` | Ad plays alongside editorial content. |\n| `INTERSTITIAL` | Ad plays between content transitions. |\n| `STANDALONE` | Ad plays as a standalone unit outside video content. |\n| `UNKNOWN` | Unknown outstream position. |\n","enum":["ACCOMPANYING_CONTENT","INTERSTITIAL","STANDALONE","UNKNOWN"],"type":"string"},"ContentOutstreamPositionTarget":{"description":"Targets ads in the specified content outstream position","properties":{"outstreamPosition":{"$ref":"#/components/schemas/ContentOutstreamPosition"}},"required":["outstreamPosition"],"type":"object"},"ContentRating":{"oneOf":[{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRating"}},"required":["dspContentRating"],"title":"dspContentRating","type":"object"},{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/TwitchContentRating"}},"required":["twitchContentRating"],"title":"twitchContentRating","type":"object"}]},"ContentRatingTarget":{"description":"Target based on the rating of content being viewed.","properties":{"contentRatingType":{"$ref":"#/components/schemas/ContentRatingTypes"},"contentRatingTypeDetails":{"$ref":"#/components/schemas/ContentRating"}},"required":["contentRatingType","contentRatingTypeDetails"],"type":"object"},"ContentRatingTypes":{"description":"**ContentRatingTypes Enum:**\n\n| ContentRatingTypes | Description |\n|------|------|\n| `DSP_CONTENT_RATING` | Content rating based on DSP content classification. |\n| `TWITCH_CONTENT_RATING` | Content rating based on Twitch content classification labels. |\n","enum":["DSP_CONTENT_RATING","TWITCH_CONTENT_RATING"],"type":"string"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ConversionType":{"description":"**ConversionType Enum:**\n| ConversionType | Description |\n| --- | --- |\n| `ADD_TO_SHOPPING_CART` | When customers add a product to their shopping cart. |\n| `APPLICATION` | When customers submit an application. |\n| `CHECKOUT` | When customers go to the checkout page. |\n| `CONTACT` | When customers provide contact information, such as email, phone number, etc. |\n| `LEAD` | When customers perform an action that initiates a sales lead. |\n| `OFF_AMAZON_PURCHASES` | When customers make a purchase for a service or product. |\n| `MOBILE_APP_FIRST_START` | When customers launch the downloaded app for the first time. |\n| `PAGE_VIEW` | When customers visit a page on your website. |\n| `SEARCH` | When customers perform a search for a product. |\n| `SIGN_UP` | When customers sign up for a product or service. |\n| `SUBSCRIBE` | When customers subscribe to your service. |\n| `OTHER` | Customer actions that don\u0027t fit the definition of the standard event types. |","enum":["ADD_TO_SHOPPING_CART","APPLICATION","CHECKOUT","CONTACT","LEAD","MOBILE_APP_FIRST_START","OFF_AMAZON_PURCHASES","OTHER","PAGE_VIEW","SEARCH","SIGN_UP","SUBSCRIBE"],"type":"string"},"Coordinates":{"properties":{"x":{"description":"X coordinate.","format":"double","type":"number"},"y":{"description":"Y coordinate.","format":"double","type":"number"}},"type":"object"},"CostType":{"description":"**CostType Enum:**\n\n| CostType | Description |\n|------|------|\n| `CPC` | Cost per click. |\n| `CPM` | Cost per thousand impressions. |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `VCPM` | Cost per thousand views. |\n","enum":["CPC","CPM","FIXED_PRICE","VCPM"],"type":"string"},"CountryCode":{"enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","OTHER","OTHER_EEA","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW","ZZ"],"type":"string"},"CreateAccountCombinationInvitationRequest":{"properties":{"accountCombinationInvitations":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitationCreate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["accountCombinationInvitations"],"type":"object"},"CreateAccountToCombine":{"description":"Represents the account-to-be-combined and its attributes.","properties":{"accountFunctions":{"description":"Defines the different ways this account will be used to combine metadata with other accounts.","items":{"$ref":"#/components/schemas/AccountFunction"},"maxItems":5,"minItems":0,"type":"array"},"accountId":{"$ref":"#/components/schemas/AccountId"}},"required":["accountId"],"type":"object"},"CreateAdAssociationRequest":{"properties":{"adAssociations":{"items":{"$ref":"#/components/schemas/AdAssociationCreate"},"maxItems":20,"minItems":1,"type":"array"}},"required":["adAssociations"],"type":"object"},"CreateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/AdExtensionCreate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["adExtensions"],"type":"object"},"CreateAdExtensionSettings":{"oneOf":[{"properties":{"promptExtension":{"$ref":"#/components/schemas/CreatePromptExtension"}},"required":["promptExtension"],"title":"promptExtension","type":"object"},{"properties":{"videoExtension":{"$ref":"#/components/schemas/CreateVideoExtension"}},"required":["videoExtension"],"title":"videoExtension","type":"object"}]},"CreateAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group.","format":"double","type":"number"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateAdGroupBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"maxAverageBid":{"description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number).","format":"double","type":"number"}},"type":"object"},"CreateAdGroupBidMarketplaceSetting":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"CreateAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"CreateAdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"}},"type":"object"},"CreateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/AdGroupCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"CreateAdInitiationTarget":{"description":"Target based on how the video ad will be started.","properties":{"videoInitiationType":{"$ref":"#/components/schemas/VideoInitiationType"}},"required":["videoInitiationType"],"type":"object"},"CreateAdPlayerSizeTarget":{"description":"Target based on the size of the ad player.","properties":{"adPlayerSize":{"$ref":"#/components/schemas/AdPlayerSize"}},"required":["adPlayerSize"],"type":"object"},"CreateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/AdCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"CreateAdSettings":{"properties":{"productAttributeSetRefinementConfigurationId":{"description":"Identifier for the product attribute configuration set associated with this ad group.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"type":"object"},"CreateAddress":{"description":"The business address of advertising account.","format":"password","properties":{"addressLine1":{"description":"The address details - 1 of business.","type":"string"},"addressLine2":{"description":"The address details - 2 of business.","type":"string"},"businessName":{"description":"The name of business.","type":"string"},"city":{"description":"The city where business is located.","type":"string"},"countryCode":{"description":"The country where business is located.","type":"string"},"phoneNumber":{"description":"The phone number of business.","type":"string"},"state":{"description":"The city where business is located.","type":"string"},"zipCode":{"description":"The zipCode where business is located.","type":"string"}},"required":["addressLine1","businessName","city","countryCode"],"type":"object"},"CreateAdvertisedProductMarketplaceSetting":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/CreateGlobalStoreSettings"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The identifier of the product advertised.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"CreateAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/CreateGlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateAdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["productIdType"],"type":"object"},"CreateAdvertiserAccountRequest":{"properties":{"advertiserAccounts":{"items":{"$ref":"#/components/schemas/AdvertiserAccountCreate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["advertiserAccounts"],"type":"object"},"CreateAdvertiserDomainList":{"description":"Targets domains based on list inherited from the advertiser.","properties":{"inheritFromAdvertiser":{"description":"Set to TRUE to inherit domain list from advertiser.","type":"boolean"}},"required":["inheritFromAdvertiser"],"type":"object"},"CreateAdvertiserProductGroupEligibilityRequest":{"properties":{"advertiserProductGroupEligibilities":{"items":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibilityCreate"},"maxItems":1,"minItems":1,"type":"array"}},"required":["advertiserProductGroupEligibilities"],"type":"object"},"CreateAdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"priceType":{"$ref":"#/components/schemas/AdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"required":["currencyCode","priceType","value"],"type":"object"},"CreateAdvertisingDealRequest":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/AdvertisingDealCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["advertisingDeals"],"type":"object"},"CreateAdvertisingDealTerms":{"description":"Terms for a deal. Supports PA \u0026 PD deals along with both spend-based guarantees (standard PG) and share-of-voice based guarantees (PG-SOV).","properties":{"budget":{"$ref":"#/components/schemas/CreateMonetaryBudget"},"price":{"$ref":"#/components/schemas/CreateAdvertisingDealPrice"}},"required":["price"],"type":"object"},"CreateAmazonConsentFormat":{"description":"Captures information as to whether a user has consented to their data being used for advertising purposes.","properties":{"amznAdStorage":{"$ref":"#/components/schemas/ConsentStatus"},"amznUserData":{"$ref":"#/components/schemas/ConsentStatus"}},"required":["amznUserData"],"type":"object"},"CreateAmazonViewability":{"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/ViewabilityTier"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"CreateAppTarget":{"description":"Target based on user application.","properties":{"appId":{"description":"The app identifier being targeted.","type":"string"},"appType":{"$ref":"#/components/schemas/AppType"}},"required":["appId","appType"],"type":"object"},"CreateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/CreateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"CreateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"CreateAssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/CreateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/CreateVideo"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateComponentLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"}},"required":["headlines"],"type":"object"},"CreateAudienceBidAdjustment":{"properties":{"audienceId":{"description":"The unique identifier of the Audience to apply bid adjustment.","type":"string"},"percentage":{"description":"The selection of the percentage change associated with a given audience and bid adjustment settings.","format":"int32","type":"integer"}},"required":["audienceId","percentage"],"type":"object"},"CreateAudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"acrossGroupOperator":{"$ref":"#/components/schemas/AcrossGroupOperator"},"audienceId":{"$ref":"#/components/schemas/CreateMarketplaceStringValue"},"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group.","type":"string"},"inGroupOperator":{"$ref":"#/components/schemas/InGroupOperator"}},"required":["audienceId"],"type":"object"},"CreateAudio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"CreateAudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"CreateAudioCreative":{"description":"| CreateAudioCreative | Description |\n| --- | --- |\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/CreateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"CreateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/CreateSharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"CreateAutoCreationSettings":{"properties":{"autoCreateTargets":{"description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised.","type":"boolean"},"autoManageCampaign":{"description":"Flag that allows Amazon to manage the lifecycle of your Campaign.","type":"boolean"}},"type":"object"},"CreateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/CreateAudienceBidAdjustment"},"maxItems":1,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/CreateCreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements. Not supported for Sponsored Brands campaigns using the SALES_UP_AND_DOWN bid strategy.","items":{"$ref":"#/components/schemas/CreatePlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/CreateShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"CreateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/CreateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"}},"type":"object"},"CreateBrandGalleryCardCreativeElement":{"properties":{"customImage":{"$ref":"#/components/schemas/CreateImage"},"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"}},"required":["customImage","headline","landingPage"],"type":"object"},"CreateBrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/CreateBrandGalleryCardCreativeElement"},"maxItems":5,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/BrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"CreateBrandSafetyCategoryTarget":{"description":"Target based on, if any, the classifications of unsuitable contexts that may pose a risk to a brand\u0027s reputation of content being viewed.","properties":{"brandSafetyCategory":{"$ref":"#/components/schemas/BrandSafetyCategory"}},"required":["brandSafetyCategory"],"type":"object"},"CreateBrandSafetyTierTarget":{"description":"Target based on the brand suitability risk levels of content being viewed.","properties":{"brandSafetyTier":{"$ref":"#/components/schemas/BrandSafetyTier"}},"required":["brandSafetyTier"],"type":"object"},"CreateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/CreateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"CreateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"CreateBrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/CreateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/CreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"CreateBrandedRecipeDirection":{"description":"Represents a single step in a recipe\u0027s directions","properties":{"body":{"description":"Detailed instruction text for the direction step","type":"string"},"title":{"description":"Title or heading for the direction step","type":"string"}},"required":["body","title"],"type":"object"},"CreateBrandedRecipeIngredient":{"description":"Represents an ingredient in a branded recipe","properties":{"asinOverrides":{"description":"List of ASIN overrides for the ingredient","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"brand":{"description":"Brand name associated with the ingredient","type":"string"},"displayText":{"description":"Formatted text for displaying the ingredient","type":"string"},"isAsinRestricted":{"description":"Flag indicating if ASIN is restricted for this ingredient","type":"boolean"},"isBrandRestricted":{"description":"Flag indicating if brand is restricted for this ingredient","type":"boolean"},"isExclusiveOverride":{"description":"Flag indicating if this ingredient has exclusive override","type":"boolean"},"name":{"description":"Name of the ingredient","type":"string"},"quantityList":{"description":"List of quantity measurements for the ingredient","items":{"$ref":"#/components/schemas/CreateBrandedRecipeQuantityItem"},"maxItems":500,"minItems":0,"type":"array"}},"required":["brand","displayText","isAsinRestricted","isBrandRestricted","isExclusiveOverride","name"],"type":"object"},"CreateBrandedRecipeIngredientsMetadata":{"description":"Contains metadata information for recipe ingredients","properties":{"priorityAsins":{"description":"List of priority ASINs for ingredients with detailed product information","items":{"$ref":"#/components/schemas/CreatePriorityAsin"},"maxItems":500,"minItems":0,"type":"array"},"quantity":{"description":"Quantity amount for the ingredient","format":"double","type":"number"},"searchText":{"description":"Search text for ingredient metadata","type":"string"},"translatedUnit":{"description":"Translated unit of measurement","type":"string"}},"type":"object"},"CreateBrandedRecipeMedia":{"description":"Represents media content associated with a recipe","properties":{"altText":{"description":"Alternative text description of the media content","type":"string"},"assetLibraryId":{"description":"Identifier for the asset.","type":"string"},"mediaUrl":{"description":"URL of the media content","type":"string"}},"type":"object"},"CreateBrandedRecipeQuantityItem":{"description":"Represents a quantity measurement for a recipe ingredient","properties":{"amount":{"description":"Numerical amount of the ingredient","format":"double","type":"number"},"unit":{"description":"Unit of measurement for the ingredient","type":"string"}},"required":["amount","unit"],"type":"object"},"CreateBrandedRecipeWidget":{"description":"Main widget structure for displaying a branded recipe","properties":{"availableProductAsins":{"description":"List of available product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"desktopMedia":{"$ref":"#/components/schemas/CreateBrandedRecipeMedia"},"directions":{"description":"List of preparation directions for the recipe","items":{"$ref":"#/components/schemas/CreateBrandedRecipeDirection"},"maxItems":500,"minItems":0,"type":"array"},"encodedIngredientComposition":{"description":"Encoded string containing ingredient composition details","type":"string"},"ingredientMetadata":{"description":"Metadata associated with recipe ingredients","items":{"$ref":"#/components/schemas/CreateBrandedRecipeIngredientsMetadata"},"maxItems":500,"minItems":0,"type":"array"},"ingredients":{"description":"List of ingredients required for the recipe","items":{"$ref":"#/components/schemas/CreateBrandedRecipeIngredient"},"maxItems":500,"minItems":0,"type":"array"},"isInitialLoad":{"description":"Flag indicating if recipe is set to initial load","type":"boolean"},"mobileMedia":{"$ref":"#/components/schemas/CreateBrandedRecipeMedia"},"preparationTime":{"description":"Time required to prepare the recipe","type":"string"},"refTag":{"description":"REF tracking tag for the branded recipe","type":"string"},"servingSize":{"description":"Number of servings the recipe yields","format":"double","type":"number"},"title":{"description":"Title of the recipe","type":"string"}},"required":["preparationTime","servingSize"],"type":"object"},"CreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/CreateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"CreateBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"flightBudgetRolloverStrategy":{"$ref":"#/components/schemas/RolloverStrategy"},"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/OffAmazonBudgetControlStrategy"}},"type":"object"},"CreateBudgetValue":{"oneOf":[{"properties":{"impressionBudgetValue":{"$ref":"#/components/schemas/CreateImpressionBudgetValue"}},"required":["impressionBudgetValue"],"title":"impressionBudgetValue","type":"object"},{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/CreateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"CreateBusinessDetail":{"description":"The business details of advertising account.","format":"password","properties":{"address":{"$ref":"#/components/schemas/CreateAddress"},"addressToken":{"description":"The token of the business address being linked.","type":"string"},"businessRegistrationNumber":{"description":"The business registration number of the business.","type":"string"},"website":{"description":"The website of the business.","type":"string"}},"type":"object"},"CreateCTI":{"properties":{"category":{"description":"Category identifier.","type":"string"},"item":{"description":"Item identifier.","type":"string"},"type":{"description":"Type identifier.","type":"string"}},"type":"object"},"CreateCampaignFee":{"properties":{"feeType":{"$ref":"#/components/schemas/CampaignFeeType"},"feeValue":{"description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/CampaignFeeValueType"}},"required":["feeType","feeValue","feeValueType"],"type":"object"},"CreateCampaignFlight":{"properties":{"budget":{"$ref":"#/components/schemas/CreateFlightBudget"},"endDateTime":{"description":"The end date of the flight.","format":"date-time","type":"string"},"flightId":{"description":"The ID associated with the flight.","type":"string"},"name":{"description":"The name of the flight.","type":"string"},"startDateTime":{"description":"The start date of the flight.","format":"date-time","type":"string"}},"required":["budget","endDateTime","startDateTime"],"type":"object"},"CreateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/CreateBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/CreateBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/CreateGoalSettings"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryType"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"CreateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"CreateCardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/CreateAdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"CreateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"required":["url"],"type":"object"},"CreateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"CreateCommonTileProperties":{"properties":{"size":{"$ref":"#/components/schemas/StoreTileSize"},"tag":{"description":"The unique tag for the tile to help track on performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"required":["size","tag","type"],"type":"object"},"CreateCommonWidgetProperties":{"properties":{"sectionType":{"$ref":"#/components/schemas/StoreWidgetSectionType"},"widgetTag":{"description":"The unique tag for the widget to help track on performance.","type":"string"},"widgetType":{"$ref":"#/components/schemas/StoreWidgetType"}},"required":["sectionType","widgetTag","widgetType"],"type":"object"},"CreateComparisonPredicate":{"properties":{"comparisonOperator":{"$ref":"#/components/schemas/ComparisonOperator"},"field":{"pattern":"^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$","type":"string"},"not":{"type":"boolean"},"values":{"items":{"type":"string"},"maxItems":2000,"minItems":1,"type":"array"}},"required":["comparisonOperator","field","not","values"],"type":"object"},"CreateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/CreateAssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/CreateAutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/CreateBrandGallerySettings"},"brandStoreSettings":{"$ref":"#/components/schemas/CreateBrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/CreateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/CreateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/CreateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/CreateResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/CreateStoreSpotlightSettings"}},"type":"object"},"CreateComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateCompositePredicate":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/CreateFilter"},"maxItems":10,"minItems":1,"type":"array"}},"required":["filters"],"type":"object"},"CreateConsent":{"description":"Describes consent given by the user associated with the conversion event to have their data used for advertising purposes. For EU advertisers, it is required to provide one of geo, amazonConsent, tcf, or gpp.","properties":{"amazonConsent":{"$ref":"#/components/schemas/CreateAmazonConsentFormat"},"geo":{"$ref":"#/components/schemas/CreateGeographicConsentData"},"gpp":{"description":"An encoded Global Privacy Platform (GPP) string describing what the user has consented to. This string encapsulates user privacy preferences and consent information in a compact format.","type":"string"},"tcf":{"description":"An encoded Transparency and Consent Framework (TCF) string describing what the user has consented to. This string contains information about user consent choices in a compressed format.","type":"string"}},"type":"object"},"CreateConstituentIndexValue":{"description":"Values for a location index where the indexValue is calculated from the constituents.","properties":{"brandSales":{"description":"The brand sales value for the postal code.","format":"double","type":"number"},"categorySales":{"description":"The category sales value for the postal code.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["brandSales","categorySales","postalCode"],"type":"object"},"CreateConstituentIndexValues":{"properties":{"values":{"description":"List of brand and category sales values.","items":{"$ref":"#/components/schemas/CreateConstituentIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"CreateContentCategoryTarget":{"description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"description":"The content category being targeted.","type":"string"}},"required":["contentCategoryId"],"type":"object"},"CreateContentGenreTarget":{"description":"Target based on the genre of content being viewed.","properties":{"contentGenre":{"$ref":"#/components/schemas/ContentGenre"}},"required":["contentGenre"],"type":"object"},"CreateContentInstreamPositionTarget":{"description":"Targets ads in the specified content instream position","properties":{"instreamPosition":{"$ref":"#/components/schemas/ContentInstreamPosition"}},"required":["instreamPosition"],"type":"object"},"CreateContentOutstreamPositionTarget":{"description":"Targets ads in the specified content outstream position","properties":{"outstreamPosition":{"$ref":"#/components/schemas/ContentOutstreamPosition"}},"required":["outstreamPosition"],"type":"object"},"CreateContentRating":{"oneOf":[{"properties":{"dspContentRating":{"$ref":"#/components/schemas/CreateDspContentRating"}},"required":["dspContentRating"],"title":"dspContentRating","type":"object"},{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/CreateTwitchContentRating"}},"required":["twitchContentRating"],"title":"twitchContentRating","type":"object"}]},"CreateContentRatingTarget":{"description":"Target based on the rating of content being viewed.","properties":{"contentRatingType":{"$ref":"#/components/schemas/ContentRatingTypes"},"contentRatingTypeDetails":{"$ref":"#/components/schemas/CreateContentRating"}},"required":["contentRatingType","contentRatingTypeDetails"],"type":"object"},"CreateCoordinates":{"properties":{"x":{"description":"X coordinate.","format":"double","type":"number"},"y":{"description":"Y coordinate.","format":"double","type":"number"}},"type":"object"},"CreateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/CreateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/CreateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/CreateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/CreateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/CreateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/CreateProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"}]},"CreateCreativeBidAdjustment":{"properties":{"creativeType":{"$ref":"#/components/schemas/CreativeBidAdjustmentType"},"percentage":{"description":"The selection of the percentage change associated with the creative type and bid adjustment settings.","format":"int32","type":"integer"}},"required":["percentage"],"type":"object"},"CreateCreativeRequirements":{"description":"Creative requirements associated with the deal.","type":"object"},"CreateCreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"CreateCriteriaCondition":{"description":"Defines list of criteria (performance etc .) based conditions.","properties":{"criteria":{"items":{"$ref":"#/components/schemas/CreateRuleCriteria"},"maxItems":1000,"minItems":1,"type":"array"},"criteriaJoinOperator":{"$ref":"#/components/schemas/JoinOperator"}},"required":["criteria","criteriaJoinOperator"],"type":"object"},"CreateCustomData":{"description":"Custom data associated with the event to provide additional context.","properties":{"dataType":{"$ref":"#/components/schemas/DataType"},"name":{"description":"Name of the custom attribute. Only letters, numbers and the underscore character are allowed. e.g. brand, category, productId.","type":"string"},"value":{"description":"Value of the custom attribute. Only letters, numbers and the underscore character are allowed.","type":"string"}},"required":["name","value"],"type":"object"},"CreateDVBrandSafetyContentCategoriesWithRiskMap":{"description":"A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","properties":{"key":{"description":"Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","type":"string"},"value":{"$ref":"#/components/schemas/BrandSuitabilityRiskLevelType"}},"required":["key","value"],"type":"object"},"CreateDataProcessingOptions":{"description":"A list of data processing options.","properties":{"options":{"$ref":"#/components/schemas/DataProcessingOption"}},"type":"object"},"CreateDatePeriod":{"properties":{"endDate":{"format":"date","type":"string"},"startDate":{"format":"date","type":"string"}},"required":["endDate","startDate"],"type":"object"},"CreateDayPartTarget":{"description":"Target based on time of day.","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"timeOfDay":{"$ref":"#/components/schemas/CreateTimeOfDay"}},"required":["dayOfWeek","timeOfDay"],"type":"object"},"CreateDeviceInfo":{"description":"Device information associated with the conversion event.","properties":{"userAgent":{"description":"Raw user agent string from the browser or app at the time of the event. Max 512 characters.","type":"string"}},"type":"object"},"CreateDeviceTarget":{"description":"Target based on user device.","properties":{"deviceOrientation":{"$ref":"#/components/schemas/DeviceOrientation"},"deviceType":{"$ref":"#/components/schemas/DeviceType"},"mobileDevice":{"$ref":"#/components/schemas/MobileDevice"},"mobileEnvironment":{"$ref":"#/components/schemas/MobileEnvironment"},"mobileOs":{"$ref":"#/components/schemas/MobileOs"}},"required":["deviceType"],"type":"object"},"CreateDimensionCriteria":{"description":"Defines dimension-based targeting criteria using generic dimension filters.","properties":{"dimensionJoinOperator":{"$ref":"#/components/schemas/JoinOperator"},"dimensions":{"description":"List of dimension filters to match.","items":{"$ref":"#/components/schemas/CreateGenericDimension"},"maxItems":100,"minItems":1,"type":"array"}},"required":["dimensionJoinOperator","dimensions"],"type":"object"},"CreateDimensionRuleAction":{"description":"The action to apply when dimension rule conditions are met.\n\n| CreateDimensionRuleAction | Description |\n|------|------|\n| `tierAdjustment` | An ordinal tier adjustment. |\n| `valueAdjustment` | A numeric value adjustment. |\n","oneOf":[{"properties":{"tierAdjustment":{"$ref":"#/components/schemas/CreateTierAdjustment"}},"required":["tierAdjustment"],"title":"tierAdjustment","type":"object"},{"properties":{"valueAdjustment":{"$ref":"#/components/schemas/CreateValueAdjustment"}},"required":["valueAdjustment"],"title":"valueAdjustment","type":"object"}]},"CreateDimensionRuleCondition":{"description":"The set of conditions defined for a dimension rule.","properties":{"criteriaCondition":{"$ref":"#/components/schemas/CreateCriteriaCondition"}},"required":["criteriaCondition"],"type":"object"},"CreateDimensionRuleExpression":{"description":"Dimension-based bid rule expression with conditions and actions.","properties":{"actions":{"$ref":"#/components/schemas/CreateDimensionRuleAction"},"conditions":{"$ref":"#/components/schemas/CreateDimensionRuleCondition"}},"required":["actions","conditions"],"type":"object"},"CreateDirectIndexValue":{"description":"Values for a location index where the indexValue is the pre-calculated index.","properties":{"indexValue":{"description":"The pre-calculated index value.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["indexValue","postalCode"],"type":"object"},"CreateDirectIndexValues":{"properties":{"values":{"description":"List of direct index values.","items":{"$ref":"#/components/schemas/CreateDirectIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"CreateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"CreateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/CreateStandardDisplaySettings"}},"type":"object"},"CreateDomainFileTarget":{"description":"Targets domains based on list provided via file upload.","properties":{"domainFileKey":{"description":"The S3 key of the uploaded file which can be obtained from the file upload policy endpoint. A max of 10 files may be associated to one ad group.","type":"string"},"domainFileName":{"description":"The name of the file.","type":"string"}},"required":["domainFileKey","domainFileName"],"type":"object"},"CreateDomainListTarget":{"description":"Targets domains based on an existing domain list.","properties":{"domainListId":{"description":"The ID of the domain list to target.","type":"string"}},"required":["domainListId"],"type":"object"},"CreateDomainNameTarget":{"description":"Targets domains based on URL.","properties":{"domainName":{"description":"The URL of the domain to target.","type":"string"}},"required":["domainName"],"type":"object"},"CreateDomainTarget":{"description":"Target based on a specified domain.","properties":{"domainTargetDetails":{"$ref":"#/components/schemas/CreateDomainTargetDetails"},"domainTargetType":{"$ref":"#/components/schemas/DomainTargetTypes"}},"required":["domainTargetDetails","domainTargetType"],"type":"object"},"CreateDomainTargetDetails":{"oneOf":[{"properties":{"domainListTarget":{"$ref":"#/components/schemas/CreateDomainListTarget"}},"required":["domainListTarget"],"title":"domainListTarget","type":"object"},{"properties":{"domainNameTarget":{"$ref":"#/components/schemas/CreateDomainNameTarget"}},"required":["domainNameTarget"],"title":"domainNameTarget","type":"object"},{"properties":{"domainFileTarget":{"$ref":"#/components/schemas/CreateDomainFileTarget"}},"required":["domainFileTarget"],"title":"domainFileTarget","type":"object"},{"properties":{"advertiserDomainList":{"$ref":"#/components/schemas/CreateAdvertiserDomainList"}},"required":["advertiserDomainList"],"title":"advertiserDomainList","type":"object"}]},"CreateDoubleVerifyAuthenticAttention":{"properties":{"universalAttention":{"description":"One omni-channel segment that is informed by data from all DV campaigns to help avoid serving ads on generally poor performing apps and domains.","type":"boolean"}},"required":["universalAttention"],"type":"object"},"CreateDoubleVerifyAuthenticBrandSafety":{"properties":{"doubleVerifySegmentId":{"pattern":"^51[0-9]{6}$","type":"string"}},"type":"object"},"CreateDoubleVerifyBrandSafety":{"properties":{"appAgeRating":{"description":"A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.","items":{"$ref":"#/components/schemas/DVBrandSafetyAppAgeRatingType"},"maxItems":50,"minItems":0,"type":"array"},"appStarRating":{"$ref":"#/components/schemas/DVBrandSafetyAppStarRatingType"},"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/CreateDVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"excludeAppsWithInsufficientRating":{"description":"Set to true to exclude unofficial apps or apps with insufficient user ratings (\u003c100 lifetime).","type":"boolean"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"CreateDoubleVerifyCustomContextualSegmentId":{"properties":{"doubleVerifySegmentId":{"pattern":"^52[0-9]{6}$","type":"string"}},"type":"object"},"CreateDoubleVerifyFraudInvalidTraffic":{"properties":{"blockAppAndSites":{"description":"Set to true to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen.","type":"boolean"},"excludeAppsAndSites":{"$ref":"#/components/schemas/ExcludeAppsAndSitesType"},"excludeImpressions":{"description":"Set to true to exclude impressions delivered to devices identified to be fraudulent or invalid.","type":"boolean"}},"type":"object"},"CreateDoubleVerifyStandardDisplayBrandSafety":{"properties":{"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/CreateDVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"CreateDoubleVerifyViewability":{"properties":{"averageCompletionAndFullyViewableRateTargeting":{"$ref":"#/components/schemas/AverageCompletionAndFullyViewableRateTargetingType"},"brandExposureViewabilityTargeting":{"$ref":"#/components/schemas/BrandExposureViewabilityTargetingType"},"includeUnmeasurableImpressions":{"description":"Set to true to include impressions where impressions can\u0027t be measured.","type":"boolean"},"mrcViewabilityTargeting":{"$ref":"#/components/schemas/MrcViewabilityTargetingType"}},"type":"object"},"CreateDspContentRating":{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRatingEnum"}},"required":["dspContentRating"],"type":"object"},"CreateEventDescription":{"description":"The composite key that uniquely identifies an event.","properties":{"conversionType":{"$ref":"#/components/schemas/ConversionType"},"dataSetName":{"description":"Event DataSet name to which this event should be added to.","pattern":"[A-Za-z][A-Za-z0-9_-]*","type":"string"},"eventIngestionMethod":{"$ref":"#/components/schemas/EventIngestionMethod"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"name":{"description":"The name of the imported event.","type":"string"}},"required":["conversionType","eventIngestionMethod","eventSource","name"],"type":"object"},"CreateEventRequest":{"properties":{"events":{"items":{"$ref":"#/components/schemas/EventCreate"},"maxItems":500,"minItems":1,"type":"array"}},"required":["events"],"type":"object"},"CreateFee":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"feeType":{"$ref":"#/components/schemas/FeeType"},"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, 100 represents 100%.","format":"double","type":"number"},"thirdPartyProvider":{"$ref":"#/components/schemas/FeesThirdPartyProvider"}},"required":["addToBudgetSpentAmount","feeType","feeValue","thirdPartyProvider"],"type":"object"},"CreateFilter":{"oneOf":[{"properties":{"and":{"$ref":"#/components/schemas/CreateCompositePredicate"}},"required":["and"],"title":"and","type":"object"},{"properties":{"on":{"$ref":"#/components/schemas/CreateComparisonPredicate"}},"required":["on"],"title":"on","type":"object"}]},"CreateFlightBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/CreateBudgetValue"}},"required":["budgetType","budgetValue"],"type":"object"},"CreateFoldPositionTarget":{"description":"Targets ads in the specified fold position","properties":{"foldPosition":{"$ref":"#/components/schemas/FoldPosition"}},"required":["foldPosition"],"type":"object"},"CreateFormatProperties":{"properties":{"applyBorder":{"description":"Apply a boarder to the image to fit rules for some supplies.","type":"boolean"},"height":{"description":"The height (in pixels) of the cropped image.","format":"int32","type":"integer"},"left":{"description":"The number of pixels from the left of the image where the crop should begin.","format":"int32","type":"integer"},"top":{"description":"The number of pixels from the top of the image where the crop should begin.","format":"int32","type":"integer"},"width":{"description":"The width (in pixels) of the cropped image.","format":"int32","type":"integer"}},"type":"object"},"CreateFrequency":{"properties":{"eventMaxCount":{"description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500.","format":"int32","maximum":99000,"minimum":1,"type":"integer"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/FrequencyTargetingSetting"},"timeCount":{"description":"The value associated with the time and unit of time for this frequency cap.","format":"int32","maximum":60,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/TimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting","timeCount","timeUnit"],"type":"object"},"CreateGenericDimension":{"description":"A generic dimension filter. Uses string-based dimension types to avoid schema changes when new targeting dimensions are added.","properties":{"dimensionType":{"description":"The type of dimension (e.g., DEVICE_TYPE, BROWSER, REGION, OPERATING_SYSTEM).","type":"string"},"dimensionValues":{"description":"The values to match for this dimension (e.g., [phone, tablet] for DEVICE_TYPE).","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"negative":{"description":"If true, applies NOT operator to this dimension filter. Default is false.","type":"boolean"}},"required":["dimensionType","dimensionValues"],"type":"object"},"CreateGeoLocationCoordinates":{"description":"Coordinates for a point of interest","properties":{"latitude":{"description":"Latitude coordinate. Example 47.6157","format":"double","type":"number"},"longitude":{"description":"Longitude coordinate. Example 122.339","format":"double","type":"number"}},"required":["latitude","longitude"],"type":"object"},"CreateGeoLocationRequest":{"properties":{"geoLocations":{"items":{"$ref":"#/components/schemas/GeoLocationCreate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["geoLocations"],"type":"object"},"CreateGeoLocationUnion":{"oneOf":[{"properties":{"radiusLocation":{"$ref":"#/components/schemas/CreateRadiusLocation"}},"required":["radiusLocation"],"title":"radiusLocation","type":"object"},{"properties":{"smartLocation":{"$ref":"#/components/schemas/CreateSmartLocation"}},"required":["smartLocation"],"title":"smartLocation","type":"object"}]},"CreateGeographicConsentData":{"description":"Captures the user\u0027s geographic information for purposes of consent checking.","properties":{"ipAddress":{"description":"IP address of the user associated with the conversion event.","type":"string"}},"required":["ipAddress"],"type":"object"},"CreateGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"CreateGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"},"kpiValue":{"description":"The value of the KPI that the campaign is working to optimize.","format":"double","type":"number"}},"required":["kpi"],"type":"object"},"CreateImage":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/CreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"CreateImpressionBudgetValue":{"properties":{"impression":{"description":"The impression cap of the budget cap.","format":"double","type":"number"}},"required":["impression"],"type":"object"},"CreateIndexValues":{"oneOf":[{"properties":{"directIndexValues":{"$ref":"#/components/schemas/CreateDirectIndexValues"}},"required":["directIndexValues"],"title":"directIndexValues","type":"object"},{"properties":{"constituentIndexValues":{"$ref":"#/components/schemas/CreateConstituentIndexValues"}},"required":["constituentIndexValues"],"title":"constituentIndexValues","type":"object"}]},"CreateIntegralAdScienceBrandSafety":{"properties":{"excludeContent":{"description":"Set to true to exclude content that Integral Ad Science is not able to rate.","type":"boolean"},"iasBrandSafetyAdult":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyAlcohol":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyGambling":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyHateSpeech":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDownloads":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDrugs":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyOffensiveLanguage":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyViolence":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"}},"type":"object"},"CreateIntegralAdScienceContextualAvoidance":{"properties":{"avoidanceSegments":{"description":"The unique identifier of the IAS contextual avoidance segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"CreateIntegralAdScienceContextualTargeting":{"properties":{"topicalSegments":{"description":"The unique identifier of the IAS contextual topical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"},"verticalSegments":{"description":"The unique identifier of the IAS contextual vertical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"CreateIntegralAdScienceFraudInvalidTraffic":{"properties":{"targetSetting":{"$ref":"#/components/schemas/IASFraudInvalidTrafficType"}},"type":"object"},"CreateIntegralAdScienceQualitySync":{"properties":{"segmentId":{"pattern":"^4[0-9]{6}$","type":"string"}},"type":"object"},"CreateIntegralAdScienceViewability":{"description":"The IAS viewability standard.","properties":{"standard":{"$ref":"#/components/schemas/IASViewabilityStandardType"},"viewabilityTargeting":{"$ref":"#/components/schemas/ViewabilityTierType"}},"required":["standard"],"type":"object"},"CreateInventorySourceTarget":{"description":"Target based on the source of the inventory.","properties":{"inventorySourceId":{"$ref":"#/components/schemas/CreateMarketplaceStringValue"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceType"}},"required":["inventorySourceId","inventorySourceType"],"type":"object"},"CreateKeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target. For valid characters and constraints, [see keyword character constraints](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#keyword-character-constraints).","type":"string"},"matchType":{"$ref":"#/components/schemas/KeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"CreateLandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["asins"],"type":"object"},"CreateLearnMoreVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/VideoCallToActionPosition"},"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["position","url"],"type":"object"},"CreateLinearTvIncrementalReachForecastRequest":{"properties":{"linearTvIncrementalReachForecasts":{"items":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecastCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["linearTvIncrementalReachForecasts"],"type":"object"},"CreateLinearTvInventoryAllocation":{"description":"Linear TV Inventory Allocation","properties":{"grossRatingPoint":{"description":"Gross Rating Point (GRP) for the Linear TV inventory.","format":"double","type":"number"},"inventoryType":{"$ref":"#/components/schemas/LinearTvInventoryType"},"linearTvDaypartId":{"description":"A unique identifier of the daypart associated with the Linear TV inventory.","type":"string"}},"required":["grossRatingPoint","inventoryType","linearTvDaypartId"],"type":"object"},"CreateLinearTvReachForecastRequest":{"properties":{"linearTvReachForecasts":{"items":{"$ref":"#/components/schemas/LinearTvReachForecastCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["linearTvReachForecasts"],"type":"object"},"CreateLocationIndexRequest":{"properties":{"locationIndexes":{"items":{"$ref":"#/components/schemas/LocationIndexCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["locationIndexes"],"type":"object"},"CreateLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"},"locationIdResolved":{"description":"A human-readable location text. It\u0027s a read-only field.","type":"string"}},"required":["locationId"],"type":"object"},"CreateManagerAccountRequest":{"properties":{"managerAccounts":{"items":{"$ref":"#/components/schemas/ManagerAccountCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["managerAccounts"],"type":"object"},"CreateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/CreateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/CreateSharedCollectionSettings"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","type":"string"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"CreateMarketplaceAdConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceAdFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceAdFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CreateMarketplaceAdGroupConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceAdGroupFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceAdGroupFieldOverrides":{"properties":{"name":{"description":"The name of the ad group for this marketplace","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Marketplace specific tags for the ad group","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CreateMarketplaceCampaignConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceCampaignFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceCampaignFieldOverrides":{"properties":{"endDateTime":{"description":"The end date time for the campaign","format":"date-time","type":"string"},"name":{"description":"The name of the campaign","type":"string"},"optimizations":{"$ref":"#/components/schemas/CreateCampaignOptimizations"},"startDateTime":{"description":"The start date time for the campaign","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CreateMarketplaceStringValue":{"properties":{"defaultValue":{"description":"The default value. Either the default value or the marketplace settings should always be specified","type":"string"}},"type":"object"},"CreateMarketplaceTargetConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceTargetFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceTargetFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/CreateOverridableTargets"}},"type":"object"},"CreateMatchKey":{"description":"The identifier used to match people for attribution. PII-based match key data needs to be normalized and hashed (SHA-256). REAL_ID, MERKLE_ID, KANTAR_ID, and FIP accept raw identifier values. Email addresses provided must follow the formatting guidelines: Lowercase, remove all non-alphanumeric characters [a-zA-Z0-9] and [.@-], and remove any leading or trailing whitespace.","properties":{"type":{"$ref":"#/components/schemas/MatchKeyType"},"values":{"description":"Identifier value of the customer who performed the event. SHA-256 hashed for PII-based keys; raw value for REAL_ID, MERKLE_ID, KANTAR_ID, and FIP.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["type","values"],"type":"object"},"CreateMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"CreateMonetaryBudgetMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"monetaryBudget":{"$ref":"#/components/schemas/CreateMonetaryBudget"}},"required":["marketplace","monetaryBudget"],"type":"object"},"CreateMonetaryBudgetValue":{"properties":{"marketplaceSettings":{"description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateMonetaryBudgetMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"monetaryBudget":{"$ref":"#/components/schemas/CreateMonetaryBudget"}},"type":"object"},"CreateNativeContentPositionTarget":{"description":"Targets ads to a specific native content position","properties":{"nativePosition":{"$ref":"#/components/schemas/NativeContentPosition"}},"required":["nativePosition"],"type":"object"},"CreateNewsGuardBrandGuardMisinformationSafety":{"properties":{"avoidanceList":{"description":"The unique identifiers of misinformation targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardMisinformationSafetyType"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"CreateNewsGuardBrandGuardTrustedNewsTargeting":{"description":"Only applicable for Web supply.","properties":{"targetingList":{"description":"The unique identifiers of trusted news targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardTrustedNewsTargetingType"},"maxItems":15,"minItems":0,"type":"array"}},"type":"object"},"CreateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/CreateVideo"}},"required":["language","videos"],"type":"object"},"CreateOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/CreateAdGroupBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/CreateAdGroupGoalSettings"}},"type":"object"},"CreateOverridableTargets":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/CreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/CreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"CreatePacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DeliveryProfile"}},"required":["deliveryProfile"],"type":"object"},"CreatePixalateFraudInvalidTraffic":{"properties":{"excludeAppsAndDomains":{"description":"Set to true to exclude traffic from Apps and Domains identified to be fraudulent or invalid.","type":"boolean"},"excludeIpAddressAndUserAgents":{"description":"Set to true to exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid.","type":"boolean"},"excludeOttAndMobileDevices":{"description":"Set to true to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid.","type":"boolean"},"excludeRemovedAppsFromAppStores":{"description":"Set to true to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months.","type":"boolean"}},"type":"object"},"CreatePlacementBidAdjustment":{"properties":{"percentage":{"description":"The selection of the percentage change associated with a given placement and bid adjustment settings.","format":"int32","type":"integer"},"placement":{"$ref":"#/components/schemas/Placement"}},"required":["percentage","placement"],"type":"object"},"CreatePlacementTypeTarget":{"description":"Target based on the placement type.","properties":{"placementType":{"$ref":"#/components/schemas/PlacementType"}},"required":["placementType"],"type":"object"},"CreatePriorityAsin":{"description":"Product information for a priority ASIN","properties":{"addToCartActionParams":{"description":"Parameters for add to cart action","type":"string"},"bottleDepositFee":{"description":"Bottle deposit fee amount","type":"string"},"bottleDepositFeeString":{"description":"Bottle deposit fee as string","type":"string"},"cartQuantity":{"description":"Quantity of this item in the cart","format":"double","type":"number"},"catalogDisplayPricePerUnitOfMeasure":{"description":"Price per unit of measure for display","type":"string"},"freshButton":{"description":"Fresh button information","type":"string"},"isAlternateSearchResult":{"description":"Flag indicating if this is an alternate search result","type":"boolean"},"isRequiredQuantityInCart":{"description":"Flag indicating if a quantity is required in cart","type":"boolean"},"isSoldByCount":{"description":"Flag indicating if the product is sold by count","type":"boolean"},"itemAvailability":{"description":"Status of item availability","type":"string"},"offerId":{"description":"Unique identifier for the offer","type":"string"},"offerName":{"description":"Display name of the product offer","type":"string"},"offerUnit":{"description":"Unit of the offer (e.g., Fl Oz, lb)","type":"string"},"productAsin":{"description":"ASIN associated with this product","type":"string"},"productDetailsUrl":{"description":"URL to the product details page","type":"string"},"productImageUrl":{"description":"URL of the product image","type":"string"},"promotionDisplay":{"description":"Display text for active promotion","type":"string"},"promotionId":{"description":"Identifier for active promotion","type":"string"},"quantityInStock":{"description":"Available quantity in stock","format":"double","type":"number"},"requiredQuantity":{"description":"Required quantity for purchase","format":"double","type":"number"},"retailATCButton":{"description":"Retail add-to-cart button information","type":"string"},"reviewStars":{"$ref":"#/components/schemas/CreateReviewStars"},"searchTerm":{"description":"Search term associated with this product","type":"string"},"subtotalParams":{"description":"Subtotal parameters for pricing calculations","type":"string"},"vuomDisplayPrice":{"description":"Display price for virtual unit of measure","type":"string"}},"required":["addToCartActionParams","cartQuantity","isAlternateSearchResult","isRequiredQuantityInCart","isSoldByCount","itemAvailability","offerId","offerName","offerUnit","productAsin","productDetailsUrl","productImageUrl","requiredQuantity","subtotalParams","vuomDisplayPrice"],"type":"object"},"CreateProductAudienceTarget":{"description":"Target customers who have viewed or purchased a certain product within a specified lookback window.","properties":{"asin":{"$ref":"#/components/schemas/CreateMarketplaceStringValue"},"event":{"$ref":"#/components/schemas/TargetEvent"},"lookback":{"$ref":"#/components/schemas/Lookback"},"matchType":{"$ref":"#/components/schemas/ProductAudienceMatchType"}},"required":["asin","event","lookback","matchType"],"type":"object"},"CreateProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productAgeRangeIdResolved":{"description":"The resolved age range to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productBrandIdResolved":{"description":"The resolved name of the brand.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productCategoryIdResolved":{"description":"The resolved product category.","type":"string"},"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"CreateProductCategoryRefinementMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productCategoryRefinement":{"$ref":"#/components/schemas/CreateProductCategoryRefinement"}},"required":["marketplace","productCategoryRefinement"],"type":"object"},"CreateProductCategoryRefinementValue":{"properties":{"marketplaceSettings":{"description":"Marketplace specific product category refinements. Either the value or the marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateProductCategoryRefinementMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productCategoryRefinement":{"$ref":"#/components/schemas/CreateProductCategoryRefinement"}},"type":"object"},"CreateProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"matchType":{"$ref":"#/components/schemas/ProductCategoryMatchType"},"productCategoryRefinement":{"$ref":"#/components/schemas/CreateProductCategoryRefinementValue"},"productGenreRefinement":{"$ref":"#/components/schemas/CreateProductGenreRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"CreateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/CreateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"CreateProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"required":["brand","brandLogos","customImages","headlines","landingPage"],"type":"object"},"CreateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/CreateProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"CreateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/CreateSpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"CreateProductGenreRefinement":{"properties":{"productGenreId":{"description":"The product genre ID to target.","type":"string"}},"required":["productGenreId"],"type":"object"},"CreateProductMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The product id applicable at the specified marketplace.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"CreateProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/ProductMatchType"},"product":{"$ref":"#/components/schemas/CreateProductValue"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"CreateProductValue":{"properties":{"marketplaceSettings":{"description":"The product ids at specific marketplace level. Either the product id or the marketplace settings should always be specified","items":{"$ref":"#/components/schemas/CreateProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"CreateProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":2,"minItems":1,"type":"array"}},"required":["videos"],"type":"object"},"CreatePromotionCodeRedemptionRequest":{"properties":{"promotionCodeRedemptions":{"items":{"$ref":"#/components/schemas/PromotionCodeRedemptionCreate"},"maxItems":5,"minItems":1,"type":"array"}},"required":["promotionCodeRedemptions"],"type":"object"},"CreatePromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"CreateRadiusLocation":{"description":"Configuration for a radius-based location. A minimum radius of 0.37 miles (2000 ft, 0.6km) is required.","properties":{"coordinates":{"$ref":"#/components/schemas/CreateGeoLocationCoordinates"},"pointOfInterestAddress":{"description":"Address. Example \u00272111 7th Ave, Seattle, WA 98121, United States\u0027 or \u0027Amazon Spheres\u0027","type":"string"},"pointOfInterestRadius":{"description":"Radius of circle in kilometers or miles","format":"double","type":"number"},"units":{"$ref":"#/components/schemas/DistanceUnit"}},"required":["pointOfInterestRadius","units"],"type":"object"},"CreateReachForecastBudgetAllocation":{"properties":{"budget":{"$ref":"#/components/schemas/CreateBudget"},"reachForecastId":{"description":"The identifier for the Reach Forecast.","type":"string"}},"required":["budget","reachForecastId"],"type":"object"},"CreateRejectedReasonDetail":{"description":"The details to explain rejected eligibility request status which contains code and description.","properties":{"code":{"$ref":"#/components/schemas/RejectedReasonDetailCode"},"description":{"description":"The description to explain rejected eligibility request status.","type":"string"}},"required":["code","description"],"type":"object"},"CreateReportPeriod":{"oneOf":[{"properties":{"datePeriod":{"$ref":"#/components/schemas/CreateDatePeriod"}},"required":["datePeriod"],"title":"datePeriod","type":"object"}]},"CreateReportRequest":{"properties":{"accessRequestedAccounts":{"items":{"$ref":"#/components/schemas/ReportCreateAccessRequestedAccountItem"},"maxItems":2000,"minItems":1,"type":"array"},"reports":{"items":{"$ref":"#/components/schemas/ReportCreate"},"maxItems":1,"minItems":1,"type":"array"}},"required":["accessRequestedAccounts","reports"],"type":"object"},"CreateReportingQuery":{"properties":{"fields":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"filter":{"$ref":"#/components/schemas/CreateFilter"}},"required":["fields"],"type":"object"},"CreateResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateResponsiveEcommerceLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/CreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"}},"type":"object"},"CreateReviewStars":{"description":"Review information for a product","properties":{"hasHalfStar":{"description":"Flag indicating if the product has a half star in the rating","type":"boolean"},"reviewCount":{"description":"Number of reviews for the product","format":"int32","type":"integer"},"wholeStars":{"description":"Number of whole stars in the rating","format":"int32","type":"integer"}},"required":["hasHalfStar","reviewCount","wholeStars"],"type":"object"},"CreateRuleCriteria":{"description":"| CreateRuleCriteria | Description |\n|------|------|\n| `dimensionCriteria` | Defines dimension-based targeting criteria using generic dimension filters. |\n","oneOf":[{"properties":{"dimensionCriteria":{"$ref":"#/components/schemas/CreateDimensionCriteria"}},"required":["dimensionCriteria"],"title":"dimensionCriteria","type":"object"}]},"CreateRuleDuration":{"description":"Duration defined by a start and end date. startDateTime and endDateTime are ReadOnly if calendarEvent is also provided in duration.","properties":{"endDateTime":{"description":"The end date time for the rule.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the rule.","format":"date-time","type":"string"}},"type":"object"},"CreateRuleExpression":{"description":"The conditions and actions that define the rule behavior.\n\n| CreateRuleExpression | Description |\n|------|------|\n| `dimensionRuleExpression` | Dimension-based rule expression. |\n","oneOf":[{"properties":{"dimensionRuleExpression":{"$ref":"#/components/schemas/CreateDimensionRuleExpression"}},"required":["dimensionRuleExpression"],"title":"dimensionRuleExpression","type":"object"}]},"CreateRuleLinkIdentity":{"properties":{"entityId":{"$ref":"#/components/schemas/RuleLinkedEntity"},"ruleId":{"description":"The associated rule.","type":"string"},"ruleLinkEntityType":{"$ref":"#/components/schemas/RuleLinkedEntityType"}},"required":["entityId","ruleId","ruleLinkEntityType"],"type":"object"},"CreateRuleLinkRequest":{"properties":{"ruleLinks":{"items":{"$ref":"#/components/schemas/RuleLinkCreate"},"maxItems":1,"minItems":1,"type":"array"}},"required":["ruleLinks"],"type":"object"},"CreateRuleRequest":{"properties":{"rules":{"items":{"$ref":"#/components/schemas/RuleCreate"},"maxItems":1,"minItems":1,"type":"array"}},"required":["rules"],"type":"object"},"CreateSellingAccountLinkDetails":{"properties":{"sellingAccountLinkToken":{"description":"The token to locate a selling account to be linked.","type":"string"},"sellingProgram":{"$ref":"#/components/schemas/SellingProgram"}},"required":["sellingAccountLinkToken"],"type":"object"},"CreateSellingAccountLinkRequest":{"oneOf":[{"properties":{"sellingAccountLinkDetails":{"$ref":"#/components/schemas/CreateSellingAccountLinkDetails"}},"required":["sellingAccountLinkDetails"],"title":"sellingAccountLinkDetails","type":"object"}]},"CreateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/CreateImage"}},"required":["brand"],"type":"object"},"CreateShopperSegmentBidAdjustment":{"type":"object"},"CreateSize":{"properties":{"height":{"description":"The height of the creative placement.","format":"int32","type":"integer"},"width":{"description":"The width of the creative placement.","format":"int32","type":"integer"}},"required":["height","width"],"type":"object"},"CreateSmartLocation":{"description":"A smart location targets postal codes based on a sales index.","properties":{"locationIndexId":{"description":"The ID of the index used for this smart location.","type":"string"},"maxIndexValuePercentile":{"description":"Maximum percentile value (0-100). Must be greater than minIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"minIndexValuePercentile":{"description":"Minimum percentile value (0-100). Must be less than maxIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"name":{"description":"Name for the smart location.","type":"string"}},"required":["locationIndexId","name"],"type":"object"},"CreateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"type":"object"},"CreateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/CreateAudio"},"callToActions":{"$ref":"#/components/schemas/CreateAudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/CreateImage"},"headlines":{"description":"The headline(s) to use for the standard audio experience. Headlines must be a maximum of 20 characters.","type":"string"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","companionImages","headlines","language"],"type":"object"},"CreateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/CreateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"CreateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**CreateState Enum:**\n\n| CreateState | Description |\n|------|------|\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n","enum":["ENABLED","PAUSED"],"type":"string"},"CreateStoreASINSlide":{"properties":{"productAsin":{"description":"The ASIN of the product.","type":"string"},"tag":{"description":"Unique tag for the slide which will be ASIN.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"required":["productAsin","tag","type"],"type":"object"},"CreateStoreAWLSTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreAWLSTileContent"},"externalWidgetId":{"description":"External widget identifier.","type":"string"}},"required":["commonProperties","externalWidgetId"],"type":"object"},"CreateStoreAWLSTileContent":{"oneOf":[{"properties":{"brandedRecipeWidget":{"$ref":"#/components/schemas/CreateBrandedRecipeWidget"}},"required":["brandedRecipeWidget"],"title":"brandedRecipeWidget","type":"object"},{"properties":{"storeProductSelectorWidget":{"$ref":"#/components/schemas/CreateStoreProductSelectorWidget"}},"required":["storeProductSelectorWidget"],"title":"storeProductSelectorWidget","type":"object"},{"properties":{"storeVideoRevealWidget":{"$ref":"#/components/schemas/CreateStoreVideoRevealWidget"}},"required":["storeVideoRevealWidget"],"title":"storeVideoRevealWidget","type":"object"}]},"CreateStoreAWLSWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"The AWLS tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/CreateStoreAWLSTile"},"maxItems":1,"minItems":1,"type":"array"},"widgetDependencies":{"description":"List of widget dependencies.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreBannerContent":{"properties":{"banners":{"$ref":"#/components/schemas/CreateStoreBanners"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"CreateStoreBannerWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreBannerContent"}},"required":["commonProperties","content"],"type":"object"},"CreateStoreBanners":{"properties":{"blackLivesMatter":{"description":"Flag to display Black Lives Matter banner","type":"boolean"},"stopAsianHate":{"description":"Flag to display Stop Asian Hate banner","type":"boolean"}},"required":["blackLivesMatter","stopAsianHate"],"type":"object"},"CreateStoreCallToActionData":{"properties":{"customUrl":{"description":"Custom URL for the call to action.","type":"string"},"pageId":{"description":"Page identifier.","type":"string"},"productAsin":{"description":"ASIN for the call to action.","type":"string"},"text":{"description":"Call to action text.","type":"string"}},"type":"object"},"CreateStoreCallToActionProductData":{"properties":{"customUrl":{"description":"Custom URL for the call to action.","type":"string"},"productAsin":{"description":"Product ASIN for the call to action.","type":"string"},"text":{"description":"Call to action text.","type":"string"}},"type":"object"},"CreateStoreCanvasData":{"properties":{"canvasHeight":{"description":"Height in the canvas.","format":"double","type":"number"},"height":{"description":"Height in the canvas.","format":"double","type":"number"},"left":{"description":"Left position in the canvas.","format":"double","type":"number"},"naturalHeight":{"description":"Natural height of the image.","format":"double","type":"number"},"naturalWidth":{"description":"Natural width of the image.","format":"double","type":"number"},"top":{"description":"Top position in the canvas.","format":"double","type":"number"},"width":{"description":"Width in the canvas.","format":"double","type":"number"}},"type":"object"},"CreateStoreCarouselContent":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"callToActionData":{"$ref":"#/components/schemas/CreateStoreCallToActionData"},"includeOutOfStock":{"description":"Whether to include out of stock items.","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"productAsins":{"description":"List of ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"search":{"$ref":"#/components/schemas/CreateStoreCarouselSearch"},"slides":{"description":"List of ASIN slides.","items":{"$ref":"#/components/schemas/CreateStoreASINSlide"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content to track performance.","type":"string"},"text":{"description":"Description text.","type":"string"},"title":{"description":"Title of the carousel.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"required":["bulk","callToActionData","includeOutOfStock","keyword","tag","text","title","type"],"type":"object"},"CreateStoreCarouselSearch":{"properties":{"includeOutOfStock":{"description":"Whether to include out of stock items in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"List of ASINs for search filtering.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["includeOutOfStock","keyword","node"],"type":"object"},"CreateStoreCropBoxData":{"properties":{"height":{"description":"Height of the crop box.","format":"double","type":"number"},"left":{"description":"Left position of the crop box.","format":"double","type":"number"},"top":{"description":"Top position of the crop box.","format":"double","type":"number"},"width":{"description":"Width of the crop box.","format":"double","type":"number"}},"type":"object"},"CreateStoreCroppedImage":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"cropBox":{"$ref":"#/components/schemas/CreateStoreCropBoxData"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageNaturalHeight":{"description":"Natural height of the image.","format":"double","type":"number"},"imageNaturalWidth":{"description":"Natural width of the image.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"}},"type":"object"},"CreateStoreCustomCodeContent":{"properties":{"autoDimension":{"description":"Whether to use automatic dimensioning.","type":"boolean"},"availableProductAsins":{"description":"List of available ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"cti":{"$ref":"#/components/schemas/CreateCTI"},"embedCode":{"description":"Embedded code content.","type":"string"},"integrity":{"description":"Integrity hash for security.","type":"string"},"widgetName":{"description":"Name of the widget.","type":"string"},"widgetTag":{"description":"Widget identifier.","type":"string"}},"type":"object"},"CreateStoreCustomCodeTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreCustomCodeContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreCustomCodeWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"The custom code tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/CreateStoreCustomCodeTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreDealsConfig":{"properties":{"node":{"description":"Node identifier for deals.","type":"string"}},"type":"object"},"CreateStoreDealsContent":{"properties":{"deals":{"$ref":"#/components/schemas/CreateStoreDealsConfig"},"dealsMode":{"$ref":"#/components/schemas/StoreDealsMode"},"productAsins":{"description":"List of ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content to track performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"type":"object"},"CreateStoreDealsWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreDealsContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreEmptyTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreEmptyTileContent"}},"required":["commonProperties","content"],"type":"object"},"CreateStoreEmptyTileContent":{"properties":{"bondCustomerServiceLink":{"description":"Whether to include a customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"text":{"description":"Text content (must be empty).","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the tile (must be empty).","type":"string"}},"type":"object"},"CreateStoreGalleryContent":{"properties":{"metadata":{"description":"Metadata associated with the gallery.","items":{"$ref":"#/components/schemas/CreateStoreMetadataItem"},"maxItems":15,"minItems":0,"type":"array"},"slides":{"description":"List of slides in the gallery.","items":{"$ref":"#/components/schemas/CreateStoreGallerySlide"},"maxItems":15,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content.","type":"string"},"text":{"description":"Text content of the gallery.","type":"string"},"title":{"description":"Title of the gallery.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"CreateStoreGallerySlide":{"properties":{"alt":{"description":"Alternative text for the slide.","type":"string"},"assetId":{"description":"Asset identifier for the slide.","type":"string"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"type":"object"},"CreateStoreGalleryWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreGalleryContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreHeroContent":{"properties":{"assetId":{"description":"Identifier for the asset.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"description":{"description":"Description of the hero image.","type":"string"},"imageHeight":{"description":"Height of the hero image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset of the image.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset of the image.","format":"double","type":"number"},"imageUrl":{"description":"URL of the hero image.","type":"string"},"imageWidth":{"description":"Width of the hero image.","format":"double","type":"number"},"mobileContent":{"$ref":"#/components/schemas/CreateStoreMobileContent"},"tag":{"description":"Unique tag for the content.","type":"string"},"textOverlay":{"description":"Text overlay displayed on the hero image.","type":"string"}},"required":["imageUrl"],"type":"object"},"CreateStoreHeroImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreHeroContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreImageContent":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/CreateStoreCropBoxData"},"customUrl":{"description":"Custom URL.","type":"string"},"hideTitle":{"description":"Whether to hide the title.","type":"boolean"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"pageId":{"description":"Page identifier.","type":"string"},"productAsins":{"description":"Single ASIN for the image.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreImageTextAlign"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the image.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"CreateStoreImageSlide":{"properties":{"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"tag":{"description":"Unique identifier for the slide.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"type":"object"},"CreateStoreImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreImageContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/CreateStoreMobileImageContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"}},"required":["commonProperties"],"type":"object"},"CreateStoreImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"The image tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/CreateStoreImageTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreImageWithTextContent":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/CreateStoreCropBoxData"},"customUrl":{"description":"Custom URL.","type":"string"},"hideTitle":{"description":"Whether to hide the title.","type":"boolean"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"pageId":{"description":"Page identifier.","type":"string"},"productAsins":{"description":"Single ASIN for the image.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"shape":{"$ref":"#/components/schemas/StoreImageShape"},"text":{"description":"Text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"textOption":{"$ref":"#/components/schemas/StoreTextOption"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"$ref":"#/components/schemas/CreateStoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the image.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"CreateStoreImageWithTextTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreImageWithTextContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/CreateStoreMobileImageWithTextContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"},"variation":{"$ref":"#/components/schemas/StoreImageWithTextTileVariation"}},"required":["commonProperties","variation"],"type":"object"},"CreateStoreImageWithTextWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"The image with text tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/CreateStoreImageWithTextTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreLiveVideoContent":{"properties":{"channel":{"description":"Channel of the video.","type":"string"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"required":["tag","type"],"type":"object"},"CreateStoreLiveVideoWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreLiveVideoContent"}},"required":["commonProperties","content"],"type":"object"},"CreateStoreManuallyCuratedProductCarouselWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreCarouselContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreMetadataItem":{"properties":{"alt":{"description":"Alternative text.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"filename":{"description":"Name of the file.","type":"string"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageUrl":{"description":"The imageUrl of the item.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"},"url":{"description":"URL of the item.","type":"string"}},"type":"object"},"CreateStoreMobileContent":{"properties":{"assetId":{"description":"Asset identifier for mobile view.","type":"string"},"assetTags":{"description":"Asset tags for mobile view.","type":"string"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"imageHeight":{"description":"Height of the image for mobile view.","format":"double","type":"number"},"imageKey":{"description":"Image key for mobile view.","type":"string"},"imageOffsetLeft":{"description":"Left offset of the image for mobile view.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset of the image for mobile view.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image for mobile view.","type":"string"},"imageWidth":{"description":"Width of the image for mobile view.","format":"double","type":"number"},"version":{"description":"Version identifier for mobile content","type":"string"}},"type":"object"},"CreateStoreMobileImageContent":{"properties":{"altText":{"description":"Alternative text for the mobile image.","type":"string"},"assetId":{"description":"Asset identifier for mobile.","type":"string"},"assetTags":{"description":"Tags associated with the mobile asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/CreateStoreCropBoxData"},"hideTitle":{"description":"Whether to hide the title on mobile.","type":"boolean"},"imageHeight":{"description":"Height of the mobile image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the mobile image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for mobile image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for mobile image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the mobile image.","type":"string"},"imageWidth":{"description":"Width of the mobile image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the mobile image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"tileLayers":{"description":"Layer configuration for the mobile tile.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title for mobile display.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"CreateStoreMobileImageWithTextContent":{"properties":{"altText":{"description":"Alternative text for the mobile image.","type":"string"},"assetId":{"description":"Asset identifier for mobile.","type":"string"},"assetTags":{"description":"Tags associated with the mobile asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/CreateStoreCropBoxData"},"hideTitle":{"description":"Whether to hide the title on mobile.","type":"boolean"},"imageHeight":{"description":"Height of the mobile image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the mobile image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for mobile image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for mobile image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the mobile image.","type":"string"},"imageWidth":{"description":"Width of the mobile image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the mobile image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"renderTileLayers":{"description":"Whether to render tile layers on mobile.","type":"boolean"},"shape":{"$ref":"#/components/schemas/StoreImageShape"},"text":{"description":"Text content for mobile.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"textOption":{"$ref":"#/components/schemas/StoreTextOption"},"tileLayers":{"description":"Layer configuration for the mobile tile.","items":{"$ref":"#/components/schemas/CreateStoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title for mobile display.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"CreateStorePageWidget":{"description":"Union of all possible widget types that can be used on a store page","oneOf":[{"properties":{"storeHeroImageWidget":{"$ref":"#/components/schemas/CreateStoreHeroImageWidget"}},"required":["storeHeroImageWidget"],"title":"storeHeroImageWidget","type":"object"},{"properties":{"storeTileWidget":{"$ref":"#/components/schemas/CreateStoreTileWidget"}},"required":["storeTileWidget"],"title":"storeTileWidget","type":"object"},{"properties":{"storeImageWidget":{"$ref":"#/components/schemas/CreateStoreImageWidget"}},"required":["storeImageWidget"],"title":"storeImageWidget","type":"object"},{"properties":{"storeTextWidget":{"$ref":"#/components/schemas/CreateStoreTextWidget"}},"required":["storeTextWidget"],"title":"storeTextWidget","type":"object"},{"properties":{"storeImageWithTextWidget":{"$ref":"#/components/schemas/CreateStoreImageWithTextWidget"}},"required":["storeImageWithTextWidget"],"title":"storeImageWithTextWidget","type":"object"},{"properties":{"storeProductCollectionWidget":{"$ref":"#/components/schemas/CreateStoreProductCollectionWidget"}},"required":["storeProductCollectionWidget"],"title":"storeProductCollectionWidget","type":"object"},{"properties":{"storeProductGridWidget":{"$ref":"#/components/schemas/CreateStoreProductGridWidget"}},"required":["storeProductGridWidget"],"title":"storeProductGridWidget","type":"object"},{"properties":{"storeDealsWidget":{"$ref":"#/components/schemas/CreateStoreDealsWidget"}},"required":["storeDealsWidget"],"title":"storeDealsWidget","type":"object"},{"properties":{"storeProductWidget":{"$ref":"#/components/schemas/CreateStoreProductWidget"}},"required":["storeProductWidget"],"title":"storeProductWidget","type":"object"},{"properties":{"storeShoppableImageWidget":{"$ref":"#/components/schemas/CreateStoreShoppableImageWidget"}},"required":["storeShoppableImageWidget"],"title":"storeShoppableImageWidget","type":"object"},{"properties":{"storeCustomCodeWidget":{"$ref":"#/components/schemas/CreateStoreCustomCodeWidget"}},"required":["storeCustomCodeWidget"],"title":"storeCustomCodeWidget","type":"object"},{"properties":{"storeVideoWidget":{"$ref":"#/components/schemas/CreateStoreVideoWidget"}},"required":["storeVideoWidget"],"title":"storeVideoWidget","type":"object"},{"properties":{"storeGalleryWidget":{"$ref":"#/components/schemas/CreateStoreGalleryWidget"}},"required":["storeGalleryWidget"],"title":"storeGalleryWidget","type":"object"},{"properties":{"storeShopTheLookWidget":{"$ref":"#/components/schemas/CreateStoreShopTheLookWidget"}},"required":["storeShopTheLookWidget"],"title":"storeShopTheLookWidget","type":"object"},{"properties":{"storeManuallyCuratedProductCarouselWidget":{"$ref":"#/components/schemas/CreateStoreManuallyCuratedProductCarouselWidget"}},"required":["storeManuallyCuratedProductCarouselWidget"],"title":"storeManuallyCuratedProductCarouselWidget","type":"object"},{"properties":{"storeAWLSWidget":{"$ref":"#/components/schemas/CreateStoreAWLSWidget"}},"required":["storeAWLSWidget"],"title":"storeAWLSWidget","type":"object"},{"properties":{"storeBannerWidget":{"$ref":"#/components/schemas/CreateStoreBannerWidget"}},"required":["storeBannerWidget"],"title":"storeBannerWidget","type":"object"},{"properties":{"storeProductCarouselWidget":{"$ref":"#/components/schemas/CreateStoreProductCarouselWidget"}},"required":["storeProductCarouselWidget"],"title":"storeProductCarouselWidget","type":"object"},{"properties":{"storeLiveVideoWidget":{"$ref":"#/components/schemas/CreateStoreLiveVideoWidget"}},"required":["storeLiveVideoWidget"],"title":"storeLiveVideoWidget","type":"object"}]},"CreateStoreProductCarouselContent":{"properties":{"callToActionData":{"$ref":"#/components/schemas/CreateStoreCallToActionProductData"},"searchContent":{"$ref":"#/components/schemas/CreateStoreProductCarouselSearch"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"required":["tag","type"],"type":"object"},"CreateStoreProductCarouselSearch":{"properties":{"node":{"description":"Node identifier for search","type":"string"},"type":{"$ref":"#/components/schemas/StoreProductCarouselSearchType"}},"type":"object"},"CreateStoreProductCarouselWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreProductCarouselContent"}},"required":["commonProperties","content"],"type":"object"},"CreateStoreProductCollectionASINGrid":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"description":{"description":"Description of the product grid.","type":"string"},"displayProductGridHeader":{"description":"Whether to display the product grid header.","type":"boolean"},"includeOutOfStock":{"description":"Whether to include out of stock products.","type":"boolean"},"isAutomatedProductGrid":{"description":"Whether the product grid is automatically populated","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"productAsins":{"description":"List of ASINs, maximum 60 unique items.","items":{"type":"string"},"maxItems":60,"minItems":0,"type":"array"},"sort":{"description":"Sort order for products.","type":"string"},"tag":{"description":"Unique tag for the tile to track performance.","type":"string"},"title":{"description":"Title of the product grid.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"},"variation":{"description":"Variation of the product grid.","type":"string"}},"required":["type"],"type":"object"},"CreateStoreProductCollectionContent":{"properties":{"collectionTags":{"description":"Tags associated with the collection.","type":"string"},"productGridConversionTimestamp":{"description":"Timestamp of product grid conversion.","format":"double","type":"number"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"CreateStoreProductCollectionImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreImageWithTextContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/CreateStoreMobileImageWithTextContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"},"variation":{"$ref":"#/components/schemas/StoreImageWithTextTileVariation"}},"required":["commonProperties","variation"],"type":"object"},"CreateStoreProductCollectionTile":{"oneOf":[{"properties":{"storeProductCollectionImageTile":{"$ref":"#/components/schemas/CreateStoreProductCollectionImageTile"}},"required":["storeProductCollectionImageTile"],"title":"storeProductCollectionImageTile","type":"object"},{"properties":{"storeProductCollectionASINGrid":{"$ref":"#/components/schemas/CreateStoreProductCollectionASINGrid"}},"required":["storeProductCollectionASINGrid"],"title":"storeProductCollectionASINGrid","type":"object"}]},"CreateStoreProductCollectionWidget":{"properties":{"aiMetadata":{"description":"Metadata about AI generated fields.","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":1000,"minItems":0,"type":"array"},"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreProductCollectionContent"},"tiles":{"description":"The tiles for the product collection. Exactly two tiles are required.","items":{"$ref":"#/components/schemas/CreateStoreProductCollectionTile"},"maxItems":2,"minItems":2,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreProductGridContent":{"properties":{"bulk":{"description":"Whether this is a bulk product grid.","type":"boolean"},"description":{"description":"Description of the product grid.","type":"string"},"displayProductGridHeader":{"description":"Whether to display the grid header.","type":"boolean"},"excludedProductAsins":{"description":"List of product ASINs exclude when dynamic.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"includeOutOfStock":{"description":"Whether to include out of stock products.","type":"boolean"},"isAutomatedProductGrid":{"description":"Whether the product grid is automatically populated","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"pinnedProductAsins":{"description":"List of product ASINs include when dynamic.","items":{"type":"string"},"maxItems":25,"minItems":0,"type":"array"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"productType":{"description":"Type of products to display","type":"string"},"search":{"$ref":"#/components/schemas/CreateStoreProductGridSearch"},"showOnlyMarkdown":{"description":"Whether to only show products on markdown.","type":"boolean"},"sort":{"description":"Sort order for products.","type":"string"},"tag":{"description":"Unique tag for the content.","type":"string"},"title":{"description":"Title of the product grid.","type":"string"},"type":{"description":"Type of the content.","type":"string"}},"type":"object"},"CreateStoreProductGridSearch":{"properties":{"brandId":{"description":"brand id to search.","type":"string"},"includeOutOfStock":{"description":"Whether to include out of stock products in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"sort":{"description":"Sort order for search results.","type":"string"}},"type":"object"},"CreateStoreProductGridWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreProductGridContent"}},"required":["commonProperties","content"],"type":"object"},"CreateStoreProductSelectorAnswer":{"description":"Represents a possible answer in the product selector questionnaire","properties":{"image":{"$ref":"#/components/schemas/CreateStoreProductSelectorImage"},"nextStep":{"description":"Reference to the next question or step in the selection flow","type":"string"},"productAsins":{"description":"List of ASINs associated with this answer","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique identifier for the answer","type":"string"},"text":{"description":"Display text for the answer option","type":"string"}},"required":["nextStep","tag"],"type":"object"},"CreateStoreProductSelectorDesignOptions":{"description":"Visual styling options for the product selector widget","properties":{"backgroundColor":{"description":"Background color in hex or named color value","type":"string"},"backgroundShape":{"description":"Shape of the background container","type":"string"},"buttonColor":{"$ref":"#/components/schemas/StoreProductSelectorButtonColor"},"buttonShape":{"description":"Shape style for buttons in the selector","type":"string"},"textAlignment":{"description":"Alignment of text elements (left, center, right)","type":"string"},"textSize":{"description":"Size of the text elements","type":"string"},"textStyle":{"description":"Font family or style to be used","type":"string"},"textWeight":{"description":"Font weight for text elements","type":"string"}},"required":["backgroundColor","backgroundShape","buttonShape","textAlignment","textSize","textStyle","textWeight"],"type":"object"},"CreateStoreProductSelectorImage":{"description":"Represents an image used in the product selector introduction","properties":{"assetId":{"description":"Asset ID of the image","type":"string"},"fileName":{"description":"File name of the image","type":"string"},"imageUrl":{"description":"URL of the image","type":"string"},"layout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"}},"required":["assetId","imageUrl"],"type":"object"},"CreateStoreProductSelectorImageOptions":{"description":"Image options for the product selector introduction","properties":{"image":{"$ref":"#/components/schemas/CreateStoreProductSelectorImage"},"layoutConfiguration":{"$ref":"#/components/schemas/CreateStoreProductSelectorLayoutConfiguration"}},"required":["image","layoutConfiguration"],"type":"object"},"CreateStoreProductSelectorIntroduction":{"description":"Introduction section for the product selector widget","properties":{"buttonText":{"description":"Text displayed on the introduction button","type":"string"},"description":{"description":"Description text for the introduction section","type":"string"},"heading":{"description":"Heading text for the introduction section","type":"string"},"headline":{"description":"Headline text for the introduction section","type":"string"},"imageOptions":{"$ref":"#/components/schemas/CreateStoreProductSelectorImageOptions"},"isEnabled":{"description":"Flag indicating whether the introduction is enabled","type":"boolean"}},"required":["buttonText","description","heading","imageOptions","isEnabled"],"type":"object"},"CreateStoreProductSelectorLayoutConfiguration":{"description":"Layout configuration for desktop and mobile views","properties":{"desktopLayout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"},"mobileLayout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"}},"required":["desktopLayout","mobileLayout"],"type":"object"},"CreateStoreProductSelectorQuestion":{"description":"Represents a question in the product selector questionnaire","properties":{"answerList":{"description":"List of possible answers for this question","items":{"$ref":"#/components/schemas/CreateStoreProductSelectorAnswer"},"maxItems":500,"minItems":0,"type":"array"},"areImagesEnabled":{"description":"Flag indicating whether images are enabled","type":"boolean"},"description":{"description":"Additional descriptive text or context for the question","type":"string"},"hasImage":{"description":"Flag indicating whether the question has an image","type":"boolean"},"tag":{"description":"Unique identifier for the question","type":"string"},"text":{"description":"Main question text displayed to the user","type":"string"}},"required":["tag"],"type":"object"},"CreateStoreProductSelectorResults":{"description":"Configuration for displaying product selector results","properties":{"buttonText":{"description":"Text to display on the call-to-action button","type":"string"},"description":{"description":"Descriptive text explaining the results","type":"string"},"disclaimer":{"description":"Legal or additional information text for the results","type":"string"},"headline":{"description":"Main heading text for the results section","type":"string"},"storeUrl":{"description":"URL to the store page for the selected products","type":"string"}},"required":["disclaimer","headline"],"type":"object"},"CreateStoreProductSelectorWidget":{"description":"Main widget structure for the product selector feature","properties":{"designOptions":{"$ref":"#/components/schemas/CreateStoreProductSelectorDesignOptions"},"introduction":{"$ref":"#/components/schemas/CreateStoreProductSelectorIntroduction"},"productAsins":{"description":"Master list of ASINs available in the selector","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"questionList":{"description":"Ordered list of questions in the selector flow","items":{"$ref":"#/components/schemas/CreateStoreProductSelectorQuestion"},"maxItems":500,"minItems":0,"type":"array"},"results":{"$ref":"#/components/schemas/CreateStoreProductSelectorResults"}},"required":["designOptions","results"],"type":"object"},"CreateStoreProductTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreProductTileContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreProductTileContent":{"properties":{"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"displayOutOfStockASIN":{"description":"Whether to display out of stock ASIN.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreLayoutType"},"productAsins":{"description":"Single ASIN for the product.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Description text for the product.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the product.","type":"string"}},"type":"object"},"CreateStoreProductWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"The product tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/CreateStoreProductTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreShopTheLookContent":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"callToActionData":{"$ref":"#/components/schemas/CreateStoreCallToActionData"},"includeOutOfStock":{"description":"Whether to include out of stock items.","type":"boolean"},"keyword":{"description":"Keyword for searching.","type":"string"},"productAsins":{"description":"List of product ASINs, maximum 25 unique items.","items":{"type":"string"},"maxItems":25,"minItems":0,"type":"array"},"search":{"$ref":"#/components/schemas/CreateStoreShopTheLookSearch"},"slides":{"description":"List of slides in the carousel.","items":{"$ref":"#/components/schemas/CreateStoreShopTheLookSlide"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content.","type":"string"},"text":{"description":"Text content.","type":"string"},"title":{"description":"Title of the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"type":"object"},"CreateStoreShopTheLookSearch":{"properties":{"includeOutOfStock":{"description":"Whether to include out of stock items in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"Single ASIN for search filtering.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"CreateStoreShopTheLookSlide":{"oneOf":[{"properties":{"storeImageSlide":{"$ref":"#/components/schemas/CreateStoreImageSlide"}},"required":["storeImageSlide"],"title":"storeImageSlide","type":"object"},{"properties":{"storeASINSlide":{"$ref":"#/components/schemas/CreateStoreASINSlide"}},"required":["storeASINSlide"],"title":"storeASINSlide","type":"object"}]},"CreateStoreShopTheLookWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"content":{"$ref":"#/components/schemas/CreateStoreShopTheLookContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreShoppableImageContent":{"properties":{"croppedImage":{"$ref":"#/components/schemas/CreateStoreCroppedImage"},"points":{"description":"Interactive points on the image.","items":{"$ref":"#/components/schemas/CreateStoreShoppablePoint"},"maxItems":6,"minItems":0,"type":"array"},"productAsins":{"description":"Single ASIN for the point.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"textOption":{"$ref":"#/components/schemas/StoreShoppableTextOption"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"$ref":"#/components/schemas/CreateStoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"CreateStoreShoppableImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreShoppableImageContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreShoppableImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"The shoppable image tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/CreateStoreShoppableImageTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreShoppablePoint":{"properties":{"coordinates":{"$ref":"#/components/schemas/CreateCoordinates"},"productAsins":{"description":"Single ASIN for the point.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the point.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"required":["coordinates"],"type":"object"},"CreateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateStoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/CreateCardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/StoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"CreateStoreTextContent":{"properties":{"bold":{"description":"Whether text should be bold.","type":"boolean"},"bondCustomerServiceLink":{"description":"Whether to include customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"customUrl":{"description":"Custom URL for the content.","type":"string"},"pageId":{"description":"Identifier for the page.","type":"string"},"productAsins":{"description":"Single product ASIN for the content.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Main text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the content.","type":"string"},"uppercase":{"description":"Whether text should be uppercase.","type":"boolean"}},"required":["bold","text","title","uppercase"],"type":"object"},"CreateStoreTextTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreTextContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreTextWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"Single text tile configuration.","items":{"$ref":"#/components/schemas/CreateStoreTextTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreTile":{"oneOf":[{"properties":{"storeImageWithTextTile":{"$ref":"#/components/schemas/CreateStoreImageWithTextTile"}},"required":["storeImageWithTextTile"],"title":"storeImageWithTextTile","type":"object"},{"properties":{"storeImageTile":{"$ref":"#/components/schemas/CreateStoreImageTile"}},"required":["storeImageTile"],"title":"storeImageTile","type":"object"},{"properties":{"storeProductTile":{"$ref":"#/components/schemas/CreateStoreProductTile"}},"required":["storeProductTile"],"title":"storeProductTile","type":"object"},{"properties":{"storeShoppableImageTile":{"$ref":"#/components/schemas/CreateStoreShoppableImageTile"}},"required":["storeShoppableImageTile"],"title":"storeShoppableImageTile","type":"object"},{"properties":{"storeTextTile":{"$ref":"#/components/schemas/CreateStoreTextTile"}},"required":["storeTextTile"],"title":"storeTextTile","type":"object"},{"properties":{"storeVideoTile":{"$ref":"#/components/schemas/CreateStoreVideoTile"}},"required":["storeVideoTile"],"title":"storeVideoTile","type":"object"},{"properties":{"storeEmptyTile":{"$ref":"#/components/schemas/CreateStoreEmptyTile"}},"required":["storeEmptyTile"],"title":"storeEmptyTile","type":"object"},{"properties":{"storeCustomCodeTile":{"$ref":"#/components/schemas/CreateStoreCustomCodeTile"}},"required":["storeCustomCodeTile"],"title":"storeCustomCodeTile","type":"object"}]},"CreateStoreTileLayer":{"properties":{"colorPalette":{"$ref":"#/components/schemas/StoreColorPalette"},"content":{"$ref":"#/components/schemas/CreateStoreTileLayerContent"},"coverTile":{"description":"Whether the layer covers the entire tile.","type":"boolean"},"margin":{"$ref":"#/components/schemas/StoreTileBorderSize"},"opacity":{"description":"Opacity level of the layer.","format":"double","type":"number"},"outOfBounds":{"description":"Whether the layer is out of bounds.","type":"boolean"},"padding":{"$ref":"#/components/schemas/StoreTileBorderSize"},"position":{"$ref":"#/components/schemas/CreateStoreTilePosition"},"tag":{"description":"Unique tag for the tile layer to track performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"type":"object"},"CreateStoreTileLayerContent":{"properties":{"bodyText":{"description":"Body text for the layer.","type":"string"},"bondCustomerServiceLink":{"description":"Whether to include a customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text for the layer.","type":"string"},"callToActionType":{"$ref":"#/components/schemas/StoreCallToActionType"},"customUrl":{"description":"Custom URL for the layer.","type":"string"},"headerText":{"description":"Header text for the layer.","type":"string"},"pageId":{"description":"Page identifier for the layer.","type":"string"},"prefixText":{"description":"Prefix text for the layer.","type":"string"},"productAsins":{"description":"Single ASIN for the layer.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"tileTextAlignment":{"$ref":"#/components/schemas/StoreTextAlignment"},"tileTextSize":{"$ref":"#/components/schemas/StoreTileTextSize"}},"type":"object"},"CreateStoreTilePosition":{"properties":{"x":{"$ref":"#/components/schemas/HorizontalPosition"},"y":{"$ref":"#/components/schemas/VerticalPosition"}},"type":"object"},"CreateStoreTileWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"rowHeight":{"description":"Height of the row in pixels.","format":"int32","type":"integer"},"tiles":{"description":"The tiles for the widget. Minimum 2 and maximum 8 tiles are allowed.","items":{"$ref":"#/components/schemas/CreateStoreTile"},"maxItems":8,"minItems":2,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStoreVideoContent":{"properties":{"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"autoPlay":{"description":"Whether video should auto-play.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/CreateStoreCanvasData"},"customUrl":{"description":"Custom URL for the content.","type":"string"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key for the image asset.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"mute":{"description":"Whether video should be muted.","type":"boolean"},"pageId":{"description":"Page identifier","type":"string"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"resourceId":{"description":"Resource identifier.","type":"string"},"text":{"description":"Text content.","type":"string"},"textAlign":{"description":"Text alignment.","type":"string"},"textOption":{"$ref":"#/components/schemas/StoreTextOptionType"},"tileLayers":{"description":"Configuration for tile layers.","items":{"$ref":"#/components/schemas/CreateStoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the content.","type":"string"},"videoAssetId":{"description":"Video asset identifier.","type":"string"},"videoAssetTags":{"description":"Tags associated with the video asset.","type":"string"},"videoDescription":{"description":"Description of the video.","type":"string"},"videoKey":{"description":"Key for the video asset.","type":"string"},"videoName":{"description":"Name of the video.","type":"string"},"videoSize":{"description":"Size of the video in bytes.","format":"double","type":"number"},"videoUrl":{"description":"URL of the video.","type":"string"}},"type":"object"},"CreateStoreVideoRevealVRVideo":{"description":"Configuration for a single video reveal video asset","properties":{"assetId":{"description":"Unique identifier for the video asset","type":"string"},"url":{"description":"URL of the video content","type":"string"}},"required":["assetId","url"],"type":"object"},"CreateStoreVideoRevealVideos":{"description":"Collection of video assets for different device types","properties":{"desktop":{"$ref":"#/components/schemas/CreateStoreVideoRevealVRVideo"},"mobile":{"$ref":"#/components/schemas/CreateStoreVideoRevealVRVideo"}},"required":["desktop","mobile"],"type":"object"},"CreateStoreVideoRevealWidget":{"description":"Main widget structure for the video reveal feature","properties":{"backgroundColor":{"description":"Background color (CSS property)","type":"string"},"csmTag":{"description":"CSM tracking tag for the video reveal","type":"string"},"fadeoutDuration":{"description":"Fadeout duration (in ms)","type":"string"},"objectFit":{"description":"Object fit (CSS property)","type":"string"},"skipReveal":{"description":"Skip reveal (to be used in development only)","type":"boolean"},"throttleLimit":{"description":"Play video every X minutes","type":"string"},"videos":{"$ref":"#/components/schemas/CreateStoreVideoRevealVideos"}},"required":["backgroundColor","csmTag","fadeoutDuration","objectFit","skipReveal","throttleLimit","videos"],"type":"object"},"CreateStoreVideoTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonTileProperties"},"content":{"$ref":"#/components/schemas/CreateStoreVideoContent"}},"required":["commonProperties"],"type":"object"},"CreateStoreVideoWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CreateCommonWidgetProperties"},"tiles":{"description":"The content configuration for the video widget.","items":{"$ref":"#/components/schemas/CreateStoreVideoTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"CreateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateVideoLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/CreateVideo"}},"required":["videos"],"type":"object"},"CreateTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"CreateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateTargetBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"CreateTargetBidMarketplaceSetting":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"CreateTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/CreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/CreateProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/CreateProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productAudienceTarget":{"$ref":"#/components/schemas/CreateProductAudienceTarget"}},"required":["productAudienceTarget"],"title":"productAudienceTarget","type":"object"},{"properties":{"audienceTarget":{"$ref":"#/components/schemas/CreateAudienceTarget"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/CreateLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"domainTarget":{"$ref":"#/components/schemas/CreateDomainTarget"}},"required":["domainTarget"],"title":"domainTarget","type":"object"},{"properties":{"appTarget":{"$ref":"#/components/schemas/CreateAppTarget"}},"required":["appTarget"],"title":"appTarget","type":"object"},{"properties":{"deviceTarget":{"$ref":"#/components/schemas/CreateDeviceTarget"}},"required":["deviceTarget"],"title":"deviceTarget","type":"object"},{"properties":{"dayPartTarget":{"$ref":"#/components/schemas/CreateDayPartTarget"}},"required":["dayPartTarget"],"title":"dayPartTarget","type":"object"},{"properties":{"contentCategoryTarget":{"$ref":"#/components/schemas/CreateContentCategoryTarget"}},"required":["contentCategoryTarget"],"title":"contentCategoryTarget","type":"object"},{"properties":{"contentGenreTarget":{"$ref":"#/components/schemas/CreateContentGenreTarget"}},"required":["contentGenreTarget"],"title":"contentGenreTarget","type":"object"},{"properties":{"contentRatingTarget":{"$ref":"#/components/schemas/CreateContentRatingTarget"}},"required":["contentRatingTarget"],"title":"contentRatingTarget","type":"object"},{"properties":{"brandSafetyTierTarget":{"$ref":"#/components/schemas/CreateBrandSafetyTierTarget"}},"required":["brandSafetyTierTarget"],"title":"brandSafetyTierTarget","type":"object"},{"properties":{"brandSafetyCategoryTarget":{"$ref":"#/components/schemas/CreateBrandSafetyCategoryTarget"}},"required":["brandSafetyCategoryTarget"],"title":"brandSafetyCategoryTarget","type":"object"},{"properties":{"inventorySourceTarget":{"$ref":"#/components/schemas/CreateInventorySourceTarget"}},"required":["inventorySourceTarget"],"title":"inventorySourceTarget","type":"object"},{"properties":{"adInitiationTarget":{"$ref":"#/components/schemas/CreateAdInitiationTarget"}},"required":["adInitiationTarget"],"title":"adInitiationTarget","type":"object"},{"properties":{"adPlayerSizeTarget":{"$ref":"#/components/schemas/CreateAdPlayerSizeTarget"}},"required":["adPlayerSizeTarget"],"title":"adPlayerSizeTarget","type":"object"},{"properties":{"videoAdFormatTarget":{"$ref":"#/components/schemas/CreateVideoAdFormatTarget"}},"required":["videoAdFormatTarget"],"title":"videoAdFormatTarget","type":"object"},{"properties":{"thirdPartyTarget":{"$ref":"#/components/schemas/CreateThirdPartyTarget"}},"required":["thirdPartyTarget"],"title":"thirdPartyTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/CreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"},{"properties":{"contentInstreamPositionTarget":{"$ref":"#/components/schemas/CreateContentInstreamPositionTarget"}},"required":["contentInstreamPositionTarget"],"title":"contentInstreamPositionTarget","type":"object"},{"properties":{"contentOutstreamPositionTarget":{"$ref":"#/components/schemas/CreateContentOutstreamPositionTarget"}},"required":["contentOutstreamPositionTarget"],"title":"contentOutstreamPositionTarget","type":"object"},{"properties":{"videoContentDurationTarget":{"$ref":"#/components/schemas/CreateVideoContentDurationTarget"}},"required":["videoContentDurationTarget"],"title":"videoContentDurationTarget","type":"object"},{"properties":{"foldPositionTarget":{"$ref":"#/components/schemas/CreateFoldPositionTarget"}},"required":["foldPositionTarget"],"title":"foldPositionTarget","type":"object"},{"properties":{"nativeContentPositionTarget":{"$ref":"#/components/schemas/CreateNativeContentPositionTarget"}},"required":["nativeContentPositionTarget"],"title":"nativeContentPositionTarget","type":"object"},{"properties":{"placementTypeTarget":{"$ref":"#/components/schemas/CreatePlacementTypeTarget"}},"required":["placementTypeTarget"],"title":"placementTypeTarget","type":"object"}]},"CreateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"CreateTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/CreateAmazonViewability"},"automatedTargetingTactic":{"$ref":"#/components/schemas/AutomatedTargetingTactic"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionType"},"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/TimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTier"}},"required":["amazonViewability","timeZoneType","userLocationSignal"],"type":"object"},"CreateThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/ThemeMatchType"}},"required":["matchType"],"type":"object"},"CreateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/CreateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/CreateThirdPartyVideoSettings"}},"type":"object"},"CreateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["adChoicesPosition","language"],"type":"object"},"CreateThirdPartyTarget":{"properties":{"thirdPartyTargetDetails":{"$ref":"#/components/schemas/CreateThirdPartyTargetDetails"},"thirdPartyTargetType":{"$ref":"#/components/schemas/ThirdPartyTargetType"}},"required":["thirdPartyTargetDetails","thirdPartyTargetType"],"type":"object"},"CreateThirdPartyTargetDetails":{"oneOf":[{"properties":{"doubleVerifyFraudInvalidTraffic":{"$ref":"#/components/schemas/CreateDoubleVerifyFraudInvalidTraffic"}},"required":["doubleVerifyFraudInvalidTraffic"],"title":"doubleVerifyFraudInvalidTraffic","type":"object"},{"properties":{"doubleVerifyStandardDisplayBrandSafety":{"$ref":"#/components/schemas/CreateDoubleVerifyStandardDisplayBrandSafety"}},"required":["doubleVerifyStandardDisplayBrandSafety"],"title":"doubleVerifyStandardDisplayBrandSafety","type":"object"},{"properties":{"doubleVerifyBrandSafety":{"$ref":"#/components/schemas/CreateDoubleVerifyBrandSafety"}},"required":["doubleVerifyBrandSafety"],"title":"doubleVerifyBrandSafety","type":"object"},{"properties":{"doubleVerifyViewability":{"$ref":"#/components/schemas/CreateDoubleVerifyViewability"}},"required":["doubleVerifyViewability"],"title":"doubleVerifyViewability","type":"object"},{"properties":{"doubleVerifyAuthenticBrandSafety":{"$ref":"#/components/schemas/CreateDoubleVerifyAuthenticBrandSafety"}},"required":["doubleVerifyAuthenticBrandSafety"],"title":"doubleVerifyAuthenticBrandSafety","type":"object"},{"properties":{"doubleVerifyCustomContextualSegmentId":{"$ref":"#/components/schemas/CreateDoubleVerifyCustomContextualSegmentId"}},"required":["doubleVerifyCustomContextualSegmentId"],"title":"doubleVerifyCustomContextualSegmentId","type":"object"},{"properties":{"doubleVerifyAuthenticAttention":{"$ref":"#/components/schemas/CreateDoubleVerifyAuthenticAttention"}},"required":["doubleVerifyAuthenticAttention"],"title":"doubleVerifyAuthenticAttention","type":"object"},{"properties":{"integralAdScienceFraudInvalidTraffic":{"$ref":"#/components/schemas/CreateIntegralAdScienceFraudInvalidTraffic"}},"required":["integralAdScienceFraudInvalidTraffic"],"title":"integralAdScienceFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceBrandSafety":{"$ref":"#/components/schemas/CreateIntegralAdScienceBrandSafety"}},"required":["integralAdScienceBrandSafety"],"title":"integralAdScienceBrandSafety","type":"object"},{"properties":{"integralAdScienceViewability":{"$ref":"#/components/schemas/CreateIntegralAdScienceViewability"}},"required":["integralAdScienceViewability"],"title":"integralAdScienceViewability","type":"object"},{"properties":{"integralAdScienceContextualTargeting":{"$ref":"#/components/schemas/CreateIntegralAdScienceContextualTargeting"}},"required":["integralAdScienceContextualTargeting"],"title":"integralAdScienceContextualTargeting","type":"object"},{"properties":{"integralAdScienceContextualAvoidance":{"$ref":"#/components/schemas/CreateIntegralAdScienceContextualAvoidance"}},"required":["integralAdScienceContextualAvoidance"],"title":"integralAdScienceContextualAvoidance","type":"object"},{"properties":{"pixalateFraudInvalidTraffic":{"$ref":"#/components/schemas/CreatePixalateFraudInvalidTraffic"}},"required":["pixalateFraudInvalidTraffic"],"title":"pixalateFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceQualitySync":{"$ref":"#/components/schemas/CreateIntegralAdScienceQualitySync"}},"required":["integralAdScienceQualitySync"],"title":"integralAdScienceQualitySync","type":"object"},{"properties":{"newsGuardBrandGuardTrustedNewsTargeting":{"$ref":"#/components/schemas/CreateNewsGuardBrandGuardTrustedNewsTargeting"}},"required":["newsGuardBrandGuardTrustedNewsTargeting"],"title":"newsGuardBrandGuardTrustedNewsTargeting","type":"object"},{"properties":{"newsGuardBrandGuardMisinformationSafety":{"$ref":"#/components/schemas/CreateNewsGuardBrandGuardMisinformationSafety"}},"required":["newsGuardBrandGuardMisinformationSafety"],"title":"newsGuardBrandGuardMisinformationSafety","type":"object"}]},"CreateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["language"],"type":"object"},"CreateTierAdjustment":{"description":"An ordinal adjustment that expresses a ranked preference level rather than a specific numeric value.","properties":{"adjustmentType":{"$ref":"#/components/schemas/TierAdjustmentType"}},"required":["adjustmentType"],"type":"object"},"CreateTimeOfDay":{"properties":{"endTime":{"description":"Selected end time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"},"startTime":{"description":"Selected start time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"}},"required":["endTime","startTime"],"type":"object"},"CreateTwitchContentRating":{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/TwitchContentRatingEnum"}},"required":["twitchContentRating"],"type":"object"},"CreateValueAdjustment":{"properties":{"adjustmentType":{"$ref":"#/components/schemas/AdjustmentTypes"},"adjustmentValue":{"format":"double","type":"number"}},"required":["adjustmentType","adjustmentValue"],"type":"object"},"CreateVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"CreateVideoAdFormatTarget":{"description":"Target based on the video ad format.","properties":{"videoAdFormat":{"$ref":"#/components/schemas/VideoAdFormat"}},"required":["videoAdFormat"],"type":"object"},"CreateVideoCallToAction":{"oneOf":[{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/CreateLearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"CreateVideoContentDurationTarget":{"description":"Targets ads to a specific video content duration","properties":{"duration":{"$ref":"#/components/schemas/VideoContentDuration"}},"required":["duration"],"type":"object"},"CreateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/CreateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/CreateStreamingTvSettings"}},"type":"object"},"CreateVideoExtension":{"description":"Video Ad Extension","type":"object"},"CreateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"Creative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/AudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/ComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/DisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/ProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/ThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/VideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"}]},"CreativeBidAdjustment":{"properties":{"creativeType":{"$ref":"#/components/schemas/CreativeBidAdjustmentType"},"percentage":{"description":"The selection of the percentage change associated with the creative type and bid adjustment settings.","format":"int32","type":"integer"}},"required":["percentage"],"type":"object"},"CreativeBidAdjustmentType":{"description":"**CreativeBidAdjustmentType Enum:**\n\n| CreativeBidAdjustmentType | Description |\n|------|------|\n| `SPOTLIGHT` | SPOTLIGHT Video Asset. |\n","enum":["SPOTLIGHT"],"type":"string"},"CreativeOptimizationGoalKpi":{"enum":["CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE","PURCHASE_RATE"],"type":"string"},"CreativeRequirements":{"description":"Creative requirements associated with the deal.","properties":{"creativeSource":{"$ref":"#/components/schemas/CreativeSource"}},"type":"object"},"CreativeRotationType":{"description":"**CreativeRotationType Enum:**\n\n| CreativeRotationType | Description |\n|------|------|\n| `RANDOM` | Creatives are rotated randomly with equal weight. |\n| `WEIGHTED` | Creatives are rotated based on assigned weights. |\n","enum":["RANDOM","WEIGHTED"],"type":"string"},"CreativeSizeTargetingEntry":{"description":"A creative size targeting entry. All entries must share the same negative value.","properties":{"creativeSize":{"$ref":"#/components/schemas/Size"},"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["creativeSize","groupId"],"type":"object"},"CreativeSource":{"description":"**CreativeSource Enum:**\n\n| CreativeSource | Description |\n|------|------|\n| `ADVERTISER` | Creative is provided by the demand side (standard flow). |\n| `PUBLISHER` | Creative is hosted by the publisher\u0027s ad server (e.g., Google Ad Manager). |\n","enum":["ADVERTISER","PUBLISHER"],"type":"string"},"CreativeStatus":{"properties":{"moderationStatus":{"$ref":"#/components/schemas/ModerationStatus"}},"required":["moderationStatus"],"type":"object"},"CreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"CreativeType":{"description":"**CreativeType Enum:**\n\n| CreativeType | Description |\n|------|------|\n| `IMAGE` | An image creative. |\n| `VIDEO` | A video creative. |\n","enum":["IMAGE","VIDEO"],"type":"string"},"CriteriaCondition":{"description":"Defines list of criteria (performance etc .) based conditions.","properties":{"criteria":{"items":{"$ref":"#/components/schemas/RuleCriteria"},"maxItems":1000,"minItems":1,"type":"array"},"criteriaJoinOperator":{"$ref":"#/components/schemas/JoinOperator"}},"required":["criteria","criteriaJoinOperator"],"type":"object"},"CriterionStatus":{"enum":["COMPLETED","IN_PROGRESS","NOT_STARTED"],"type":"string"},"CurrencyCode":{"description":"**CurrencyCode Enum:**\n\n| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `ARS` | Argentine Peso |\n| `AUD` | Australian Dollar |\n| `AZN` | Azerbaijani Manat |\n| `BBD` | Barbadian Dollar |\n| `BGN` | Bulgarian Lev |\n| `BHD` | Bahraini Dinar |\n| `BMD` | Bermudian Dollar |\n| `BND` | Brunei Dollar |\n| `BOB` | Bolivian Boliviano |\n| `BRL` | Brazilian Real |\n| `BSD` | Bahamian Dollar |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CLP` | Chilean Peso |\n| `CNY` | Chinese Yuan |\n| `COP` | Colombian Peso |\n| `CRC` | Costa Rican Colón |\n| `CZK` | Czech Koruna |\n| `DKK` | Danish Krone |\n| `DOP` | Dominican Peso |\n| `DZD` | Algerian Dinar |\n| `EGP` | Egyptian Pound |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `GHS` | Ghanaian Cedi |\n| `GTQ` | Guatemalan Quetzal |\n| `HKD` | Hong Kong Dollar |\n| `HNL` | Honduran Lempira |\n| `HRK` | Croatian Kuna |\n| `HUF` | Hungarian Forint |\n| `IDR` | Indonesian Rupiah |\n| `ILS` | Israeli New Shekel |\n| `INR` | Indian Rupee |\n| `JMD` | Jamaican Dollar |\n| `JOD` | Jordanian Dinar |\n| `JPY` | Japanese Yen |\n| `KES` | Kenyan Shilling |\n| `KRW` | South Korean Won |\n| `KWD` | Kuwaiti Dinar |\n| `KYD` | Cayman Islands Dollar |\n| `KZT` | Kazakhstani Tenge |\n| `LBP` | Lebanese Pound |\n| `LKR` | Sri Lankan Rupee |\n| `MAD` | Moroccan Dirham |\n| `MUR` | Mauritian Rupee |\n| `MXN` | Mexican Peso |\n| `MXP` | Mexican Peso |\n| `MYR` | Malaysian Ringgit |\n| `NAD` | Namibian Dollar |\n| `NGN` | Nigerian Naira |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `PAB` | Panamanian Balboa |\n| `PEN` | Peruvian Sol |\n| `PHP` | Philippine Peso |\n| `PKR` | Pakistani Rupee |\n| `PLN` | Polish Złoty |\n| `PYG` | Paraguayan Guaraní |\n| `QAR` | Qatari Riyal |\n| `RON` | Romanian Leu |\n| `RSD` | Serbian Dinar |\n| `RUB` | Russian Ruble |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `THB` | Thai Baht |\n| `TND` | Tunisian Dinar |\n| `TRY` | Turkish Lira |\n| `TTD` | Trinidad and Tobago Dollar |\n| `TWD` | New Taiwan Dollar |\n| `TZS` | Tanzanian Shilling |\n| `UAH` | Ukrainian Hryvnia |\n| `USD` | United States Dollar |\n| `UYU` | Uruguayan Peso |\n| `VND` | Vietnamese Đồng |\n| `XAF` | Central African CFA Franc |\n| `XCD` | East Caribbean Dollar |\n| `XOF` | West African CFA Franc |\n| `XPF` | CFP Franc |\n| `ZAR` | South African Rand |\n","enum":["AED","ARS","AUD","AZN","BBD","BGN","BHD","BMD","BND","BOB","BRL","BSD","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","DZD","EGP","EUR","GBP","GHS","GTQ","HKD","HNL","HRK","HUF","IDR","ILS","INR","JMD","JOD","JPY","KES","KRW","KWD","KYD","KZT","LBP","LKR","MAD","MUR","MXN","MXP","MYR","NAD","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SEK","SGD","THB","TND","TRY","TTD","TWD","TZS","UAH","USD","UYU","VND","XAF","XCD","XOF","XPF","ZAR"],"type":"string"},"CustomData":{"description":"Custom data associated with the event to provide additional context.","properties":{"dataType":{"$ref":"#/components/schemas/DataType"},"name":{"description":"Name of the custom attribute. Only letters, numbers and the underscore character are allowed. e.g. brand, category, productId.","type":"string"},"value":{"description":"Value of the custom attribute. Only letters, numbers and the underscore character are allowed.","type":"string"}},"required":["name","value"],"type":"object"},"DSPAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n","enum":["AMAZON_DSP"],"type":"string"},"DVBrandSafetyAppAgeRatingType":{"enum":["ADULTS_ONLY_18_PLUS","EVERYONE_4_PLUS","MATURE_17_PLUS","TEENS_12_PLUS","TWEENS_9_PLUS","UNKNOWN"],"type":"string"},"DVBrandSafetyAppStarRatingType":{"description":"App star rating to be used for excluding apps.\n\n\n\n\n\n","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS"],"type":"string"},"DVBrandSafetyContentCategoriesWithRiskMap":{"description":"A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","properties":{"key":{"description":"Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","type":"string"},"value":{"$ref":"#/components/schemas/BrandSuitabilityRiskLevelType"}},"required":["key","value"],"type":"object"},"DVBrandSafetyContentCategoryType":{"enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","EXTREME_GRAPHIC","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"],"type":"string"},"DataProcessingOption":{"description":"**DataProcessingOption Enum:**\n| DataProcessingOption | Description |\n| --- | --- |\n| `LIMITED_DATA_USE` | Indicates that the event should be processed with limited data use. |","enum":["LIMITED_DATA_USE"],"type":"string"},"DataProcessingOptions":{"description":"A list of data processing options.","properties":{"options":{"$ref":"#/components/schemas/DataProcessingOption"}},"type":"object"},"DataType":{"description":"**DataType Enum:**\n| DataType | Description |\n| --- | --- |\n| `STRING` | String data type. |\n| `INTEGER` | 32-bit signed integer data type. |\n| `TIMESTAMP` | Timestamp data type. |","enum":["INTEGER","STRING","TIMESTAMP"],"type":"string"},"DatePeriod":{"properties":{"endDate":{"format":"date","type":"string"},"startDate":{"format":"date","type":"string"}},"required":["endDate","startDate"],"type":"object"},"DateTimeRange":{"description":"A date-time range with optional inclusive min and max bounds.","properties":{"max":{"description":"The maximum (inclusive) date time of the range.","format":"date-time","type":"string"},"min":{"description":"The minimum (inclusive) date time of the range.","format":"date-time","type":"string"}},"type":"object"},"DayOfWeek":{"description":"**DayOfWeek Enum:**\n\n| DayOfWeek | Description |\n|------|------|\n| `FRIDAY` | Friday. |\n| `MONDAY` | Monday. |\n| `SATURDAY` | Saturday. |\n| `SUNDAY` | Sunday. |\n| `THURSDAY` | Thursday. |\n| `TUESDAY` | Tuesday. |\n| `WEDNESDAY` | Wednesday. |\n","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"],"type":"string"},"DayPartTarget":{"description":"Target based on time of day.","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"timeOfDay":{"$ref":"#/components/schemas/TimeOfDay"}},"required":["dayOfWeek","timeOfDay"],"type":"object"},"DealAvails":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertisingDealId":{"description":"The advertising deal this avails record belongs to.","type":"string"},"appId":{"description":"App for this avails slice.","type":"string"},"audienceId":{"description":"Audience segment for this avails slice.","type":"string"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"creativeSize":{"$ref":"#/components/schemas/Size"},"dealAvailsId":{"description":"A unique identifier for the deal avails record.","type":"string"},"deviceType":{"$ref":"#/components/schemas/DeviceType"},"domainEntry":{"$ref":"#/components/schemas/DomainEntry"},"eligibleAvails":{"description":"Bid opportunities over the last 7 days eligible for bidding (bids and no-bids, excluding punts). Filtered by the EligibleAvailsTargeting when provided.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"eligibleAvailsTargeting":{"$ref":"#/components/schemas/EligibleAvailsTargeting"},"groupByAttributes":{"description":"Attributes to break results down by. When empty or omitted, results are aggregated to one entry per deal.","items":{"$ref":"#/components/schemas/DealAvailsAttributeField"},"maxItems":10,"minItems":0,"type":"array"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"supplierSellerId":{"description":"The supplier seller associated with this avails record.","type":"string"},"totalAvails":{"description":"Total bid opportunities over the last 7 days for this deal, including bids, no-bids, and punts. Not filtered by the EligibleAvailsTargeting.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["advertisingDealId","dealAvailsId","eligibleAvails","totalAvails"],"type":"object"},"DealAvailsAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DealAvailsAdvertisingDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DealAvailsAttributeField":{"description":"Available attributes for aggregating deal avails results.\n**DealAvailsAttributeField Enum:**\n| DealAvailsAttributeField | Description |\n| --- | --- |\n| `INVENTORY_TYPE` | Break down by inventory type (e.g. display, video, audio). |\n| `CREATIVE_SIZE` | Break down by creative size (width x height in DIPS). |\n| `SUPPLIER_SELLER` | Break down by supplier seller. |\n| `AUDIENCE` | Break down by audience. |\n| `APP` | Break down by app. |\n| `DOMAIN` | Break down by domain. |\n| `DEVICE_TYPE` | Break down by device type. |\n| `COUNTRY_CODE` | Break down by location (country code, ISO 3166-1 alpha-2). |","enum":["APP","AUDIENCE","COUNTRY_CODE","CREATIVE_SIZE","DEVICE_TYPE","DOMAIN","INVENTORY_TYPE","SUPPLIER_SELLER"],"type":"string"},"DealAvailsDealAvailsAttributeFieldFilter":{"properties":{"include":{"description":"**GroupByAttributes Enum:**\n| GroupByAttributes | Description |\n| --- | --- |\n| `INVENTORY_TYPE` | Break down by inventory type (e.g. display, video, audio). |\n| `CREATIVE_SIZE` | Break down by creative size (width x height in DIPS). |\n| `SUPPLIER_SELLER` | Break down by supplier seller. |\n| `AUDIENCE` | Break down by audience. |\n| `APP` | Break down by app. |\n| `DOMAIN` | Break down by domain. |\n| `DEVICE_TYPE` | Break down by device type. |\n| `COUNTRY_CODE` | Break down by location (country code, ISO 3166-1 alpha-2). |","items":{"$ref":"#/components/schemas/DealAvailsAttributeField"},"maxItems":8,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DealAvailsEligibleAvailsTargetingFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/EligibleAvailsTargeting"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DealAvailsSortOption":{"properties":{"by":{"$ref":"#/components/schemas/DealAvailsSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"DealAvailsSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| eligibleAvails | DESCENDING |\n| totalAvails | DESCENDING |","enum":["eligibleAvails","totalAvails"],"type":"string"},"DealAvailsSuccessResponse":{"properties":{"dealAvailses":{"items":{"$ref":"#/components/schemas/DealAvails"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"DealPerformance":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertisingDealId":{"description":"Reference to the associated advertising deal.","type":"string"},"availsByDeviceType":{"description":"A list of avails broken down by device type.","items":{"$ref":"#/components/schemas/AvailsForDeviceType"},"maxItems":30,"minItems":0,"type":"array"},"availsTotal":{"description":"The total number of impression opportunities.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"averageCpm":{"description":"Historical cost per thousand impressions over the period of time specified.","format":"double","type":"number"},"bidRequests":{"description":"The volume of bids with this deal ID that are eligible for the Amazon DSP.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"bidResponses":{"description":"The number of bid responses sent back to SSP or publisher for the applicable deal ID.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"clickthroughCount":{"description":"The number of times an ad is clicked.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"completionCount":{"description":"The number of times a video or audio ad is completed.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"conversionCount":{"description":"The number of times an impression resulted in an action.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"dealPerformanceId":{"description":"A unique identifier for the performance record.","type":"string"},"measurableImpressions":{"description":"The number of impressions that were measurable.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"metricsLastUpdated":{"description":"Last time the metrics were updated.","format":"date-time","type":"string"},"performanceEndDate":{"description":"End date for performance metrics period.","format":"date-time","type":"string"},"performanceStartDate":{"description":"Start date for performance metrics period.","format":"date-time","type":"string"},"recognizedBids":{"description":"The number of bid requests which include a recognized deal ID. This is divided by total bid requests for the deal to get recognition rate.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"totalImpressions":{"description":"The number of times an advertisement was displayed.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"totalSpend":{"description":"The total amount spent on the deal over the period of time specified.","format":"double","type":"number"},"viewableImpressions":{"description":"The number of impressions that were viewable.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["advertisingDealId","dealPerformanceId"],"type":"object"},"DealPerformanceSuccessResponse":{"properties":{"dealPerformances":{"items":{"$ref":"#/components/schemas/DealPerformance"},"maxItems":500,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"DealPlanningMetrics":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertisingDealId":{"description":"Reference to the associated advertising deal.","type":"string"},"clickThroughRate":{"description":"Rate of delivered ad impressions that users clicked on.","format":"double","type":"number"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"dealPlanningMetricsId":{"description":"A unique identifier for the planning metrics record.","type":"string"},"effectiveCPM":{"description":"Effective CPM actually cleared for impressions.","format":"double","type":"number"},"measuredRate":{"description":"Rate of impressions that were measurable for viewability.","format":"double","type":"number"},"videoCompletionRate":{"description":"Rate of video ad views that were viewed to completion (video end).","format":"double","type":"number"},"viewRate":{"description":"Rate of ad impressions that were measured as viewable.","format":"double","type":"number"},"viewableCPM":{"description":"Average CPM actually cleared for impressions that were deemed in view.","format":"double","type":"number"}},"required":["advertisingDealId","dealPlanningMetricsId"],"type":"object"},"DealPlanningMetricsSuccessResponse":{"properties":{"dealPlanningMetricses":{"items":{"$ref":"#/components/schemas/DealPlanningMetrics"},"maxItems":500,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"DeepLinkingBehavior":{"enum":["DISABLED","ENABLED"],"type":"string"},"DefaultAudienceTargetingMatchType":{"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 adGroup level, rather than at individual audience level. (Default: SIMILAR). Note, SIMILAR is not applicable to certain advertised product categories, [see here](https://advertising.amazon.com/help/GX8G7HNDS5RBX3EF) for more information.\n**DefaultAudienceTargetingMatchType Enum:**\n\n| DefaultAudienceTargetingMatchType | Description |\n|------|------|\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n","enum":["EXACT","SIMILAR"],"type":"string"},"DeleteAdAssociationRequest":{"properties":{"adAssociationIds":{"items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"}},"required":["adAssociationIds"],"type":"object"},"DeleteAdGroupRequest":{"properties":{"adGroupIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adGroupIds"],"type":"object"},"DeleteAdRequest":{"properties":{"adIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adIds"],"type":"object"},"DeleteCampaignRequest":{"properties":{"campaignIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["campaignIds"],"type":"object"},"DeleteReportRequest":{"properties":{"reportIds":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["reportIds"],"type":"object"},"DeleteRuleLinkRequest":{"properties":{"ruleLinkIds":{"items":{"$ref":"#/components/schemas/RuleLinkIdentity"},"maxItems":1,"minItems":1,"type":"array"}},"required":["ruleLinkIds"],"type":"object"},"DeleteRuleRequest":{"properties":{"ruleIds":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["ruleIds"],"type":"object"},"DeleteTargetRequest":{"properties":{"targetIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targetIds"],"type":"object"},"DeliveryProfile":{"description":"**DeliveryProfile Enum:**\n\n| DeliveryProfile | Description |\n|------|------|\n| `ASAP` | 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| `EVEN` | Even pacing spends your budget consistently across the length of the campaign. |\n| `PACE_AHEAD` | Pace Ahead can deliver up to 25% more than the daily Even pace targets. |\n","enum":["ASAP","EVEN","PACE_AHEAD"],"type":"string"},"DeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `ADVERTISER_ARCHIVED` |  |\n| `ADVERTISER_INELIGIBLE` |  |\n| `ADVERTISER_OUT_OF_BUDGET` | Indicates that an advertiser is out of budget for Sponsored Products campaigns for sellers. |\n| `ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT` | Indicates that a postpay advertiser is out of credit limit for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET` | Indicates that a postpay advertiser is out of monthly budget for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_PREPAY_BALANCE` | Indicates that a prepay advertiser is out of prepay balance for all Sponsored Ads campaigns. |\n| `ADVERTISER_PAUSED` |  |\n| `ADVERTISER_PAYMENT_FAILURE` |  |\n| `ADVERTISER_POLICING_PENDING_REVIEW` |  |\n| `ADVERTISER_POLICING_SUSPENDED` |  |\n| `AD_ARCHIVED` |  |\n| `AD_CREATION_FAILED` |  |\n| `AD_CREATION_IN_PROGRESS` |  |\n| `AD_CREATIVES_NOT_RUNNING` |  |\n| `AD_CREATOR_CONTENT_LICENSE_EXPIRED` |  |\n| `AD_EXTENSION_ARCHIVED` |  |\n| `AD_EXTENSION_PAUSED` |  |\n| `AD_EXTENSION_POLICING_PENDING_REVIEW` |  |\n| `AD_EXTENSION_POLICING_SUSPENDED` |  |\n| `AD_GROUPS_NOT_RUNNING` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INCOMPLETE` |  |\n| `AD_GROUP_INELIGIBLE_GOAL_KPI` | Indicates that the ad group is suspended because the campaign\u0027s goal KPI is not supported. |\n| `AD_GROUP_LOW_BID` |  |\n| `AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign is missing conversion tracking selections. |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_REVIEW` |  |\n| `AD_GROUP_PENDING_START_DATE` |  |\n| `AD_GROUP_POLICING_PENDING_REVIEW` |  |\n| `AD_GROUP_POLICING_SUSPENDED` |  |\n| `AD_GROUP_REJECTED` |  |\n| `AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign has an insufficient number of conversion tracking selections. |\n| `AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign exceeded the maximum number of conversion tracking selections. |\n| `AD_INELIGIBLE` |  |\n| `AD_MISSING_DECORATION` |  |\n| `AD_MISSING_IMAGE` |  |\n| `AD_NOT_APPROVED_FOR_ALL_AD_GROUPS` |  |\n| `AD_NOT_ASSOCIATED_WITH_AD_GROUP` |  |\n| `AD_NOT_DELIVERING` |  |\n| `AD_PAUSED` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `BRAND_INELIGIBLE` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_INCOMPLETE` |  |\n| `CAMPAIGN_OUT_OF_BUDGET` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_REVIEW` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_POLICING_SUSPENDED` |  |\n| `CAMPAIGN_REJECTED` |  |\n| `CREATIVE_MISSING_ASSET` |  |\n| `CREATIVE_PENDING_REVIEW` |  |\n| `CREATIVE_REJECTED` |  |\n| `LANDING_PAGE_INELIGIBLE` |  |\n| `LANDING_PAGE_NOT_AVAILABLE` |  |\n| `MODERATION_ADULT_NOVELTY_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION` |  |\n| `MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_NUDITY_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_SMOKING_POLICY_VIOLATION` |  |\n| `MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION` |  |\n| `MODERATION_ERROR_404` |  |\n| `MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION` |  |\n| `MODERATION_HFSS_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION` |  |\n| `MODERATION_NOT_COMPLIANT_TO_AD_POLICY` |  |\n| `MODERATION_SMOKING_RELATED_POLICY_VIOLATION` |  |\n| `NOT_BUYABLE` |  |\n| `NOT_IN_BUYBOX` |  |\n| `NOT_IN_POLICY` |  |\n| `NO_INVENTORY` |  |\n| `NO_PURCHASABLE_OFFER` |  |\n| `OTHER` |  |\n| `OUT_OF_REWARD_BUDGET` |  |\n| `OUT_OF_STOCK` |  |\n| `PIR_RULE_EXCLUDED` |  |\n| `PORTFOLIO_ARCHIVED` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `PORTFOLIO_PAUSED` |  |\n| `PORTFOLIO_PENDING_START_DATE` |  |\n| `RULE_ENDED` |  |\n| `RULE_LINK_PAUSED` |  |\n| `RULE_PAUSED` |  |\n| `RULE_SCHEDULED` |  |\n| `SECURITY_SCAN_PENDING_REVIEW` |  |\n| `SECURITY_SCAN_REJECTED` |  |\n| `SPEND_LIMIT_EXCEEDED` |  |\n| `STATUS_UNAVAILABLE` |  |\n| `TARGET_ARCHIVED` |  |\n| `TARGET_BLOCKED` |  |\n| `TARGET_PAUSED` |  |\n| `TARGET_POLICING_SUSPENDED` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_INELIGIBLE","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT","ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","AD_ARCHIVED","AD_CREATION_FAILED","AD_CREATION_IN_PROGRESS","AD_CREATIVES_NOT_RUNNING","AD_CREATOR_CONTENT_LICENSE_EXPIRED","AD_EXTENSION_ARCHIVED","AD_EXTENSION_PAUSED","AD_EXTENSION_POLICING_PENDING_REVIEW","AD_EXTENSION_POLICING_SUSPENDED","AD_GROUPS_NOT_RUNNING","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INCOMPLETE","AD_GROUP_INELIGIBLE_GOAL_KPI","AD_GROUP_LOW_BID","AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_PAUSED","AD_GROUP_PENDING_REVIEW","AD_GROUP_PENDING_START_DATE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_SUSPENDED","AD_GROUP_REJECTED","AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS","AD_INELIGIBLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_NOT_APPROVED_FOR_ALL_AD_GROUPS","AD_NOT_ASSOCIATED_WITH_AD_GROUP","AD_NOT_DELIVERING","AD_PAUSED","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","BRAND_INELIGIBLE","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_REVIEW","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_POLICING_SUSPENDED","CAMPAIGN_REJECTED","CREATIVE_MISSING_ASSET","CREATIVE_PENDING_REVIEW","CREATIVE_REJECTED","LANDING_PAGE_INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE","MODERATION_ADULT_NOVELTY_POLICY_VIOLATION","MODERATION_ADULT_PRODUCT_POLICY_VIOLATION","MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION","MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION","MODERATION_CONTENT_NUDITY_POLICY_VIOLATION","MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION","MODERATION_CONTENT_SMOKING_POLICY_VIOLATION","MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION","MODERATION_ERROR_404","MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION","MODERATION_HFSS_PRODUCT_POLICY_VIOLATION","MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION","MODERATION_NOT_COMPLIANT_TO_AD_POLICY","MODERATION_SMOKING_RELATED_POLICY_VIOLATION","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","NO_INVENTORY","NO_PURCHASABLE_OFFER","OTHER","OUT_OF_REWARD_BUDGET","OUT_OF_STOCK","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","RULE_ENDED","RULE_LINK_PAUSED","RULE_PAUSED","RULE_SCHEDULED","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","SPEND_LIMIT_EXCEEDED","STATUS_UNAVAILABLE","TARGET_ARCHIVED","TARGET_BLOCKED","TARGET_PAUSED","TARGET_POLICING_SUSPENDED"],"type":"string"},"DeliveryStatus":{"description":"**DeliveryStatus Enum:**\n\n| DeliveryStatus | Description |\n|------|------|\n| `DELIVERING` | Represents the resource is delivering. For global, DELIVERING status indicates that the resource is delivering in all marketplaces |\n| `LIMITED` | Represents partial delivery status, applicable to global resources that have different delivery status across marketplaces |\n| `NOT_DELIVERING` | Represents the resource is not delivering. For global, NOT_DELIVERING status indicates that the resource is NOT delivering in all marketplaces |\n| `UNAVAILABLE` | Represents unavailable resource status. For global, UNAVAILABLE status indicates that the status is unavailable in all marketplaces |\n","enum":["DELIVERING","LIMITED","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"DeviceInfo":{"description":"Device information associated with the conversion event.","properties":{"userAgent":{"description":"Raw user agent string from the browser or app at the time of the event. Max 512 characters.","type":"string"}},"type":"object"},"DeviceOrientation":{"description":"**DeviceOrientation Enum:**\n\n| DeviceOrientation | Description |\n|------|------|\n| `LANDSCAPE` | Device held horizontally. |\n| `PORTRAIT` | Device held vertically. |\n","enum":["LANDSCAPE","PORTRAIT"],"type":"string"},"DeviceTarget":{"description":"Target based on user device.","properties":{"deviceOrientation":{"$ref":"#/components/schemas/DeviceOrientation"},"deviceType":{"$ref":"#/components/schemas/DeviceType"},"mobileDevice":{"$ref":"#/components/schemas/MobileDevice"},"mobileEnvironment":{"$ref":"#/components/schemas/MobileEnvironment"},"mobileOs":{"$ref":"#/components/schemas/MobileOs"}},"required":["deviceType"],"type":"object"},"DeviceType":{"description":"**DeviceType Enum:**\n\n| DeviceType | Description |\n|------|------|\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |\n| `CONNECTED_TV` | Connected TV devices. |\n| `DESKTOP` | Desktop computers and laptops. |\n| `MOBILE` | Mobile phones and tablets. |\n| `UNKNOWN` | Unknown or unrecognized device type. |\n","enum":["CONNECTED_DEVICE","CONNECTED_TV","DESKTOP","MOBILE","UNKNOWN"],"type":"string"},"DeviceTypeTargetingEntry":{"description":"A device type targeting entry. All entries must share the same negative value.","properties":{"deviceType":{"$ref":"#/components/schemas/DeviceType"},"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["deviceType","groupId"],"type":"object"},"DimensionCriteria":{"description":"Defines dimension-based targeting criteria using generic dimension filters.","properties":{"dimensionJoinOperator":{"$ref":"#/components/schemas/JoinOperator"},"dimensions":{"description":"List of dimension filters to match.","items":{"$ref":"#/components/schemas/GenericDimension"},"maxItems":100,"minItems":1,"type":"array"}},"required":["dimensionJoinOperator","dimensions"],"type":"object"},"DimensionRuleAction":{"description":"The action to apply when dimension rule conditions are met.\n\n| DimensionRuleAction | Description |\n|------|------|\n| `tierAdjustment` | An ordinal tier adjustment. |\n| `valueAdjustment` | A numeric value adjustment. |\n","oneOf":[{"properties":{"tierAdjustment":{"$ref":"#/components/schemas/TierAdjustment"}},"required":["tierAdjustment"],"title":"tierAdjustment","type":"object"},{"properties":{"valueAdjustment":{"$ref":"#/components/schemas/ValueAdjustment"}},"required":["valueAdjustment"],"title":"valueAdjustment","type":"object"}]},"DimensionRuleCondition":{"description":"The set of conditions defined for a dimension rule.","properties":{"criteriaCondition":{"$ref":"#/components/schemas/CriteriaCondition"}},"required":["criteriaCondition"],"type":"object"},"DimensionRuleExpression":{"description":"Dimension-based bid rule expression with conditions and actions.","properties":{"actions":{"$ref":"#/components/schemas/DimensionRuleAction"},"conditions":{"$ref":"#/components/schemas/DimensionRuleCondition"}},"required":["actions","conditions"],"type":"object"},"DirectIndexValue":{"description":"Values for a location index where the indexValue is the pre-calculated index.","properties":{"indexValue":{"description":"The pre-calculated index value.","format":"double","type":"number"},"postalCode":{"description":"The postal code for the location index prefixed by country code (i.e. US-10118).","type":"string"}},"required":["indexValue","postalCode"],"type":"object"},"DirectIndexValues":{"properties":{"values":{"description":"List of direct index values.","items":{"$ref":"#/components/schemas/DirectIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"DisplayCallToAction":{"oneOf":[{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/ClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"},{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"}]},"DisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/StandardDisplaySettings"}},"type":"object"},"DistanceUnit":{"description":"**DistanceUnit Enum:**\n| DistanceUnit | Description |\n| --- | --- |\n| `KILOMETERS` | Distance in kilometers |\n| `MILES` | Distance in miles |","enum":["KILOMETERS","MILES"],"type":"string"},"DomainEntry":{"description":"A single domain entry in a domain list.","properties":{"domainName":{"description":"The domain name (e.g., example.com).","type":"string"}},"required":["domainName"],"type":"object"},"DomainFileTarget":{"description":"Targets domains based on list provided via file upload.","properties":{"domainFileId":{"description":"The ID associated to the domain file to target. Read-only and created based on the inputted domainFileKey.","type":"string"},"domainFileKey":{"description":"The S3 key of the uploaded file which can be obtained from the file upload policy endpoint. A max of 10 files may be associated to one ad group.","type":"string"},"domainFileName":{"description":"The name of the file.","type":"string"},"domainFileUrl":{"description":"The file containing the domains uploaded. It expires in one hour.","type":"string"}},"required":["domainFileKey","domainFileName"],"type":"object"},"DomainListTarget":{"description":"Targets domains based on an existing domain list.","properties":{"domainListId":{"description":"The ID of the domain list to target.","type":"string"}},"required":["domainListId"],"type":"object"},"DomainListTargetingEntry":{"description":"A domain list targeting entry. All entries must share the same negative value.","properties":{"domainListId":{"description":"The domain list to target.","type":"string"},"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["domainListId","groupId"],"type":"object"},"DomainNameTarget":{"description":"Targets domains based on URL.","properties":{"domainName":{"description":"The URL of the domain to target.","type":"string"}},"required":["domainName"],"type":"object"},"DomainTarget":{"description":"Target based on a specified domain.","properties":{"domainTargetDetails":{"$ref":"#/components/schemas/DomainTargetDetails"},"domainTargetType":{"$ref":"#/components/schemas/DomainTargetTypes"}},"required":["domainTargetDetails","domainTargetType"],"type":"object"},"DomainTargetDetails":{"oneOf":[{"properties":{"advertiserDomainList":{"$ref":"#/components/schemas/AdvertiserDomainList"}},"required":["advertiserDomainList"],"title":"advertiserDomainList","type":"object"},{"properties":{"domainFileTarget":{"$ref":"#/components/schemas/DomainFileTarget"}},"required":["domainFileTarget"],"title":"domainFileTarget","type":"object"},{"properties":{"domainListTarget":{"$ref":"#/components/schemas/DomainListTarget"}},"required":["domainListTarget"],"title":"domainListTarget","type":"object"},{"properties":{"domainNameTarget":{"$ref":"#/components/schemas/DomainNameTarget"}},"required":["domainNameTarget"],"title":"domainNameTarget","type":"object"}]},"DomainTargetTypes":{"description":"**DomainTargetTypes Enum:**\n\n| DomainTargetTypes | Description |\n|------|------|\n| `ADVERTISER_DOMAIN_LIST` | Target domains inherited from the advertiser. |\n| `DOMAIN_FILE` | Target domains from an uploaded file. |\n| `DOMAIN_LIST` | Target domains from an existing domain list. |\n| `DOMAIN_NAME` | Target a specific domain by URL. |\n","enum":["ADVERTISER_DOMAIN_LIST","DOMAIN_FILE","DOMAIN_LIST","DOMAIN_NAME"],"type":"string"},"DomainTargetingEntry":{"description":"A domain targeting entry. All entries must share the same negative value.","properties":{"domainEntry":{"$ref":"#/components/schemas/DomainEntry"},"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["domainEntry","groupId"],"type":"object"},"DoubleVerifyAuthenticAttention":{"properties":{"universalAttention":{"description":"One omni-channel segment that is informed by data from all DV campaigns to help avoid serving ads on generally poor performing apps and domains.","type":"boolean"}},"required":["universalAttention"],"type":"object"},"DoubleVerifyAuthenticBrandSafety":{"properties":{"doubleVerifySegmentId":{"pattern":"^51[0-9]{6}$","type":"string"}},"type":"object"},"DoubleVerifyBrandSafety":{"properties":{"appAgeRating":{"description":"A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.","items":{"$ref":"#/components/schemas/DVBrandSafetyAppAgeRatingType"},"maxItems":50,"minItems":0,"type":"array"},"appStarRating":{"$ref":"#/components/schemas/DVBrandSafetyAppStarRatingType"},"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"excludeAppsWithInsufficientRating":{"description":"Set to true to exclude unofficial apps or apps with insufficient user ratings (\u003c100 lifetime).","type":"boolean"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"DoubleVerifyCustomContextualSegmentId":{"properties":{"doubleVerifySegmentId":{"pattern":"^52[0-9]{6}$","type":"string"}},"type":"object"},"DoubleVerifyFraudInvalidTraffic":{"properties":{"blockAppAndSites":{"description":"Set to true to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen.","type":"boolean"},"excludeAppsAndSites":{"$ref":"#/components/schemas/ExcludeAppsAndSitesType"},"excludeImpressions":{"description":"Set to true to exclude impressions delivered to devices identified to be fraudulent or invalid.","type":"boolean"}},"type":"object"},"DoubleVerifyStandardDisplayBrandSafety":{"properties":{"contentCategories":{"description":"A list of content categories to exclude from targeting.","items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoryType"},"maxItems":50,"minItems":0,"type":"array"},"contentCategoriesWithRisk":{"items":{"$ref":"#/components/schemas/DVBrandSafetyContentCategoriesWithRiskMap"},"maxItems":50,"minItems":0,"type":"array"},"unknownContent":{"description":"Set to true to exclude unknown content.","type":"boolean"}},"type":"object"},"DoubleVerifyViewability":{"properties":{"averageCompletionAndFullyViewableRateTargeting":{"$ref":"#/components/schemas/AverageCompletionAndFullyViewableRateTargetingType"},"brandExposureViewabilityTargeting":{"$ref":"#/components/schemas/BrandExposureViewabilityTargetingType"},"includeUnmeasurableImpressions":{"description":"Set to true to include impressions where impressions can\u0027t be measured.","type":"boolean"},"mrcViewabilityTargeting":{"$ref":"#/components/schemas/MrcViewabilityTargetingType"}},"type":"object"},"DspContentRating":{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRatingEnum"}},"required":["dspContentRating"],"type":"object"},"DspContentRatingEnum":{"description":"**DspContentRatingEnum Enum:**\n\n| DspContentRatingEnum | Description |\n|------|------|\n| `RATING_NOT_AVAILABLE` | Content where rating isn\u0027t available from the publisher. |\n| `SUITABLE_FOR_ADULTS` | Ages 18+. Equivalent to content that is rated NC-17 (film). |\n| `SUITABLE_FOR_ALL_AUDIENCES` | Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game). |\n| `SUITABLE_FOR_MATURE_AUDIENCES` | Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game). |\n| `SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE` | Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game). |\n| `SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES` | Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game). |\n","enum":["RATING_NOT_AVAILABLE","SUITABLE_FOR_ADULTS","SUITABLE_FOR_ALL_AUDIENCES","SUITABLE_FOR_MATURE_AUDIENCES","SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE","SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES"],"type":"string"},"EligibleAvailsTargeting":{"description":"Targeting that filters eligible avails. All targeting dimensions are AND\u0027d together, except app and domain entries (including list variants) which are OR\u0027d together since a bid contains either an app or a domain, never both. Within a dimension, entries are composed via groupId (see individual entry descriptions). The combined total of entries across all targeting dimensions must not exceed 1000.","properties":{"appListTargetingEntries":{"description":"App list targeting entries. App, domain, app list, and domain list targeting entries are always combined with OR logic because a bid contains either an app or a domain, never both.","items":{"$ref":"#/components/schemas/AppListTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"appTargetingEntries":{"description":"App targeting entries. App, domain, app list, and domain list targeting entries are always combined with OR logic because a bid contains either an app or a domain, never both.","items":{"$ref":"#/components/schemas/AppTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"audienceTargetingEntries":{"description":"Audience targeting entries. Entries are grouped by groupId. Within a group, audiences are OR\u0027d (union). Across included groups, groups are AND\u0027d (intersection).","items":{"$ref":"#/components/schemas/AudienceTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"creativeSizeTargetingEntries":{"description":"Creative size targeting entries.","items":{"$ref":"#/components/schemas/CreativeSizeTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"deviceTypeTargetingEntries":{"description":"Device type targeting entries.","items":{"$ref":"#/components/schemas/DeviceTypeTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"domainListTargetingEntries":{"description":"Domain list targeting entries. App, domain, app list, and domain list targeting entries are always combined with OR logic because a bid contains either an app or a domain, never both.","items":{"$ref":"#/components/schemas/DomainListTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"domainTargetingEntries":{"description":"Domain targeting entries. App, domain, app list, and domain list targeting entries are always combined with OR logic because a bid contains either an app or a domain, never both.","items":{"$ref":"#/components/schemas/DomainTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"inventoryTypeTargetingEntries":{"description":"Inventory type targeting entries.","items":{"$ref":"#/components/schemas/InventoryTypeTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"locationTargetingEntries":{"description":"Location targeting entries.","items":{"$ref":"#/components/schemas/LocationTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"},"supplierSellerTargetingEntries":{"description":"Supplier seller targeting entries.","items":{"$ref":"#/components/schemas/SupplierSellerTargetingEntry"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n\n| ErrorCode | Description |\n|------|------|\n| `ACCESS_DENIED_FOR_MANAGER_ACCOUNT` | The request does not have access to the manager account provided in the registration request. |\n| `ACCOUNT_ALREADY_EXISTS_FOR_ACCOUNT_NAME` | An advertiser account already exists with this display name. |\n| `ACCOUNT_ALREADY_EXISTS_FOR_SELLING_ACCOUNT` | An advertiser account already exists for this selling account. |\n| `ACCOUNT_ALREADY_EXISTS_FOR_VENDOR` | An advertiser account already exists for the selected vendor. |\n| `ACCOUNT_NOT_ELIGIBLE` | The advertiser account does not meet the eligibility criteria for the promotion code. |\n| `ACTION_NOT_SUPPORTED` | The request is not supported. |\n| `ACTIVE_RESOURCE_LIMIT_EXCEEDED` | Too many live resources. Remove resources and try again. |\n| `ADDRESS_BUSINESS_NAME_TOO_LONG` | Business name provided is too long. |\n| `ADDRESS_INVALID_STATE` | The state provided in business address is invalid. |\n| `ARCHIVED_PARENT_CANNOT_CREATE` | New resources cannot be created within an archived parent. |\n| `ARCHIVED_PARENT_CANNOT_EDIT` | Resources within an archived parent cannot be edited. |\n| `ARCHIVED_RESOURCE_CANNOT_EDIT` | Archived resources cannot be edited. |\n| `ASSET_NOT_READY` | The provided asset is still being processed. |\n| `AUTOCREATED_ENTITY_CANNOT_EDIT` | Autocreated entities cannot be edited. To complete this action, create the resource manually. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `DATE_CANNOT_BE_IN_PAST` | Update the date to be in the future. |\n| `DATE_CANNOT_BE_NULL` | Update the date. |\n| `DATE_TOO_SOON` | Update the date to be further in the future. |\n| `DUPLICATE_FIELD_VALUE_FOUND` | Multiple resources share the non-unique field values. Remove the non-unique field value. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `DURATION_TOO_SHORT` | Update the length to be within the required range. |\n| `EXPIRED_PROMOTION_CODE` | The promotion code has expired. |\n| `FEATURE_DISCONTINUED` | Feature has been discontinued. |\n| `FEATURE_NOT_AVAILABLE` | The requested feature is not available. |\n| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO` | The campaign is associated with a global campaign. Portfolio association cannot be updated on a child campaign. Please perform operation on the global campaign. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE` | The campaign is associated with a global campaign. The state on child campaign cannot be set to archived. Please perform operation on global campaign. |\n| `GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT` | The campaign is associated with a global campaign. Only one ad group can be created under this campaign. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `INVALID_INPUT` | The request has invalid input parameters. |\n| `INVALID_PROMOTION_CODE` | The promotion code is invalid or does not exist. |\n| `INVALID_STATE_OR_REGION` | The state provided in business address is invalid. |\n| `INVALID_WEBSITE_URL` | The website url provided in business detail is invalid |\n| `INVALID_ZIP_CODE` | The zip code provided in business address is invalid. |\n| `MAXIMUM_REDEMPTIONS_REACHED` | Maximum redemptions for the advertiser account reached for the promotion code. |\n| `MISSING_ADDRESS_LINE_ONE` | Address line 1 is missing in business address. |\n| `MISSING_BUSINESS_NAME` | Business name is missing from business detail. |\n| `MISSING_CITY` | City is missing in business address. |\n| `MISSING_COUNTRY_CODE` | Country is missing in business address. |\n| `MISSING_PHONE_NUMBER` | Phone number is missing from business detail. |\n| `MISSING_STATE` | State is missing in business address. |\n| `MISSING_WEBSITE_URL` | Website url is missing from business detail. |\n| `MISSING_ZIP_CODE` | Zip code is missing in business address. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACCESS_DENIED_FOR_MANAGER_ACCOUNT","ACCOUNT_ALREADY_EXISTS_FOR_ACCOUNT_NAME","ACCOUNT_ALREADY_EXISTS_FOR_SELLING_ACCOUNT","ACCOUNT_ALREADY_EXISTS_FOR_VENDOR","ACCOUNT_NOT_ELIGIBLE","ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ADDRESS_BUSINESS_NAME_TOO_LONG","ADDRESS_INVALID_STATE","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","ASSET_NOT_READY","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","EXPIRED_PROMOTION_CODE","FEATURE_DISCONTINUED","FEATURE_NOT_AVAILABLE","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE","GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT","INTERNAL_ERROR","INVALID_INPUT","INVALID_PROMOTION_CODE","INVALID_STATE_OR_REGION","INVALID_WEBSITE_URL","INVALID_ZIP_CODE","MAXIMUM_REDEMPTIONS_REACHED","MISSING_ADDRESS_LINE_ONE","MISSING_BUSINESS_NAME","MISSING_CITY","MISSING_COUNTRY_CODE","MISSING_PHONE_NUMBER","MISSING_STATE","MISSING_WEBSITE_URL","MISSING_ZIP_CODE","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"Event":{"properties":{"amazonAdEventKey":{"description":"Amazon Traffic identifier for post attributed events (if applicable).","type":"string"},"arefMeasurementTokens":{"description":"Pipe-separated measurement token pairs extracted from the aref parameter of the ad click URL. Each pair is formatted as \u003ctoken\u003e.\u003cunix_timestamp_ms\u003e. Token is a 10-char alphanumeric string; timestamp is 13-digit epoch milliseconds UTC. Multiple pairs are separated by \u0027|\u0027. Sent as a raw string. Used for deterministic click-level attribution.","type":"string"},"consent":{"$ref":"#/components/schemas/Consent"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customData":{"description":"Custom data associated with the event.","items":{"$ref":"#/components/schemas/CustomData"},"maxItems":13,"minItems":0,"type":"array"},"dataProcessingOptions":{"$ref":"#/components/schemas/DataProcessingOptions"},"deviceInfo":{"$ref":"#/components/schemas/DeviceInfo"},"eventDescription":{"$ref":"#/components/schemas/EventDescription"},"eventId":{"description":"The client specified id for the event. For events with the same eventId only the latest event will be kept.","type":"string"},"eventTime":{"description":"The reported timestamp of when the event occurred.","format":"date-time","type":"string"},"matchKeys":{"description":"Array representing the user and device identifier types/values to be used for attribution to traffic events. Match key value must be normalized and hashed, except for MAID, RAMP_ID, MATCH_ID, REAL_ID, MERKLE_ID, KANTAR_ID, and FIP. ADID, IDFA, or FIREADID can be passed into the MAID field for mobile identifiers.","items":{"$ref":"#/components/schemas/MatchKey"},"maxItems":15,"minItems":1,"type":"array"},"partner":{"description":"The name of the third-party service used to deliver the conversions (if applicable).","type":"string"},"unitsSold":{"description":"The number of items purchased. Only applicable for OFF_AMAZON_PURCHASES event type. If not provided on the event, a default of 1 will be applied.","format":"int32","type":"integer"},"value":{"description":"Represents value of the event. For OFF_AMAZON_PURCHASES conversionType, represents monetary value (min 0, max 2 decimals). For other conversionTypes, represents non-monetary value on your chosen scale (can be negative, max 2 decimals). Uses template default if not provided.","format":"double","type":"number"}},"required":["countryCode","eventDescription","eventTime","matchKeys"],"type":"object"},"EventCreate":{"properties":{"amazonAdEventKey":{"description":"Amazon Traffic identifier for post attributed events (if applicable).","type":"string"},"arefMeasurementTokens":{"description":"Pipe-separated measurement token pairs extracted from the aref parameter of the ad click URL. Each pair is formatted as \u003ctoken\u003e.\u003cunix_timestamp_ms\u003e. Token is a 10-char alphanumeric string; timestamp is 13-digit epoch milliseconds UTC. Multiple pairs are separated by \u0027|\u0027. Sent as a raw string. Used for deterministic click-level attribution.","type":"string"},"consent":{"$ref":"#/components/schemas/CreateConsent"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customData":{"description":"Custom data associated with the event.","items":{"$ref":"#/components/schemas/CreateCustomData"},"maxItems":13,"minItems":0,"type":"array"},"dataProcessingOptions":{"$ref":"#/components/schemas/CreateDataProcessingOptions"},"deviceInfo":{"$ref":"#/components/schemas/CreateDeviceInfo"},"eventDescription":{"$ref":"#/components/schemas/CreateEventDescription"},"eventId":{"description":"The client specified id for the event. For events with the same eventId only the latest event will be kept.","type":"string"},"eventTime":{"description":"The reported timestamp of when the event occurred.","format":"date-time","type":"string"},"matchKeys":{"description":"Array representing the user and device identifier types/values to be used for attribution to traffic events. Match key value must be normalized and hashed, except for MAID, RAMP_ID, MATCH_ID, REAL_ID, MERKLE_ID, KANTAR_ID, and FIP. ADID, IDFA, or FIREADID can be passed into the MAID field for mobile identifiers.","items":{"$ref":"#/components/schemas/CreateMatchKey"},"maxItems":15,"minItems":1,"type":"array"},"partner":{"description":"The name of the third-party service used to deliver the conversions (if applicable).","type":"string"},"unitsSold":{"description":"The number of items purchased. Only applicable for OFF_AMAZON_PURCHASES event type. If not provided on the event, a default of 1 will be applied.","format":"int32","type":"integer"},"value":{"description":"Represents value of the event. For OFF_AMAZON_PURCHASES conversionType, represents monetary value (min 0, max 2 decimals). For other conversionTypes, represents non-monetary value on your chosen scale (can be negative, max 2 decimals). Uses template default if not provided.","format":"double","type":"number"}},"required":["countryCode","eventDescription","eventTime","matchKeys"],"type":"object"},"EventDescription":{"description":"The composite key that uniquely identifies an event.","properties":{"conversionType":{"$ref":"#/components/schemas/ConversionType"},"dataSetName":{"description":"Event DataSet name to which this event should be added to.","pattern":"[A-Za-z][A-Za-z0-9_-]*","type":"string"},"eventIngestionMethod":{"$ref":"#/components/schemas/EventIngestionMethod"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"name":{"description":"The name of the imported event.","type":"string"}},"required":["conversionType","eventIngestionMethod","eventSource","name"],"type":"object"},"EventIngestionMethod":{"description":"**EventIngestionMethod Enum:**\n| EventIngestionMethod | Description |\n| --- | --- |\n| `SERVER_TO_SERVER` | Events tracked with the events import API. |","enum":["SERVER_TO_SERVER"],"type":"string"},"EventMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":500,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/EventMultiStatusSuccess"},"maxItems":500,"minItems":0,"type":"array"}},"type":"object"},"EventMultiStatusSuccess":{"properties":{"event":{"$ref":"#/components/schemas/Event"},"index":{"format":"int32","maximum":499,"minimum":0,"type":"integer"}},"required":["event","index"],"type":"object"},"EventSource":{"description":"**EventSource Enum:**\n| EventSource | Description |\n| --- | --- |\n| `ANDROID` | Events from a mobile application on the Android operating system. |\n| `FIRE_TV` | Events from a mobile application on the Fire TV operating system. |\n| `IOS` | Events from a mobile application on the iOS operating system. |\n| `OFFLINE` | Events captured and reported via an offline mechanism. These could be events from in-store purchases, in-office activities, etc. |\n| `WEBSITE` | Events tracked on a website. |\n| `MEASUREMENT_ATTRIBUTION_PARTNER` | Events from a 3P measurement attribution partner. |","enum":["ANDROID","FIRE_TV","IOS","MEASUREMENT_ATTRIBUTION_PARTNER","OFFLINE","WEBSITE"],"type":"string"},"ExcludeAppsAndSitesType":{"enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_02","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_50"],"type":"string"},"Fee":{"properties":{"addToBudgetSpentAmount":{"description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports.","type":"boolean"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"feeType":{"$ref":"#/components/schemas/FeeType"},"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, 100 represents 100%.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/FeeValueType"},"thirdPartyProvider":{"$ref":"#/components/schemas/FeesThirdPartyProvider"}},"required":["addToBudgetSpentAmount","feeType","feeValue","feeValueType","thirdPartyProvider"],"type":"object"},"FeeType":{"description":"**FeeType Enum:**\n\n| FeeType | Description |\n|------|------|\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\n| `AMAZON_DSP` | A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost. |\n| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |\n| `OMNICHANNEL_METRICS` | Fee for using Amazon Omnichannel Metrics. |\n| `THIRD_PARTY_APPLIED` | 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_AUDIENCE` | CPM fee for using a third party audience. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n","enum":["AMAZON_AUDIENCE","AMAZON_DSP","MANAGED_SERVICE_FEE","OMNICHANNEL_METRICS","THIRD_PARTY_APPLIED","THIRD_PARTY_AUDIENCE","THIRD_PARTY_TARGETING"],"type":"string"},"FeeValueType":{"description":"**FeeValueType Enum:**\n\n| FeeValueType | Description |\n|------|------|\n| `FIXED_CPM` | Charged based on a fixed CPM. The currency depends on the feeType. |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |\n| `PERCENTAGE_OF_SUPPLY_COST` | Charged as a percent of supply (media) cost. Ranges from 0 to 1 where 0.15 represents 15%. |\n","enum":["FIXED_CPM","PERCENTAGE_OF_BUDGET","PERCENTAGE_OF_SUPPLY_COST"],"type":"string"},"FeesThirdPartyProvider":{"enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"],"type":"string"},"Filter":{"oneOf":[{"properties":{"and":{"$ref":"#/components/schemas/CompositePredicate"}},"required":["and"],"title":"and","type":"object"},{"properties":{"on":{"$ref":"#/components/schemas/ComparisonPredicate"}},"required":["on"],"title":"on","type":"object"}]},"FlightBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/BudgetValue"}},"required":["budgetType","budgetValue"],"type":"object"},"FoldPosition":{"description":"**FoldPosition Enum:**\n\n| FoldPosition | Description |\n|------|------|\n| `ABOVE_THE_FOLD` | Ad placement visible without scrolling. |\n| `BELOW_THE_FOLD` | Ad placement visible only after scrolling. |\n| `UNKNOWN` | Unknown fold position. |\n","enum":["ABOVE_THE_FOLD","BELOW_THE_FOLD","UNKNOWN"],"type":"string"},"FoldPositionTarget":{"description":"Targets ads in the specified fold position","properties":{"foldPosition":{"$ref":"#/components/schemas/FoldPosition"}},"required":["foldPosition"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"FormatProperties":{"properties":{"applyBorder":{"description":"Apply a boarder to the image to fit rules for some supplies.","type":"boolean"},"height":{"description":"The height (in pixels) of the cropped image.","format":"int32","type":"integer"},"left":{"description":"The number of pixels from the left of the image where the crop should begin.","format":"int32","type":"integer"},"top":{"description":"The number of pixels from the top of the image where the crop should begin.","format":"int32","type":"integer"},"width":{"description":"The width (in pixels) of the cropped image.","format":"int32","type":"integer"}},"type":"object"},"Frequency":{"properties":{"eventMaxCount":{"description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500.","format":"int32","maximum":99000,"minimum":1,"type":"integer"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/FrequencyTargetingSetting"},"timeCount":{"description":"The value associated with the time and unit of time for this frequency cap.","format":"int32","maximum":60,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/TimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting","timeCount","timeUnit"],"type":"object"},"FrequencyTargetingSetting":{"description":"**FrequencyTargetingSetting Enum:**\n\n| FrequencyTargetingSetting | Description |\n|------|------|\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |\n| `USER` | Control frequency an ad will be selected to a person. |\n","enum":["HOUSEHOLD","USER"],"type":"string"},"FulfilmentCriterion":{"oneOf":[{"properties":{"campaignLaunchFulfilmentCriterion":{"$ref":"#/components/schemas/CampaignLaunchFulfilmentCriterion"}},"required":["campaignLaunchFulfilmentCriterion"],"title":"campaignLaunchFulfilmentCriterion","type":"object"},{"properties":{"spendsFulfilmentCriterion":{"$ref":"#/components/schemas/SpendsFulfilmentCriterion"}},"required":["spendsFulfilmentCriterion"],"title":"spendsFulfilmentCriterion","type":"object"}]},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GenericDimension":{"description":"A generic dimension filter. Uses string-based dimension types to avoid schema changes when new targeting dimensions are added.","properties":{"dimensionType":{"description":"The type of dimension (e.g., DEVICE_TYPE, BROWSER, REGION, OPERATING_SYSTEM).","type":"string"},"dimensionValues":{"description":"The values to match for this dimension (e.g., [phone, tablet] for DEVICE_TYPE).","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"negative":{"description":"If true, applies NOT operator to this dimension filter. Default is false.","type":"boolean"}},"required":["dimensionType","dimensionValues"],"type":"object"},"GeoLocation":{"properties":{"geoLocationId":{"description":"The identifier of the geo location.","type":"string"},"location":{"$ref":"#/components/schemas/GeoLocationUnion"}},"required":["geoLocationId","location"],"type":"object"},"GeoLocationCoordinates":{"description":"Coordinates for a point of interest","properties":{"latitude":{"description":"Latitude coordinate. Example 47.6157","format":"double","type":"number"},"longitude":{"description":"Longitude coordinate. Example 122.339","format":"double","type":"number"}},"required":["latitude","longitude"],"type":"object"},"GeoLocationCreate":{"properties":{"location":{"$ref":"#/components/schemas/CreateGeoLocationUnion"}},"required":["location"],"type":"object"},"GeoLocationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/GeoLocationMultiStatusSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"GeoLocationMultiStatusSuccess":{"properties":{"geoLocation":{"$ref":"#/components/schemas/GeoLocation"},"index":{"format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["geoLocation","index"],"type":"object"},"GeoLocationUnion":{"oneOf":[{"properties":{"radiusLocation":{"$ref":"#/components/schemas/RadiusLocation"}},"required":["radiusLocation"],"title":"radiusLocation","type":"object"},{"properties":{"smartLocation":{"$ref":"#/components/schemas/SmartLocation"}},"required":["smartLocation"],"title":"smartLocation","type":"object"}]},"GeographicConsentData":{"description":"Captures the user\u0027s geographic information for purposes of consent checking.","properties":{"ipAddress":{"description":"IP address of the user associated with the conversion event.","type":"string"}},"required":["ipAddress"],"type":"object"},"GlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"Goal":{"description":"**Goal Enum:**\n\n| Goal | Description |\n|------|------|\n| `AWARENESS` | Indicates a goal of driving awareness. |\n| `CONSIDERATION` | Indicates a goal of driving consideration. |\n| `CONVERSIONS` | Indicates a goal of driving conversions. |\n","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"],"type":"string"},"GoalSettings":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"goal":{"$ref":"#/components/schemas/Goal"},"kpi":{"$ref":"#/components/schemas/KPI"},"kpiValue":{"description":"The value of the KPI that the campaign is working to optimize.","format":"double","type":"number"}},"required":["goal","kpi"],"type":"object"},"HorizontalPosition":{"description":"| HorizontalPosition | Description |\n|------|------|\n| `CENTER` | Center position |\n| `LEFT` | Left position |\n| `RIGHT` | Right position |\n","enum":["CENTER","LEFT","RIGHT"],"type":"string"},"IASBrandSafetyLevelType":{"description":"The IAS brand safety risk level.\n\n\n\n\n\n","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"],"type":"string"},"IASFraudInvalidTrafficType":{"description":"The type of fraud invalid traffic.\n\n\n\n\n\n","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK"],"type":"string"},"IASViewabilityStandardType":{"description":"The viewability standard.\n\n\n\n\n\n","enum":["GROUPM","MRC","NONE","PUBLICIS"],"type":"string"},"Image":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/FormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"ImpressionBudgetValue":{"properties":{"impression":{"description":"The impression cap of the budget cap.","format":"double","type":"number"}},"required":["impression"],"type":"object"},"InGroupOperator":{"description":"**InGroupOperator Enum:**\n\n| InGroupOperator | Description |\n|------|------|\n| `ALL` | Matches only if every single condition is true. InGroupOperator is used among audiences within the same audience group. This is a read-only field. |\n| `ANY` | Matches if at least one condition is true. InGroupOperator is used among audiences within the same audience group. This is a read-only field. |\n","enum":["ALL","ANY"],"type":"string"},"IndexStatus":{"description":"**IndexStatus Enum:**\n\n| IndexStatus | Description |\n|------|------|\n| `ENABLED` | The location index is active and can be used in smart locations. |\n| `FAILED` | The location index creation failed and cannot be used in smart locations. |\n| `PENDING` | The location index is being created and cannot be used in smart locations yet. |\n| `UPDATE_FAILED` | The location index update has failed, but the old version can still be used. |\n","enum":["ENABLED","FAILED","PENDING","UPDATE_FAILED"],"type":"string"},"IndexValues":{"oneOf":[{"properties":{"constituentIndexValues":{"$ref":"#/components/schemas/ConstituentIndexValues"}},"required":["constituentIndexValues"],"title":"constituentIndexValues","type":"object"},{"properties":{"directIndexValues":{"$ref":"#/components/schemas/DirectIndexValues"}},"required":["directIndexValues"],"title":"directIndexValues","type":"object"}]},"IndustryVertical":{"description":"**IndustryVertical Enum:**\n\n| IndustryVertical | Description |\n|------|------|\n| `AMS Keyword` | AMS Keyword |\n| `AMS Self Service` | AMS Self Service |\n| `Automotive` | Automotive |\n| `Consumer Goods` | Consumer Goods |\n| `Entertainment` | Entertainment |\n| `Financial Services` | Financial Services |\n| `Hardware \u0026 Electronics` | Hardware \u0026 Electronics |\n| `Health` | Health |\n| `House Ads` | House Ads |\n| `Public Services` | Public Services |\n| `Remnant Networks` | Remnant Networks |\n| `Retail Goods \u0026 Services` | Retail Goods \u0026 Services |\n| `Software` | Software |\n| `Telecommunications` | Telecommunications |\n| `Travel` | Travel |\n| `Twitch TV` | Twitch TV |\n| `Twitch` | Twitch |\n| `Web Media` | Web Media |\n| `eCommerce` | eCommerce |\n","enum":["AMS Keyword","AMS Self Service","Automotive","Consumer Goods","Entertainment","Financial Services","Hardware \u0026 Electronics","Health","House Ads","Public Services","Remnant Networks","Retail Goods \u0026 Services","Software","Telecommunications","Travel","Twitch","Twitch TV","Web Media","eCommerce"],"type":"string","x-enum-varnames":["AMS_KEYWORD","AMS_SELF_SERVICE","AUTOMOTIVE","CONSUMER_GOODS","ECOMMERCE","ENTERTAINMENT","FINANCIAL_SERVICES","HARDWARE_AND_ELECTRONICS","HEALTH","HOUSE_ADS","PUBLIC_SERVICES","REMNANT_NETWORKS","RETAIL_GOODS_AND_SERVICES","SOFTWARE","TELECOMMUNICATIONS","TRAVEL","TWITCH","TWITCH_TV","WEB_MEDIA"]},"IneligibleAutomatedTargetingTactic":{"description":"Information about an ineligible tactic key and the reasons for ineligibility","properties":{"reasons":{"description":"List of reasons why this tactic key is ineligible","items":{"$ref":"#/components/schemas/IneligibleAutomatedTargetingTacticReason"},"maxItems":10,"minItems":0,"type":"array"},"tacticKey":{"$ref":"#/components/schemas/TacticKey"}},"required":["tacticKey"],"type":"object"},"IneligibleAutomatedTargetingTacticReason":{"description":"A single reason for tactic type ineligibility","properties":{"reasonCode":{"$ref":"#/components/schemas/IneligibleAutomatedTargetingTacticReasonCode"},"reasonMessage":{"description":"Human readable explanation of why this tactic type is ineligible","type":"string"}},"required":["reasonCode","reasonMessage"],"type":"object"},"IneligibleAutomatedTargetingTacticReasonCode":{"description":"Reason codes for why a tactic type is ineligible\n**IneligibleAutomatedTargetingTacticReasonCode Enum:**\n\n| IneligibleAutomatedTargetingTacticReasonCode | Description |\n|------|------|\n| `CONVERSION_SELECTIONS_EMPTY` | Campaign has no product or conversion event associations. |\n| `CONVERSION_SELECTIONS_EXCEEDED` | Campaign is associated with too many products or conversion events. |\n| `CONVERSION_SELECTIONS_MINIMUM_NOT_MET` | Minimum product or conversion event constraints not met. |\n| `NOT_ELIGIBLE_ADVERTISER` | The advertiser is not eligible for this tactic. |\n| `NOT_ELIGIBLE_GOAL` | The current campaign goal is not compatible with this tactic type. |\n| `NOT_ELIGIBLE_INVENTORY_TYPE` | This campaign\u0027s primary inventory types are not supported with this tactic type. |\n| `UNSUPPORTED_COUNTRY` | Selected tactic type is not available for the given country. |\n","enum":["CONVERSION_SELECTIONS_EMPTY","CONVERSION_SELECTIONS_EXCEEDED","CONVERSION_SELECTIONS_MINIMUM_NOT_MET","NOT_ELIGIBLE_ADVERTISER","NOT_ELIGIBLE_GOAL","NOT_ELIGIBLE_INVENTORY_TYPE","UNSUPPORTED_COUNTRY"],"type":"string"},"IntegralAdScienceBrandSafety":{"properties":{"excludeContent":{"description":"Set to true to exclude content that Integral Ad Science is not able to rate.","type":"boolean"},"iasBrandSafetyAdult":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyAlcohol":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyGambling":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyHateSpeech":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDownloads":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyIllegalDrugs":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyOffensiveLanguage":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"},"iasBrandSafetyViolence":{"$ref":"#/components/schemas/IASBrandSafetyLevelType"}},"type":"object"},"IntegralAdScienceContextualAvoidance":{"properties":{"avoidanceSegments":{"description":"The unique identifier of the IAS contextual avoidance segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"IntegralAdScienceContextualTargeting":{"properties":{"topicalSegments":{"description":"The unique identifier of the IAS contextual topical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"},"verticalSegments":{"description":"The unique identifier of the IAS contextual vertical targeting segment","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"IntegralAdScienceFraudInvalidTraffic":{"properties":{"targetSetting":{"$ref":"#/components/schemas/IASFraudInvalidTrafficType"}},"type":"object"},"IntegralAdScienceQualitySync":{"properties":{"segmentId":{"pattern":"^4[0-9]{6}$","type":"string"}},"type":"object"},"IntegralAdScienceViewability":{"description":"The IAS viewability standard.","properties":{"standard":{"$ref":"#/components/schemas/IASViewabilityStandardType"},"viewabilityTargeting":{"$ref":"#/components/schemas/ViewabilityTierType"}},"required":["standard"],"type":"object"},"IntegrationType":{"description":"**IntegrationType Enum:**\n| IntegrationType | Description |\n| --- | --- |\n| `DIRECT` | Supplier is directly integrated with ADSP via OpenRTB. |\n| `BIDSWITCH` | Supplier routes inventory through BidSwitch as an intermediary. |","enum":["BIDSWITCH","DIRECT"],"type":"string"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InventorySourceTarget":{"description":"Target based on the source of the inventory.","properties":{"inventorySourceId":{"$ref":"#/components/schemas/MarketplaceStringValue"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceType"}},"required":["inventorySourceId","inventorySourceType"],"type":"object"},"InventorySourceType":{"description":"**InventorySourceType Enum:**\n\n| InventorySourceType | Description |\n|------|------|\n| `AMAZON` | Amazon-owned inventory. |\n| `APD` | Amazon Publisher Direct inventory. |\n| `DEAL` | Deal-based inventory. |\n| `INVENTORY_GROUP` | A group representing a set of inventories. |\n| `THIRD_PARTY_EXCHANGE` | Third-party exchange inventory. |\n","enum":["AMAZON","APD","DEAL","INVENTORY_GROUP","THIRD_PARTY_EXCHANGE"],"type":"string"},"InventoryType":{"description":"**InventoryType Enum:**\n\n| InventoryType | Description |\n|------|------|\n| `AAP_MOBILE_APP` |  |\n| `AMAZON_MOBILE_DISPLAY` |  |\n| `AUDIO_AMAZON_DEAL` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |\n| `DISPLAY` |  |\n| `LIVE_EVENTS` | Real-time broadcast inventory (sports, concerts, award shows) with audience volatility and concentrated traffic patterns requiring specialized pacing algorithms and event-specific metadata handling. |\n| `ONLINE_VIDEO` |  |\n| `PODCAST` | Podcast ads that serve on streaming podcast inventory. |\n| `STANDARD_DISPLAY` |  |\n| `STREAMING_TV_AMAZON_DEAL` |  |\n| `STREAMING_TV` |  |\n| `VIDEO` |  |\n","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","AUDIO_AMAZON_DEAL","DISPLAY","LIVE_EVENTS","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","STREAMING_TV_AMAZON_DEAL","VIDEO"],"type":"string"},"InventoryTypeTargetingEntry":{"description":"An inventory type targeting entry. All entries must share the same negative value.","properties":{"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["groupId","inventoryType"],"type":"object"},"JoinOperator":{"enum":["AND","OR"],"type":"string"},"KPI":{"description":"**KPI Enum:**\n\n| KPI | Description |\n|------|------|\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |\n","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","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_AVERAGE","LEADS","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"],"type":"string"},"KeywordMatchType":{"description":"**KeywordMatchType Enum:**\n\n| KeywordMatchType | Description |\n|------|------|\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE. |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n","enum":["BROAD","EXACT","PHRASE"],"type":"string"},"KeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target. For valid characters and constraints, [see keyword character constraints](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#keyword-character-constraints).","type":"string"},"matchType":{"$ref":"#/components/schemas/KeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"LandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["asins"],"type":"object"},"LanguageLocale":{"description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.\n**LanguageLocale Enum:**\n\n| LanguageLocale | Description |\n|------|------|\n| `aa_ET` | Afar (Ethiopia). |\n| `ab_GE` | Abkhazian (Georgia). |\n| `ae_INT` | Avestan (International). |\n| `af_ZA` | Afrikaans (South Africa). |\n| `ak_GH` | Akan (Ghana). |\n| `am_ET` | Amharic (Ethiopia). |\n| `an_ES` | Aragonese (Spain). |\n| `ar_AE` | Arabic (UAE). |\n| `as_IN` | Assamese (India). |\n| `av_RU` | Avaric (Russia). |\n| `ay_BO` | Aymara (Bolivia). |\n| `az_AZ` | Azerbaijani (Azerbaijan). |\n| `ba_RU` | Bashkir (Russia). |\n| `be_BY` | Belarusian (Belarus). |\n| `bg_BG` | Bulgarian (Bulgaria). |\n| `bh_IN` | Bihari (India). |\n| `bi_VU` | Bislama (Vanuatu). |\n| `bm_ML` | Bambara (Mali). |\n| `bn_BD` | Bengali (Bangladesh). |\n| `bo_CN` | Tibetan (China). |\n| `br_FR` | Breton (France). |\n| `bs_BA` | Bosnian (Bosnia and Herzegovina). |\n| `ca_ES` | Catalan (Spain). |\n| `ce_RU` | Chechen (Russia). |\n| `ch_GU` | Chamorro (Guam). |\n| `co_FR` | Corsican (France). |\n| `cr_CA` | Cree (Canada). |\n| `cs_CZ` | Czech (Czech Republic). |\n| `cu_INT` | Church Slavonic (International). |\n| `cv_RU` | Chuvash (Russia). |\n| `cy_GB` | Welsh (United Kingdom). |\n| `da_DK` | Danish (Denmark). |\n| `de_DE` | German (Germany). |\n| `dv_MV` | Divehi (Maldives). |\n| `dz_BT` | Dzongkha (Bhutan). |\n| `ee_GH` | Ewe (Ghana). |\n| `el_GR` | Greek (Greece). |\n| `en_US` | English (United States). |\n| `eo_INT` | Esperanto (International). |\n| `es_ES` | Spanish (Spain). |\n| `et_EE` | Estonian (Estonia). |\n| `eu_ES` | Basque (Spain). |\n| `fa_IR` | Persian (Iran). |\n| `ff_SN` | Fulah (Senegal). |\n| `fi_FI` | Finnish (Finland). |\n| `fj_FJ` | Fijian (Fiji). |\n| `fo_FO` | Faroese (Faroe Islands). |\n| `fr_FR` | French (France). |\n| `fy_NL` | Western Frisian (Netherlands). |\n| `ga_IE` | Irish (Ireland). |\n| `gd_GB` | Scottish Gaelic (United Kingdom). |\n| `gl_ES` | Galician (Spain). |\n| `gn_PY` | Guarani (Paraguay). |\n| `gu_IN` | Gujarati (India). |\n| `gv_IM` | Manx (Isle of Man). |\n| `ha_NG` | Hausa (Nigeria). |\n| `he_IL` | Hebrew (Israel). |\n| `hi_IN` | Hindi (India). |\n| `ho_PG` | Hiri Motu (Papua New Guinea). |\n| `hr_HR` | Croatian (Croatia). |\n| `ht_HT` | Haitian Creole (Haiti). |\n| `hu_HU` | Hungarian (Hungary). |\n| `hy_AM` | Armenian (Armenia). |\n| `hz_NA` | Herero (Namibia). |\n| `ia_INT` | Interlingua (International). |\n| `id_ID` | Indonesian (Indonesia). |\n| `ie_INT` | Interlingue (International). |\n| `ig_NG` | Igbo (Nigeria). |\n| `ii_CN` | Sichuan Yi (China). |\n| `ik_US` | Inupiaq (United States). |\n| `io_INT` | Ido (International). |\n| `is_IS` | Icelandic (Iceland). |\n| `it_IT` | Italian (Italy). |\n| `iu_CA` | Inuktitut (Canada). |\n| `iw_IL` | Hebrew (Israel). |\n| `ja_JP` | Japanese (Japan). |\n| `ji_IL` | Yiddish (Israel). |\n| `jv_ID` | Javanese (Indonesia). |\n| `ka_GE` | Georgian (Georgia). |\n| `kg_CD` | Kongo (Democratic Republic of the Congo). |\n| `ki_KE` | Kikuyu (Kenya). |\n| `kj_NA` | Kwanyama (Namibia). |\n| `kk_KZ` | Kazakh (Kazakhstan). |\n| `kl_GL` | Kalaallisut (Greenland). |\n| `km_KH` | Khmer (Cambodia). |\n| `kn_IN` | Kannada (India). |\n| `ko_KR` | Korean (South Korea). |\n| `kr_NG` | Kanuri (Nigeria). |\n| `ks_IN` | Kashmiri (India). |\n| `ku_TR` | Kurdish (Turkey). |\n| `kv_RU` | Komi (Russia). |\n| `kw_GB` | Cornish (United Kingdom). |\n| `ky_KG` | Kyrgyz (Kyrgyzstan). |\n| `la_VA` | Latin (Vatican City). |\n| `lb_LU` | Luxembourgish (Luxembourg). |\n| `lg_UG` | Ganda (Uganda). |\n| `li_NL` | Limburgish (Netherlands). |\n| `ln_CD` | Lingala (Democratic Republic of the Congo). |\n| `lo_LA` | Lao (Laos). |\n| `lt_LT` | Lithuanian (Lithuania). |\n| `lu_CD` | Luba-Katanga (Democratic Republic of the Congo). |\n| `lv_LV` | Latvian (Latvia). |\n| `mg_MG` | Malagasy (Madagascar). |\n| `mh_MH` | Marshallese (Marshall Islands). |\n| `mi_NZ` | Māori (New Zealand). |\n| `mk_MK` | Macedonian (North Macedonia). |\n| `ml_IN` | Malayalam (India). |\n| `mn_MN` | Mongolian (Mongolia). |\n| `mo_MD` | Moldavian (Moldova). |\n| `mr_IN` | Marathi (India). |\n| `ms_MY` | Malay (Malaysia). |\n| `mt_MT` | Maltese (Malta). |\n| `my_MM` | Burmese (Myanmar). |\n| `na_NR` | Nauru (Nauru). |\n| `nb_NO` | Norwegian Bokmål (Norway). |\n| `nd_ZW` | North Ndebele (Zimbabwe). |\n| `ne_NP` | Nepali (Nepal). |\n| `ng_NA` | Ndonga (Namibia). |\n| `nl_NL` | Dutch (Netherlands). |\n| `nn_NO` | Norwegian Nynorsk (Norway). |\n| `no_NO` | Norwegian (Norway). |\n| `nr_ZA` | South Ndebele (South Africa). |\n| `nv_US` | Navajo (United States). |\n| `ny_MW` | Chichewa (Malawi). |\n| `oc_FR` | Occitan (France). |\n| `oj_CA` | Ojibwa (Canada). |\n| `om_ET` | Oromo (Ethiopia). |\n| `or_IN` | Oriya (India). |\n| `os_RU` | Ossetian (Russia). |\n| `pa_IN` | Punjabi (India). |\n| `pi_IN` | Pali (India). |\n| `pl_PL` | Polish (Poland). |\n| `ps_AF` | Pashto (Afghanistan). |\n| `pt_PT` | Portuguese (Portugal). |\n| `qu_PE` | Quechua (Peru). |\n| `rm_CH` | Romansh (Switzerland). |\n| `rn_BI` | Kirundi (Burundi). |\n| `ro_RO` | Romanian (Romania). |\n| `ru_RU` | Russian (Russia). |\n| `rw_RW` | Kinyarwanda (Rwanda). |\n| `sa_IN` | Sanskrit (India). |\n| `sc_IT` | Sardinian (Italy). |\n| `sd_PK` | Sindhi (Pakistan). |\n| `se_NO` | Northern Sami (Norway). |\n| `sg_CF` | Sango (Central African Republic). |\n| `si_LK` | Sinhala (Sri Lanka). |\n| `sk_SK` | Slovak (Slovakia). |\n| `sl_SI` | Slovenian (Slovenia). |\n| `sm_WS` | Samoan (Samoa). |\n| `sn_ZW` | Shona (Zimbabwe). |\n| `so_SO` | Somali (Somalia). |\n| `sq_AL` | Albanian (Albania). |\n| `sr_RS` | Serbian (Serbia). |\n| `ss_SZ` | Swati (Eswatini). |\n| `st_LS` | Southern Sotho (Lesotho). |\n| `su_ID` | Sundanese (Indonesia). |\n| `sv_SE` | Swedish (Sweden). |\n| `sw_TZ` | Swahili (Tanzania). |\n| `ta_IN` | Tamil (India). |\n| `te_IN` | Telugu (India). |\n| `tg_TJ` | Tajik (Tajikistan). |\n| `th_TH` | Thai (Thailand). |\n| `ti_ET` | Tigrinya (Ethiopia). |\n| `tk_TM` | Turkmen (Turkmenistan). |\n| `tl_PH` | Tagalog (Philippines). |\n| `tn_BW` | Tswana (Botswana). |\n| `to_TO` | Tonga (Tonga). |\n| `tr_TR` | Turkish (Turkey). |\n| `ts_ZA` | Tsonga (South Africa). |\n| `tt_RU` | Tatar (Russia). |\n| `tw_GH` | Twi (Ghana). |\n| `ty_PF` | Tahitian (French Polynesia). |\n| `ug_CN` | Uyghur (China). |\n| `uk_UA` | Ukrainian (Ukraine). |\n| `ur_PK` | Urdu (Pakistan). |\n| `uz_UZ` | Uzbek (Uzbekistan). |\n| `ve_ZA` | Venda (South Africa). |\n| `vi_VN` | Vietnamese (Vietnam). |\n| `vo_INT` | Volapük (International). |\n| `wa_BE` | Walloon (Belgium). |\n| `wo_SN` | Wolof (Senegal). |\n| `xh_ZA` | Xhosa (South Africa). |\n| `yi_IL` | Yiddish (Israel). |\n| `yo_NG` | Yoruba (Nigeria). |\n| `za_CN` | Zhuang (China). |\n| `zh_CN` | Chinese (China). |\n| `zu_ZA` | Zulu (South Africa). |\n","enum":["aa_ET","ab_GE","ae_INT","af_ZA","ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","az_AZ","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bn_BD","bo_CN","br_FR","bs_BA","ca_ES","ce_RU","ch_GU","co_FR","cr_CA","cs_CZ","cu_INT","cv_RU","cy_GB","da_DK","de_DE","dv_MV","dz_BT","ee_GH","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","ff_SN","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","iw_IL","ja_JP","ji_IL","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mo_MD","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"],"type":"string"},"LearnMoreVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/VideoCallToActionPosition"},"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["position","url"],"type":"object"},"LinearTvDaypart":{"properties":{"daypartType":{"$ref":"#/components/schemas/LinearTvDaypartType"},"description":{"description":"Description of the daypart.","type":"string"},"linearTvDaypartId":{"description":"A unique identifier for a daypart.","type":"string"},"marketplaceDefinitions":{"description":"Definition of the daypart by marketplace.","items":{"$ref":"#/components/schemas/LinearTvDaypartMarketplaceDefinition"},"maxItems":30,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/LinearTvDaypartName"}},"required":["daypartType","linearTvDaypartId","marketplaceDefinitions","name"],"type":"object"},"LinearTvDaypartLinearTvDaypartNameFilter":{"properties":{"include":{"description":"**Name Enum:**\n| Name | Description |\n| --- | --- |\n| `EARLY_FRINGE` | The time period in the early evening, typically from 4:30 PM to 7:30 PM, leading into prime time. This daypart often features local news, syndicated programming, and game shows. |\n| `LATE_FRINGE` | The time period following late night, typically from 11:30 PM to 2:00 AM. This daypart often features late-night talk shows, reruns, and infomercials. |\n| `PRIME_TIME` | The peak television viewing period, typically from 8:00 PM to 11:00 PM (7:00 PM to 10:00 PM in Central/Mountain time zones). This daypart features networks\u0027 highest-budget programming and commands the highest advertising rates. |\n| `WEEKEND_DAYTIME` | The daytime hours on Saturday and Sunday, typically from 9:00 AM to 5:00 PM. This daypart often features sports programming, children\u0027s shows, and special interest content. |\n| `WEEKDAY_DAYTIME` | The daytime hours on Monday through Friday, typically from 9:00 AM to 4:30 PM. This daypart often features talk shows, soap operas, court shows, and news programming. |\n| `WEEKDAY_MORNING` | The early morning hours on Monday through Friday, typically from 5:00 AM to 9:00 AM. This daypart features morning news programs, breakfast shows, and programming aimed at viewers preparing for their day. |\n| `ALL_DAY` | A 24-hour daypart spanning the entire day, used for campaigns that run across all time periods without specific daypart targeting. |","items":{"$ref":"#/components/schemas/LinearTvDaypartName"},"maxItems":20,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"LinearTvDaypartMarketplaceDefinition":{"properties":{"endDayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"endHourOfDay":{"description":"Hour of the end time (local time zone) targeted by the daypart.","format":"int32","maximum":23,"minimum":0,"type":"integer"},"endMinuteOfDay":{"description":"Minute of the end time (local time zone) targeted by the daypart.","format":"int32","maximum":59,"minimum":0,"type":"integer"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"startDayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"startHourOfDay":{"description":"Hour of the start time (local time zone) targeted by the daypart.","format":"int32","maximum":23,"minimum":0,"type":"integer"},"startMinuteOfDay":{"description":"Minute of the start time (local time zone) targeted by the daypart.","format":"int32","maximum":59,"minimum":0,"type":"integer"}},"required":["endDayOfWeek","endHourOfDay","endMinuteOfDay","marketplace","startDayOfWeek","startHourOfDay","startMinuteOfDay"],"type":"object"},"LinearTvDaypartMarketplaceFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"LinearTvDaypartName":{"description":"**LinearTvDaypartName Enum:**\n| LinearTvDaypartName | Description |\n| --- | --- |\n| `EARLY_FRINGE` | The time period in the early evening, typically from 4:30 PM to 7:30 PM, leading into prime time. This daypart often features local news, syndicated programming, and game shows. |\n| `LATE_FRINGE` | The time period following late night, typically from 11:30 PM to 2:00 AM. This daypart often features late-night talk shows, reruns, and infomercials. |\n| `PRIME_TIME` | The peak television viewing period, typically from 8:00 PM to 11:00 PM (7:00 PM to 10:00 PM in Central/Mountain time zones). This daypart features networks\u0027 highest-budget programming and commands the highest advertising rates. |\n| `WEEKEND_DAYTIME` | The daytime hours on Saturday and Sunday, typically from 9:00 AM to 5:00 PM. This daypart often features sports programming, children\u0027s shows, and special interest content. |\n| `WEEKDAY_DAYTIME` | The daytime hours on Monday through Friday, typically from 9:00 AM to 4:30 PM. This daypart often features talk shows, soap operas, court shows, and news programming. |\n| `WEEKDAY_MORNING` | The early morning hours on Monday through Friday, typically from 5:00 AM to 9:00 AM. This daypart features morning news programs, breakfast shows, and programming aimed at viewers preparing for their day. |\n| `ALL_DAY` | A 24-hour daypart spanning the entire day, used for campaigns that run across all time periods without specific daypart targeting. |","enum":["ALL_DAY","EARLY_FRINGE","LATE_FRINGE","PRIME_TIME","WEEKDAY_DAYTIME","WEEKDAY_MORNING","WEEKEND_DAYTIME"],"type":"string"},"LinearTvDaypartSuccessResponse":{"properties":{"linearTvDayparts":{"items":{"$ref":"#/components/schemas/LinearTvDaypart"},"maxItems":20,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"LinearTvDaypartType":{"description":"**LinearTvDaypartType Enum:**\n| LinearTvDaypartType | Description |\n| --- | --- |\n| `STANDARD` | Industry-standard Linear TV daypart |","enum":["STANDARD"],"type":"string"},"LinearTvIncrementalReachForecast":{"properties":{"creationDateTime":{"description":"The date time that the reach forecast was created.","type":"string"},"deduplicatedReachPercent":{"description":"Total combined reach percentage across both channels.","format":"double","type":"number"},"endDate":{"description":"The end date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"linearTvIncrementalReachForecastId":{"description":"A unique identifier for a Linear TV Incremental Reach Forecast.","type":"string"},"linearTvInventoryAllocation":{"description":"Inventory allocation for the Linear TV Incremental Reach Forecast.","items":{"$ref":"#/components/schemas/LinearTvInventoryAllocation"},"maxItems":20,"minItems":0,"type":"array"},"linearTvOnlyReachPercent":{"description":"Linear TV Incremental (unique) reach percentage.","format":"double","type":"number"},"linearTvReachPercentOverride":{"description":"Override of TV reach percentage. If not provided, the service will calculate TV reach based on internal estimation.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overlapReachPercent":{"description":"Overlapped reach percentage between Streaming TV and Linear TV.","format":"double","type":"number"},"reachUnit":{"$ref":"#/components/schemas/ReachUnit"},"startDate":{"description":"The start date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"streamingTvBudgetAllocation":{"description":"Budget allocation for the list of Reach Forecast to be compared on top of Linear TV reach.","items":{"$ref":"#/components/schemas/ReachForecastBudgetAllocation"},"maxItems":100,"minItems":1,"type":"array"},"streamingTvExclusiveReachRate":{"description":"The percentage of streaming TV reach that wasn\u0027t exposed to a linear TV campaign. streamingTvOnlyReachPercent / linearTvReachPercent * 100%","format":"double","type":"number"},"streamingTvIncrementalReachRate":{"description":"The percentage of unique households/individuals that were reached on streaming TV inventory compared to linear TV. Households/individuals that are included in linear TV reach aren\u0027t counted in Streaming TV reach. streamingTvOnlyReachPercent / linearTvReach * 100%","format":"double","type":"number"},"streamingTvOnlyReachPercent":{"description":"Streaming TV Incremental (unique) reach percentage.","format":"double","type":"number"}},"required":["creationDateTime","deduplicatedReachPercent","endDate","linearTvIncrementalReachForecastId","linearTvOnlyReachPercent","marketplace","overlapReachPercent","reachUnit","startDate","streamingTvBudgetAllocation","streamingTvExclusiveReachRate","streamingTvIncrementalReachRate","streamingTvOnlyReachPercent"],"type":"object"},"LinearTvIncrementalReachForecastCreate":{"properties":{"endDate":{"description":"The end date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"linearTvInventoryAllocation":{"description":"Inventory allocation for the Linear TV Incremental Reach Forecast.","items":{"$ref":"#/components/schemas/CreateLinearTvInventoryAllocation"},"maxItems":20,"minItems":0,"type":"array"},"linearTvReachPercentOverride":{"description":"Override of TV reach percentage. If not provided, the service will calculate TV reach based on internal estimation.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"reachUnit":{"$ref":"#/components/schemas/ReachUnit"},"startDate":{"description":"The start date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"streamingTvBudgetAllocation":{"description":"Budget allocation for the list of Reach Forecast to be compared on top of Linear TV reach.","items":{"$ref":"#/components/schemas/CreateReachForecastBudgetAllocation"},"maxItems":100,"minItems":1,"type":"array"}},"required":["endDate","marketplace","reachUnit","startDate","streamingTvBudgetAllocation"],"type":"object"},"LinearTvIncrementalReachForecastMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecastMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"LinearTvIncrementalReachForecastMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"},"linearTvIncrementalReachForecast":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecast"}},"required":["index","linearTvIncrementalReachForecast"],"type":"object"},"LinearTvInventoryAllocation":{"description":"Linear TV Inventory Allocation","properties":{"grossRatingPoint":{"description":"Gross Rating Point (GRP) for the Linear TV inventory.","format":"double","type":"number"},"inventoryType":{"$ref":"#/components/schemas/LinearTvInventoryType"},"linearTvDaypartId":{"description":"A unique identifier of the daypart associated with the Linear TV inventory.","type":"string"}},"required":["grossRatingPoint","inventoryType","linearTvDaypartId"],"type":"object"},"LinearTvInventoryType":{"description":"**LinearTvInventoryType Enum:**\n\n| LinearTvInventoryType | Description |\n|------|------|\n| `BROADCAST` | Inventory on broadcast TV Network. |\n| `CABLE` | Inventory on cable TV Network. |\n| `SYNDICATION` | Inventory within syndicated television programs. |\n","enum":["BROADCAST","CABLE","SYNDICATION"],"type":"string"},"LinearTvReachForecast":{"properties":{"creationDateTime":{"description":"The date time that the reach forecast was created.","type":"string"},"endDate":{"description":"The end date of the Linear TV Reach Forecast.","format":"date","type":"string"},"linearTvInventoryAllocation":{"description":"Inventory allocation for the Linear TV Reach Forecast.","items":{"$ref":"#/components/schemas/LinearTvInventoryAllocation"},"maxItems":20,"minItems":1,"type":"array"},"linearTvReachForecastId":{"description":"A unique identifier for a Linear TV Reach Forecast.","type":"string"},"linearTvReachPercent":{"description":"The forecasted reach percent value.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"reachUnit":{"$ref":"#/components/schemas/ReachUnit"},"startDate":{"description":"The start date of the Linear TV Reach Forecast.","format":"date","type":"string"}},"required":["creationDateTime","endDate","linearTvInventoryAllocation","linearTvReachForecastId","linearTvReachPercent","marketplace","reachUnit","startDate"],"type":"object"},"LinearTvReachForecastCreate":{"properties":{"endDate":{"description":"The end date of the Linear TV Reach Forecast.","format":"date","type":"string"},"linearTvInventoryAllocation":{"description":"Inventory allocation for the Linear TV Reach Forecast.","items":{"$ref":"#/components/schemas/CreateLinearTvInventoryAllocation"},"maxItems":20,"minItems":1,"type":"array"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"reachUnit":{"$ref":"#/components/schemas/ReachUnit"},"startDate":{"description":"The start date of the Linear TV Reach Forecast.","format":"date","type":"string"}},"required":["endDate","linearTvInventoryAllocation","marketplace","reachUnit","startDate"],"type":"object"},"LinearTvReachForecastMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/LinearTvReachForecastMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"LinearTvReachForecastMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"},"linearTvReachForecast":{"$ref":"#/components/schemas/LinearTvReachForecast"}},"required":["index","linearTvReachForecast"],"type":"object"},"LocationIndex":{"properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"creationDateTime":{"description":"The date time the location index was created.","format":"date-time","type":"string"},"indexData":{"$ref":"#/components/schemas/IndexValues"},"indexId":{"description":"The identifier of the location index.","type":"string"},"indexName":{"description":"The name of the location index.","type":"string"},"lastUpdatedDateTime":{"description":"The date time the location index was last updated successfully.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/IndexStatus"}},"required":["creationDateTime","indexData","indexId","indexName","lastUpdatedDateTime","status"],"type":"object"},"LocationIndexCreate":{"properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"indexData":{"$ref":"#/components/schemas/CreateIndexValues"},"indexName":{"description":"The name of the location index.","type":"string"}},"required":["indexData","indexName"],"type":"object"},"LocationIndexMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/LocationIndexMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"LocationIndexMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"},"locationIndex":{"$ref":"#/components/schemas/LocationIndex"}},"required":["index","locationIndex"],"type":"object"},"LocationIndexSuccessResponse":{"properties":{"locationIndexes":{"items":{"$ref":"#/components/schemas/LocationIndex"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"LocationIndexUpdate":{"properties":{"indexData":{"$ref":"#/components/schemas/UpdateIndexValues"},"indexId":{"description":"The identifier of the location index.","type":"string"}},"required":["indexId"],"type":"object"},"LocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"},"locationIdResolved":{"description":"A human-readable location text. It\u0027s a read-only field.","type":"string"}},"required":["locationId"],"type":"object"},"LocationTargetingEntry":{"description":"A location targeting entry. Currently only country-level targeting is supported. All entries must share the same negative value.","properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"}},"required":["countryCode","groupId"],"type":"object"},"Lookback":{"description":"**Lookback Enum:**\n\n| Lookback | Description |\n|------|------|\n| `DAYS_14` | Two week lookback period. |\n| `DAYS_180` | Six month lookback period. |\n| `DAYS_30` | One month lookback period. |\n| `DAYS_365` | One year lookback period. |\n| `DAYS_60` | Two month lookback period. |\n| `DAYS_7` | One week lookback period. |\n| `DAYS_90` | Three month lookback period. |\n","enum":["DAYS_14","DAYS_180","DAYS_30","DAYS_365","DAYS_60","DAYS_7","DAYS_90"],"type":"string"},"ManagerAccount":{"properties":{"accountUsageType":{"$ref":"#/components/schemas/AccountUsageType"},"businessDetails":{"$ref":"#/components/schemas/BusinessDetail"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"industryVertical":{"$ref":"#/components/schemas/IndustryVertical"},"timeZoneIana":{"$ref":"#/components/schemas/TimeZoneIana"}},"type":"object"},"ManagerAccountCreate":{"properties":{"accountUsageType":{"$ref":"#/components/schemas/AccountUsageType"},"businessDetails":{"$ref":"#/components/schemas/CreateBusinessDetail"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"industryVertical":{"$ref":"#/components/schemas/IndustryVertical"},"timeZoneIana":{"$ref":"#/components/schemas/TimeZoneIana"}},"type":"object"},"ManagerAccountManagerAccountIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"ManagerAccountMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/ManagerAccountMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"ManagerAccountMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"},"managerAccount":{"$ref":"#/components/schemas/ManagerAccount"}},"required":["index","managerAccount"],"type":"object"},"ManagerAccountSuccessResponse":{"properties":{"managerAccounts":{"items":{"$ref":"#/components/schemas/ManagerAccount"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"ManagerAccountUpdate":{"properties":{"businessDetails":{"$ref":"#/components/schemas/UpdateBusinessDetail"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"industryVertical":{"$ref":"#/components/schemas/IndustryVertical"},"managerAccountId":{"description":"The identifier of the manager account.","type":"string"},"timeZoneIana":{"$ref":"#/components/schemas/TimeZoneIana"}},"type":"object"},"ManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/CollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SharedCollectionSettings"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","type":"string"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"Marketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"MarketplaceAdConfigurations":{"properties":{"adId":{"description":"Represents marketplace ad id (Ex: adId-US) associated to global ad (Ex: adId-Global)","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceAdFieldOverrides"}},"required":["adId","marketplace","overrides"],"type":"object"},"MarketplaceAdFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"MarketplaceAdGroupConfigurations":{"properties":{"adGroupId":{"description":"Represents marketplace adGroup id (Ex: adGroupId-US) associated to global adGroup (Ex: adGroupId-Global)","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceAdGroupFieldOverrides"}},"required":["adGroupId","marketplace","overrides"],"type":"object"},"MarketplaceAdGroupFieldOverrides":{"properties":{"name":{"description":"The name of the ad group for this marketplace","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Marketplace specific tags for the ad group","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"MarketplaceBudgetAllocation":{"description":"**MarketplaceBudgetAllocation Enum:**\n\n| MarketplaceBudgetAllocation | Description |\n|------|------|\n| `AUTO` | Auto distribute global budget to marketplaces in global campaign |\n| `MANUAL` | Manually distribute global budget to marketplaces in global campaign |\n","enum":["AUTO","MANUAL"],"type":"string"},"MarketplaceCampaignConfigurations":{"properties":{"campaignId":{"description":"Represents marketplace campaign id (Ex: campaignId-US) associated to global campaign (Ex: campaignId-Global)","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceCampaignFieldOverrides"}},"required":["campaignId","marketplace","overrides"],"type":"object"},"MarketplaceCampaignFieldOverrides":{"properties":{"endDateTime":{"description":"The end date time for the campaign","format":"date-time","type":"string"},"name":{"description":"The name of the campaign","type":"string"},"optimizations":{"$ref":"#/components/schemas/CampaignOptimizations"},"startDateTime":{"description":"The start date time for the campaign","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"MarketplaceScope":{"enum":["GLOBAL","SINGLE_MARKETPLACE"],"type":"string"},"MarketplaceStringValue":{"properties":{"defaultValue":{"description":"The default value. Either the default value or the marketplace settings should always be specified","type":"string"}},"type":"object"},"MarketplaceTargetConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceTargetFieldOverrides"},"targetId":{"description":"Represents marketplace target id (Ex: targetId-US) associated to global target (Ex: targetId-Global)","type":"string"}},"required":["marketplace","overrides","targetId"],"type":"object"},"MarketplaceTargetFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/OverridableTargets"}},"type":"object"},"MatchKey":{"description":"The identifier used to match people for attribution. PII-based match key data needs to be normalized and hashed (SHA-256). REAL_ID, MERKLE_ID, KANTAR_ID, and FIP accept raw identifier values. Email addresses provided must follow the formatting guidelines: Lowercase, remove all non-alphanumeric characters [a-zA-Z0-9] and [.@-], and remove any leading or trailing whitespace.","properties":{"type":{"$ref":"#/components/schemas/MatchKeyType"},"values":{"description":"Identifier value of the customer who performed the event. SHA-256 hashed for PII-based keys; raw value for REAL_ID, MERKLE_ID, KANTAR_ID, and FIP.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["type","values"],"type":"object"},"MatchKeyType":{"description":"**MatchKeyType Enum:**\n| MatchKeyType | Description |\n| --- | --- |\n| `EMAIL` | Email address match key type. |\n| `PHONE` | Phone number match key type. |\n| `FIRST_NAME` | First name match key type. |\n| `LAST_NAME` | Last name match key type. |\n| `ADDRESS` | Address match key type. |\n| `CITY` | City match key type. |\n| `STATE` | State match key type. |\n| `POSTAL` | Postal code match key type. |\n| `MAID` | Mobile advertising ID match key type. |\n| `RAMP_ID` | RAMP ID match key type. |\n| `MATCH_ID` | Match ID key type. |\n| `REAL_ID` | RealId (AXM) identifier resolved via AIP Tumble ResolveExternalId API. |\n| `MERKLE_ID` | Merkle (MKL) identifier resolved via AIP Tumble ResolveExternalId API. |\n| `KANTAR_ID` | Kantar (KAN) identifier resolved via AIP Tumble ResolveExternalId API. |\n| `FIP` | Full IP address match key type. Supports IPv4 and IPv6. Used for identity resolution. |","enum":["ADDRESS","CITY","EMAIL","FIP","FIRST_NAME","KANTAR_ID","LAST_NAME","MAID","MATCH_ID","MERKLE_ID","PHONE","POSTAL","RAMP_ID","REAL_ID","STATE"],"type":"string"},"MatchType":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_REMARKETING` | Products to target users who have previously interacted with the specified product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `PRODUCT_COMPLEMENTS` |  |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","enum":["BROAD","EXACT","INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PHRASE","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_EXACT","PRODUCT_REMARKETING","PRODUCT_SIMILAR","PRODUCT_SUBSTITUTES"],"type":"string"},"MobileDevice":{"description":"**MobileDevice Enum:**\n\n| MobileDevice | Description |\n|------|------|\n| `ANDROID` | Android device. |\n| `IPAD` | Apple iPad. |\n| `IPHONE` | Apple iPhone. |\n| `KINDLE_FIRE_HD` | Amazon Kindle Fire HD. |\n| `KINDLE_FIRE` | Amazon Kindle Fire. |\n","enum":["ANDROID","IPAD","IPHONE","KINDLE_FIRE","KINDLE_FIRE_HD"],"type":"string"},"MobileEnvironment":{"description":"**MobileEnvironment Enum:**\n\n| MobileEnvironment | Description |\n|------|------|\n| `APP` | Mobile application. |\n| `WEB` | Mobile web browser. |\n","enum":["APP","WEB"],"type":"string"},"MobileOs":{"description":"**MobileOs Enum:**\n\n| MobileOs | Description |\n|------|------|\n| `ANDROID` | Google Android operating system. |\n| `IOS` | Apple iOS operating system. |\n","enum":["ANDROID","IOS"],"type":"string"},"ModerationStatus":{"description":"**ModerationStatus Enum:**\n\n| ModerationStatus | Description |\n|------|------|\n| `APPROVED_WITH_EXCEPTIONS` | The creative passed basic moderation but was found to be invalid for some supplies. The creative is serving on approved supplies. |\n| `PENDING_TRANSLATION` | The creative is pending creative Translations. |\n| `PUBLISHED` | The creative passed moderation and is serving. |\n| `REJECTED_BY_MODERATION` | The creative was rejected during the moderation process. |\n| `SUBMITTED_FOR_MODERATION` | The creative has been submitted, but has not yet been reviewed. |\n","enum":["APPROVED_WITH_EXCEPTIONS","PENDING_TRANSLATION","PUBLISHED","REJECTED_BY_MODERATION","SUBMITTED_FOR_MODERATION"],"type":"string"},"MonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"ruleValue":{"description":"The monetary amount of the budget when a budget rule is applied.","format":"double","type":"number"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"MonetaryBudgetMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"monetaryBudget":{"$ref":"#/components/schemas/MonetaryBudget"}},"required":["marketplace","monetaryBudget"],"type":"object"},"MonetaryBudgetValue":{"properties":{"marketplaceSettings":{"description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/MonetaryBudgetMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"monetaryBudget":{"$ref":"#/components/schemas/MonetaryBudget"}},"type":"object"},"MonetaryRange":{"description":"A monetary range with optional inclusive min and max bounds and a required currency code.","properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"max":{"description":"The maximum (inclusive) monetary value of the range.","format":"double","type":"number"},"min":{"description":"The minimum (inclusive) monetary value of the range.","format":"double","type":"number"}},"required":["currencyCode"],"type":"object"},"MrcViewabilityTargetingType":{"description":"The type of MRC viewability targeting.\n\n\n\n\n\n","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_30","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_80"],"type":"string"},"NativeContentPosition":{"description":"**NativeContentPosition Enum:**\n\n| NativeContentPosition | Description |\n|------|------|\n| `IN_ARTICLE` | Positioned in the atomic unit of the content (e.g., in the article page or single image page). |\n| `IN_FEED` | Positioned in the feed of content (e.g., as an item inside the organic feed, grid, listing, carousel, etc.). |\n| `PERIPHERAL` | Positioned utside the core content (e.g., in the ads section on the right rail, as a banner-style placement near the content, etc.). |\n| `RECOMMENDATION` | Positioned in recommendation widget; most commonly presented below article content. |\n| `UNKNOWN` | Unknown position. |\n","enum":["IN_ARTICLE","IN_FEED","PERIPHERAL","RECOMMENDATION","UNKNOWN"],"type":"string"},"NativeContentPositionTarget":{"description":"Targets ads to a specific native content position","properties":{"nativePosition":{"$ref":"#/components/schemas/NativeContentPosition"}},"required":["nativePosition"],"type":"object"},"NewsGuardBrandGuardMisinformationSafety":{"properties":{"avoidanceList":{"description":"The unique identifiers of misinformation targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardMisinformationSafetyType"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"NewsGuardBrandGuardMisinformationSafetyType":{"enum":["AI_GENERATED_MFA","BASIC_EXCLUDE","CLIMATE_MISINFORMATION","COVID_MISINFORMATION","ELECTION_MISINFORMATION","HEALTH_MISINFORMATION","HIGH_EXCLUDE","ISRAEL_HAMAS_MISINFORMATION","MAX_EXCLUDE","MISINFORMATION_SITES","OPINIONATED_NEWS","QANON_MISINFORMATION","UKRAINE_MISINFORMATION","VACCINE_MISINFORMATION"],"type":"string"},"NewsGuardBrandGuardTrustedNewsTargeting":{"description":"Only applicable for Web supply.","properties":{"targetingList":{"description":"The unique identifiers of trusted news targets","items":{"$ref":"#/components/schemas/NewsGuardBrandGuardTrustedNewsTargetingType"},"maxItems":15,"minItems":0,"type":"array"}},"type":"object"},"NewsGuardBrandGuardTrustedNewsTargetingType":{"enum":["BASIC_INCLUDE","BUSINESS_INCLUDE","COMMUNITY_INCLUDE","HEALTH_INCLUDE","HIGH_INCLUDE","LIFESTYLE_INCLUDE","LOCAL_INCLUDE","MAX_INCLUDE","POLITICS_INCLUDE","TECH_INCLUDE"],"type":"string"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"OffAmazonBudgetControlStrategy":{"description":"**OffAmazonBudgetControlStrategy Enum:**\n\n| OffAmazonBudgetControlStrategy | Description |\n|------|------|\n| `MAXIMIZE_REACH` | Maximize the reach of off-Amazon inventory within the budget. |\n| `MINIMIZE_SPEND` | Minimize spend on off-Amazon inventory while maintaining delivery. |\n","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"],"type":"string"},"OnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/VideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/AdvertisedProducts"},"videos":{"$ref":"#/components/schemas/Video"}},"required":["language","videos"],"type":"object"},"Optimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/AdGroupBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/AdGroupGoalSettings"}},"type":"object"},"OverridableTargets":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/KeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/ThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"Pacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DeliveryProfile"}},"required":["deliveryProfile"],"type":"object"},"PixalateFraudInvalidTraffic":{"properties":{"excludeAppsAndDomains":{"description":"Set to true to exclude traffic from Apps and Domains identified to be fraudulent or invalid.","type":"boolean"},"excludeIpAddressAndUserAgents":{"description":"Set to true to exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid.","type":"boolean"},"excludeOttAndMobileDevices":{"description":"Set to true to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid.","type":"boolean"},"excludeRemovedAppsFromAppStores":{"description":"Set to true to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months.","type":"boolean"}},"type":"object"},"Placement":{"description":"**Placement Enum:**\n\n| Placement | Description |\n|------|------|\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n","enum":["HOME_PAGE","PRODUCT_PAGE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","TOP_OF_SEARCH"],"type":"string"},"PlacementBidAdjustment":{"properties":{"percentage":{"description":"The selection of the percentage change associated with a given placement and bid adjustment settings.","format":"int32","type":"integer"},"placement":{"$ref":"#/components/schemas/Placement"}},"required":["percentage","placement"],"type":"object"},"PlacementType":{"description":"**PlacementType Enum:**\n\n| PlacementType | Description |\n|------|------|\n| `REWARDED` | Rewarded video type where users receive rewards from the publisher for watching ads. |\n","enum":["REWARDED"],"type":"string"},"PlacementTypeTarget":{"description":"Target based on the placement type.","properties":{"placementType":{"$ref":"#/components/schemas/PlacementType"}},"required":["placementType"],"type":"object"},"Portal":{"enum":["AUTHOR_CENTRAL","GROCERY_CENTRAL","KDP_CENTRAL","MERCH","SELLER_CENTRAL","VENDOR_CENTRAL"],"type":"string"},"PrimaryInventoryType":{"description":"**PrimaryInventoryType Enum:**\n\n| PrimaryInventoryType | Description |\n|------|------|\n| `AUDIO` | Audio ads that serve on streaming audio and podcast inventory. |\n| `DISPLAY` | Image ads that serve across Amazon and third-party inventory. |\n| `VIDEO_OLV` | Video ads that serve on online video inventory. |\n| `VIDEO_STV` | Video ads that serve on streaming TV inventory. |\n","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"],"type":"string"},"PriorityAsin":{"description":"Product information for a priority ASIN","properties":{"addToCartActionParams":{"description":"Parameters for add to cart action","type":"string"},"bottleDepositFee":{"description":"Bottle deposit fee amount","type":"string"},"bottleDepositFeeString":{"description":"Bottle deposit fee as string","type":"string"},"cartQuantity":{"description":"Quantity of this item in the cart","format":"double","type":"number"},"catalogDisplayPricePerUnitOfMeasure":{"description":"Price per unit of measure for display","type":"string"},"freshButton":{"description":"Fresh button information","type":"string"},"isAlternateSearchResult":{"description":"Flag indicating if this is an alternate search result","type":"boolean"},"isRequiredQuantityInCart":{"description":"Flag indicating if a quantity is required in cart","type":"boolean"},"isSoldByCount":{"description":"Flag indicating if the product is sold by count","type":"boolean"},"itemAvailability":{"description":"Status of item availability","type":"string"},"offerId":{"description":"Unique identifier for the offer","type":"string"},"offerName":{"description":"Display name of the product offer","type":"string"},"offerUnit":{"description":"Unit of the offer (e.g., Fl Oz, lb)","type":"string"},"productAsin":{"description":"ASIN associated with this product","type":"string"},"productDetailsUrl":{"description":"URL to the product details page","type":"string"},"productImageUrl":{"description":"URL of the product image","type":"string"},"promotionDisplay":{"description":"Display text for active promotion","type":"string"},"promotionId":{"description":"Identifier for active promotion","type":"string"},"quantityInStock":{"description":"Available quantity in stock","format":"double","type":"number"},"requiredQuantity":{"description":"Required quantity for purchase","format":"double","type":"number"},"retailATCButton":{"description":"Retail add-to-cart button information","type":"string"},"reviewStars":{"$ref":"#/components/schemas/ReviewStars"},"searchTerm":{"description":"Search term associated with this product","type":"string"},"subtotalParams":{"description":"Subtotal parameters for pricing calculations","type":"string"},"vuomDisplayPrice":{"description":"Display price for virtual unit of measure","type":"string"}},"required":["addToCartActionParams","cartQuantity","isAlternateSearchResult","isRequiredQuantityInCart","isSoldByCount","itemAvailability","offerId","offerName","offerUnit","productAsin","productDetailsUrl","productImageUrl","requiredQuantity","subtotalParams","vuomDisplayPrice"],"type":"object"},"ProductAudienceMatchType":{"description":"**ProductAudienceMatchType Enum:**\n\n| ProductAudienceMatchType | Description |\n|------|------|\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"],"type":"string"},"ProductAudienceTarget":{"description":"Target customers who have viewed or purchased a certain product within a specified lookback window.","properties":{"asin":{"$ref":"#/components/schemas/MarketplaceStringValue"},"event":{"$ref":"#/components/schemas/TargetEvent"},"lookback":{"$ref":"#/components/schemas/Lookback"},"matchType":{"$ref":"#/components/schemas/ProductAudienceMatchType"}},"required":["asin","event","lookback","matchType"],"type":"object"},"ProductCategoryMatchType":{"description":"**ProductCategoryMatchType Enum:**\n\n| ProductCategoryMatchType | Description |\n|------|------|\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |\n","enum":["MULTISIGNAL_BROAD"],"type":"string"},"ProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productAgeRangeIdResolved":{"description":"The resolved age range to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productBrandIdResolved":{"description":"The resolved name of the brand.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productCategoryIdResolved":{"description":"The resolved product category.","type":"string"},"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productGenreIdResolved":{"description":"The resolved product genre to target.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"ProductCategoryRefinementMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productCategoryRefinement":{"$ref":"#/components/schemas/ProductCategoryRefinement"}},"required":["marketplace","productCategoryRefinement"],"type":"object"},"ProductCategoryRefinementValue":{"properties":{"marketplaceSettings":{"description":"Marketplace specific product category refinements. Either the value or the marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/ProductCategoryRefinementMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productCategoryRefinement":{"$ref":"#/components/schemas/ProductCategoryRefinement"}},"type":"object"},"ProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"matchType":{"$ref":"#/components/schemas/ProductCategoryMatchType"},"productCategoryRefinement":{"$ref":"#/components/schemas/ProductCategoryRefinementValue"},"productGenreRefinement":{"$ref":"#/components/schemas/ProductGenreRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"ProductCollectionCreativePropertiesToOptimize":{"description":"**ProductCollectionCreativePropertiesToOptimize Enum:**\n\n| ProductCollectionCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"ProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/LandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"ProductCollectionLandingPageType":{"description":"**ProductCollectionLandingPageType Enum:**\n\n| ProductCollectionLandingPageType | Description |\n|------|------|\n| `ASIN_LIST` | A list of products based on the products promoted in the ad creative. |\n| `CUSTOM_URL` | A custom landing page. Available for vendors only. |\n| `STORE` | A brand Store landing page. |\n","enum":["ASIN_LIST","CUSTOM_URL","STORE"],"type":"string"},"ProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ProductCollectionLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headlines entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","customImages","headlines","landingPage"],"type":"object"},"ProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/ProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"ProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/AdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/SpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"ProductGenreRefinement":{"properties":{"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productGenreIdResolved":{"description":"The resolved product genre to target.","type":"string"}},"required":["productGenreId"],"type":"object"},"ProductIdType":{"description":"**ProductIdType Enum:**\n\n| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n| `SKU` | SKU identifier type. |\n","enum":["ASIN","SKU"],"type":"string"},"ProductMarketplaceSetting":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The product id applicable at the specified marketplace.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"ProductMatchType":{"description":"**ProductMatchType Enum:**\n\n| ProductMatchType | Description |\n|------|------|\n| `PRODUCT_COMPLEMENTS` | Products that are frequently purchased together with the specified product. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_REMARKETING` | Products to target users who have previously interacted with the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n","enum":["PRODUCT_COMPLEMENTS","PRODUCT_EXACT","PRODUCT_REMARKETING","PRODUCT_SIMILAR"],"type":"string"},"ProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/ProductMatchType"},"product":{"$ref":"#/components/schemas/ProductValue"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"ProductValue":{"properties":{"marketplaceSettings":{"description":"The product ids at specific marketplace level. Either the product id or the marketplace settings should always be specified","items":{"$ref":"#/components/schemas/ProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"ProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/VideoLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"untranslatedVideos":{"description":"The original video assets submitted as part of the creative.","items":{"$ref":"#/components/schemas/Video"},"maxItems":2,"minItems":1,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/Video"},"maxItems":2,"minItems":1,"type":"array"}},"required":["untranslatedVideos","videos"],"type":"object"},"PromotionCampaign":{"description":"Represents a promotional campaign that offers click credits to advertisers based on meeting specific spending thresholds within a defined timeframe. Supports both single-tier and multi-tier reward structures for different ad products and marketplaces.","properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"title":{"description":"Title of the promotion campaign.","type":"string"},"tncUrl":{"description":"The Url of the Terms and condition page for the promotion campaign.","type":"string"}},"required":["adProduct","title","tncUrl"],"type":"object"},"PromotionCodeRedemption":{"properties":{"accountId":{"description":"The account id for which promotion code redemption is created. Only supports global advertiser account id.","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"promotionCodeId":{"description":"The promotion code ID associated with the promotion code redemption.","type":"string"},"promotionCodeRedemptionId":{"description":"The unique identifier of the promotion code redemption.","type":"string"},"redemptionResult":{"$ref":"#/components/schemas/RedemptionResult"}},"required":["accountId","marketplace","promotionCodeId","promotionCodeRedemptionId","redemptionResult"],"type":"object"},"PromotionCodeRedemptionCreate":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"promotionCodeId":{"description":"The promotion code ID associated with the promotion code redemption.","type":"string"}},"required":["marketplace","promotionCodeId"],"type":"object"},"PromotionCodeRedemptionMultiStatusResponse":{"properties":{"contentLanguage":{"type":"string"},"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":5,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/PromotionCodeRedemptionMultiStatusSuccess"},"maxItems":5,"minItems":0,"type":"array"}},"required":["contentLanguage"],"type":"object"},"PromotionCodeRedemptionMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":4,"minimum":0,"type":"integer"},"promotionCodeRedemption":{"$ref":"#/components/schemas/PromotionCodeRedemption"}},"required":["index","promotionCodeRedemption"],"type":"object"},"PromotionOffer":{"properties":{"accountId":{"description":"The account id for which the promotion offer is created. Only supports global advertiser account id.","type":"string"},"description":{"description":"Description of the promotion offer.","type":"string"},"fulfilmentCriteria":{"description":"The fulfilment criteria of the promotion offer. Can include up to two criteria: a CampaignLaunchFulfilmentCriterion and a SpendsFulfilmentCriterion. For example, a promotion offer might require launching a Sponsored Products campaign first, and then spending $500 within 30 days to receive a $300 reward, or could just require launching a Sponsored Products campaign only.","items":{"$ref":"#/components/schemas/FulfilmentCriterion"},"maxItems":2,"minItems":1,"type":"array"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"promotionCampaign":{"$ref":"#/components/schemas/PromotionCampaign"},"promotionOfferId":{"description":"The unique identifier of the promotion offer.","type":"string"},"promotionRewardId":{"description":"The promotion reward Id associated to the promotion offer.","type":"string"},"status":{"$ref":"#/components/schemas/PromotionOfferStatus"}},"required":["accountId","description","fulfilmentCriteria","marketplace","promotionCampaign","promotionOfferId","status"],"type":"object"},"PromotionOfferMarketplaceFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionOfferPromotionOfferStatusFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/PromotionOfferStatus"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionOfferStatus":{"enum":["AVAILABLE","IN_PROGRESS","MISSED","REWARDED"],"type":"string"},"PromotionOfferSuccessResponse":{"properties":{"contentLanguage":{"type":"string"},"nextToken":{"type":"string"},"promotionOffers":{"items":{"$ref":"#/components/schemas/PromotionOffer"},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"required":["contentLanguage"],"type":"object"},"PromotionReward":{"properties":{"advertiserAccountId":{"description":"The advertiser account associated with the promotion reward.","type":"string"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"endDateTime":{"description":"The date and time by which the promotion reward expires.","format":"date-time","type":"string"},"includePromotionRewardConsumption":{"description":"Whether per-invoice consumption details are included in the response.","type":"boolean"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"name":{"description":"The display name of the promotion reward.","type":"string"},"promotionRewardConsumptions":{"description":"The per-invoice consumption details of the promotion reward.","items":{"$ref":"#/components/schemas/PromotionRewardConsumption"},"maxItems":50,"minItems":0,"type":"array"},"promotionRewardId":{"description":"A unique identifier for the promotion reward.","type":"string"},"promotionRewardType":{"$ref":"#/components/schemas/PromotionRewardType"},"remainingReward":{"description":"The click credits amount of the promotion reward not yet consumed.","format":"double","type":"number"},"reward":{"description":"The total click credits amount of the promotion reward.","format":"double","type":"number"},"startDateTime":{"description":"The date and time from which the promotion reward is active and eligible for consumption.","format":"date-time","type":"string"}},"required":["advertiserAccountId","currencyCode","endDateTime","marketplace","name","promotionRewardId","promotionRewardType","remainingReward","reward","startDateTime"],"type":"object"},"PromotionRewardConsumption":{"description":"The consumption of a promotion reward against a specific invoice.","properties":{"consumedReward":{"description":"The click credits amount of the promotion reward applied to this invoice.","format":"double","type":"number"},"invoiceId":{"description":"The invoice against which the promotion reward was applied. Null only for in-progress consumption that has not yet been settled to an invoice; once an invoice is issued, this is always populated. Consumers should treat null as a \u0027pending invoice\u0027 state.","type":"string"}},"required":["consumedReward"],"type":"object"},"PromotionRewardEndDateTimeFilter":{"properties":{"include":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardIncludePromotionRewardConsumptionFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardMarketplaceFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":28,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardPromotionRewardIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardPromotionRewardTypeFilter":{"properties":{"include":{"description":"**PromotionRewardType Enum:**\n| PromotionRewardType | Description |\n| --- | --- |\n| `ADHOC` | A direct promotion reward applied to an advertiser account. |\n| `SIGNUP` | A promotion reward awarded upon advertiser signup. |\n| `PROMO_CODE` | A promotion reward redeemed via a promotion code. |","items":{"$ref":"#/components/schemas/PromotionRewardType"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardStartDateTimeFilter":{"properties":{"include":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardSuccessResponse":{"properties":{"nextToken":{"type":"string"},"promotionRewards":{"items":{"$ref":"#/components/schemas/PromotionReward"},"maxItems":25,"minItems":0,"type":"array"}},"type":"object"},"PromotionRewardType":{"description":"The type of a promotion reward.\n**PromotionRewardType Enum:**\n| PromotionRewardType | Description |\n| --- | --- |\n| `ADHOC` | A direct promotion reward applied to an advertiser account. |\n| `SIGNUP` | A promotion reward awarded upon advertiser signup. |\n| `PROMO_CODE` | A promotion reward redeemed via a promotion code. |","enum":["ADHOC","PROMO_CODE","SIGNUP"],"type":"string"},"PromptExtension":{"description":"Prompts Ad Extension","properties":{"promptText":{"description":"The prompt text rendered in the ads","type":"string"}},"required":["promptText"],"type":"object"},"Publisher":{"properties":{"name":{"description":"Normalized publisher name. NULL when isConfidential is true.","type":"string"},"rootDomain":{"description":"Root domain from ads.txt. PSL+1 root. NULL for app-only publishers.","type":"string"}},"type":"object"},"PublisherHostedCreativeSource":{"description":"The publisher ad server source for publisher hosted creative placeholder creatives.\n**PublisherHostedCreativeSource Enum:**\n\n| PublisherHostedCreativeSource | Description |\n|------|------|\n| `GOOGLE_AD_MANAGER` | Google Ad Manager publisher ad server. |\n","enum":["GOOGLE_AD_MANAGER"],"type":"string"},"PublisherSuccessResponse":{"properties":{"nextToken":{"type":"string"},"publishers":{"items":{"$ref":"#/components/schemas/Publisher"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"QueryAccountCombinationInvitationRequest":{"properties":{"maxResults":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"QueryAdAssociationRequest":{"properties":{"adAssociationIdFilter":{"$ref":"#/components/schemas/AdAssociationAdAssociationIdFilter"},"adGroupIdFilter":{"$ref":"#/components/schemas/AdAssociationAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/AdAssociationAdIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"QueryAdExtensionRequest":{"properties":{"adExtensionIdFilter":{"$ref":"#/components/schemas/AdExtensionAdExtensionIdFilter"},"adExtensionStatusFilter":{"$ref":"#/components/schemas/AdExtensionAdExtensionStatusFilter"},"adExtensionTypeFilter":{"$ref":"#/components/schemas/AdExtensionAdExtensionTypeFilter"},"adGroupIdFilter":{"$ref":"#/components/schemas/AdExtensionAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/AdExtensionAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/AdExtensionAdProductFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/AdExtensionStateFilter"}},"type":"object"},"QueryAdGroupRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/AdGroupAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/AdGroupAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/AdGroupCampaignIdFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/AdGroupMarketplaceScopeFilter"},"maxResults":{"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/AdGroupNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/AdGroupStateFilter"}},"required":["adProductFilter"],"type":"object"},"QueryAdRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/AdAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/AdAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/AdAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/AdCampaignIdFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/AdMarketplaceScopeFilter"},"maxResults":{"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/AdNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/AdStateFilter"}},"required":["adProductFilter"],"type":"object"},"QueryAdvertiserAccountRequest":{"properties":{"advertiserAccountIdFilter":{"$ref":"#/components/schemas/AdvertiserAccountAdvertiserAccountIdFilter"},"isGlobalAccountFilter":{"$ref":"#/components/schemas/AdvertiserAccountIsGlobalAccountFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":10,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"QueryAdvertiserProductGroupEligibilityRequest":{"properties":{"maxResults":{"default":10,"format":"int32","maximum":10,"minimum":0,"type":"integer"},"nextToken":{"type":"string"},"statusFilter":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibilityAdvertiserProductGroupEligibilityStatusFilter"}},"type":"object"},"QueryAdvertisingDealRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/AdvertisingDealAdProductFilter"},"advertisingDealIdFilter":{"$ref":"#/components/schemas/AdvertisingDealAdvertisingDealIdFilter"},"countryCodeFilter":{"$ref":"#/components/schemas/AdvertisingDealCountryCodeFilter"},"creationDateTimeRangeFilter":{"$ref":"#/components/schemas/AdvertisingDealCreationDateTimeRangeFilter"},"dealTypeFilter":{"$ref":"#/components/schemas/AdvertisingDealAdvertisingDealTypeFilter"},"endDateTimeRangeFilter":{"$ref":"#/components/schemas/AdvertisingDealEndDateTimeRangeFilter"},"exchangeDealIdFilter":{"$ref":"#/components/schemas/AdvertisingDealExchangeDealIdFilter"},"exchangeIdFilter":{"$ref":"#/components/schemas/AdvertisingDealExchangeIdFilter"},"marketplaceDealFilter":{"$ref":"#/components/schemas/AdvertisingDealMarketplaceDealFilter"},"maxResults":{"default":1000,"format":"int32","maximum":10000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/AdvertisingDealNameFilter"},"nextToken":{"type":"string"},"priceRangeFilter":{"$ref":"#/components/schemas/AdvertisingDealPriceRangeFilter"},"priceTypeFilter":{"$ref":"#/components/schemas/AdvertisingDealAdvertisingDealPriceTypeFilter"},"sort":{"items":{"$ref":"#/components/schemas/AdvertisingDealSortOption"},"maxItems":8,"minItems":0,"type":"array"},"startDateTimeRangeFilter":{"$ref":"#/components/schemas/AdvertisingDealStartDateTimeRangeFilter"},"statusFilter":{"$ref":"#/components/schemas/AdvertisingDealStatusFilter"}},"required":["adProductFilter"],"type":"object"},"QueryBrandStoreEditionPublishVersionRequest":{"properties":{"editionIdFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionBrandStoreEditionIdFilter"},"maxResults":{"default":50,"format":"int32","maximum":50,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"publishStatusFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionStorePublishStatusFilter"},"storeIdFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionBrandStoreIdFilter"}},"required":["editionIdFilter","publishStatusFilter","storeIdFilter"],"type":"object"},"QueryBrandStorePageRequest":{"properties":{"editionIdFilter":{"$ref":"#/components/schemas/BrandStorePageBrandStoreEditionIdFilter"},"maxResults":{"default":50,"format":"int32","maximum":50,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"pageIdFilter":{"$ref":"#/components/schemas/BrandStorePagePageIdFilter"},"storeEditionPublishIdFilter":{"$ref":"#/components/schemas/BrandStorePageBrandStoreEditionPublishVersionIdFilter"},"storeIdFilter":{"$ref":"#/components/schemas/BrandStorePageBrandStoreIdFilter"}},"required":["editionIdFilter","pageIdFilter","storeIdFilter"],"type":"object"},"QueryBrandStoreRequest":{"properties":{"maxResults":{"default":30,"format":"int32","maximum":30,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"storeNameFilter":{"$ref":"#/components/schemas/BrandStoreStoreNameFilter"}},"required":["storeNameFilter"],"type":"object"},"QueryCampaignRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/CampaignAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/CampaignCampaignIdFilter"},"goalFilter":{"$ref":"#/components/schemas/CampaignGoalFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/CampaignMarketplaceScopeFilter"},"maxResults":{"format":"int32","maximum":5000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/CampaignNameFilter"},"nextToken":{"type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/CampaignPortfolioIdFilter"},"stateFilter":{"$ref":"#/components/schemas/CampaignStateFilter"}},"required":["adProductFilter"],"type":"object"},"QueryDealAvailsRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/DealAvailsAdProductFilter"},"advertisingDealIdFilter":{"$ref":"#/components/schemas/DealAvailsAdvertisingDealIdFilter"},"eligibleAvailsTargetingFilter":{"$ref":"#/components/schemas/DealAvailsEligibleAvailsTargetingFilter"},"groupByAttributesFilter":{"$ref":"#/components/schemas/DealAvailsDealAvailsAttributeFieldFilter"},"maxResults":{"default":100,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"sort":{"items":{"$ref":"#/components/schemas/DealAvailsSortOption"},"maxItems":2,"minItems":0,"type":"array"}},"required":["adProductFilter","advertisingDealIdFilter"],"type":"object"},"QueryLinearTvDaypartRequest":{"properties":{"marketplaceFilter":{"$ref":"#/components/schemas/LinearTvDaypartMarketplaceFilter"},"maxResults":{"default":20,"format":"int32","maximum":20,"minimum":0,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/LinearTvDaypartLinearTvDaypartNameFilter"},"nextToken":{"type":"string"}},"type":"object"},"QueryManagerAccountRequest":{"properties":{"managerAccountIdFilter":{"$ref":"#/components/schemas/ManagerAccountManagerAccountIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":10,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"QueryPromotionOfferRequest":{"properties":{"marketplaceFilter":{"$ref":"#/components/schemas/PromotionOfferMarketplaceFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"statusFilter":{"$ref":"#/components/schemas/PromotionOfferPromotionOfferStatusFilter"}},"type":"object"},"QueryPromotionRewardRequest":{"properties":{"endDateTimeFilter":{"$ref":"#/components/schemas/PromotionRewardEndDateTimeFilter"},"includePromotionRewardConsumptionFilter":{"$ref":"#/components/schemas/PromotionRewardIncludePromotionRewardConsumptionFilter"},"marketplaceFilter":{"$ref":"#/components/schemas/PromotionRewardMarketplaceFilter"},"maxResults":{"default":25,"format":"int32","maximum":25,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"promotionRewardIdFilter":{"$ref":"#/components/schemas/PromotionRewardPromotionRewardIdFilter"},"promotionRewardTypeFilter":{"$ref":"#/components/schemas/PromotionRewardPromotionRewardTypeFilter"},"startDateTimeFilter":{"$ref":"#/components/schemas/PromotionRewardStartDateTimeFilter"}},"type":"object"},"QueryPublisherRequest":{"properties":{"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1000,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"QueryRuleLinkRequest":{"properties":{"maxResults":{"default":100,"format":"int32","maximum":1000,"minimum":5,"type":"integer"},"nextToken":{"type":"string"},"ruleLinkIdFilter":{"$ref":"#/components/schemas/RuleLinkRuleLinkIdentityFilter"}},"required":["ruleLinkIdFilter"],"type":"object"},"QueryRuleRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/RuleAdProductFilter"},"maxResults":{"default":100,"format":"int32","maximum":1000,"minimum":5,"type":"integer"},"nextToken":{"type":"string"},"ruleIdFilter":{"$ref":"#/components/schemas/RuleRuleIdFilter"},"stateFilter":{"$ref":"#/components/schemas/RuleStateFilter"},"tagsFilter":{"$ref":"#/components/schemas/RuleTagsFilter"}},"required":["adProductFilter"],"type":"object"},"QuerySellerRequest":{"properties":{"maxResults":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SellerNameFilter"},"nextToken":{"type":"string"},"sellerIdFilter":{"$ref":"#/components/schemas/SellerSellerIdFilter"},"sellerParentIdFilter":{"$ref":"#/components/schemas/SellerSellerParentIdFilter"},"sort":{"items":{"$ref":"#/components/schemas/SellerSortOption"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"QuerySellingAccountRequest":{"properties":{"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":10,"type":"integer"},"nextToken":{"type":"string"},"sellingAccountLinkTokenFilter":{"$ref":"#/components/schemas/SellingAccountSellingAccountLinkTokenFilter"},"sellingProgramFilter":{"$ref":"#/components/schemas/SellingAccountSellingProgramFilter"}},"type":"object"},"QuerySupplierRequest":{"properties":{"integrationTypeFilter":{"$ref":"#/components/schemas/SupplierIntegrationTypeFilter"},"maxResults":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"sort":{"items":{"$ref":"#/components/schemas/SupplierSortOption"},"maxItems":1,"minItems":0,"type":"array"},"stateFilter":{"$ref":"#/components/schemas/SupplierSupplierStateFilter"},"supplierIdFilter":{"$ref":"#/components/schemas/SupplierSupplierIdFilter"},"supplierNameFilter":{"$ref":"#/components/schemas/SupplierSupplierNameFilter"},"typeFilter":{"$ref":"#/components/schemas/SupplierSupplierTypeFilter"}},"type":"object"},"QueryTargetRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/TargetAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/TargetAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/TargetCampaignIdFilter"},"inventorySourceIdFilter":{"$ref":"#/components/schemas/TargetMarketplaceStringValueFilter"},"inventorySourceTypeFilter":{"$ref":"#/components/schemas/TargetInventorySourceTypeFilter"},"keywordFilter":{"$ref":"#/components/schemas/TargetKeywordFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/TargetMarketplaceScopeFilter"},"matchTypeFilter":{"$ref":"#/components/schemas/TargetMatchTypeFilter"},"maxResults":{"format":"int32","maximum":5000,"minimum":1,"type":"integer"},"nativeLanguageLocaleFilter":{"$ref":"#/components/schemas/TargetLanguageLocaleFilter"},"negativeFilter":{"$ref":"#/components/schemas/TargetNegativeFilter"},"nextToken":{"type":"string"},"productIdFilter":{"$ref":"#/components/schemas/TargetProductIdFilter"},"stateFilter":{"$ref":"#/components/schemas/TargetStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/TargetTargetIdFilter"},"targetTypeFilter":{"$ref":"#/components/schemas/TargetTargetTypeFilter"}},"required":["adProductFilter"],"type":"object"},"RadiusLocation":{"description":"Configuration for a radius-based location. A minimum radius of 0.37 miles (2000 ft, 0.6km) is required.","properties":{"coordinates":{"$ref":"#/components/schemas/GeoLocationCoordinates"},"pointOfInterestAddress":{"description":"Address. Example \u00272111 7th Ave, Seattle, WA 98121, United States\u0027 or \u0027Amazon Spheres\u0027","type":"string"},"pointOfInterestRadius":{"description":"Radius of circle in kilometers or miles","format":"double","type":"number"},"units":{"$ref":"#/components/schemas/DistanceUnit"}},"required":["pointOfInterestRadius","units"],"type":"object"},"ReachForecastBudgetAllocation":{"properties":{"budget":{"$ref":"#/components/schemas/Budget"},"reachForecastId":{"description":"The identifier for the Reach Forecast.","type":"string"}},"required":["budget","reachForecastId"],"type":"object"},"ReachUnit":{"description":"The unit of reach numbers.\n**ReachUnit Enum:**\n\n| ReachUnit | Description |\n|------|------|\n| `HOUSEHOLD` | Household which can be reached by ads. |\n| `INDIVIDUAL` | Individual people who can view ads. |\n","enum":["HOUSEHOLD","INDIVIDUAL"],"type":"string"},"Recurrence":{"enum":["DAILY","LIFETIME","MONTHLY"],"type":"string"},"RedemptionResult":{"description":"Types of rewards that can be redeemed through a promotion code redemption.\n| RedemptionResult | Description |\n| --- | --- |\n| `promotionOffer` | A promotion offer that was redeemed. |","oneOf":[{"properties":{"promotionOffer":{"type":"string"}},"required":["promotionOffer"],"title":"promotionOffer","type":"object"}]},"RegionCode":{"description":"**RegionCode Enum:**\n\n| RegionCode | Description |\n|------|------|\n| `EU` | Europe |\n| `FE` | Far East |\n| `NA` | North America |\n","enum":["EU","FE","NA"],"type":"string"},"RejectedReasonDetail":{"description":"The details to explain rejected eligibility request status which contains code and description.","properties":{"code":{"$ref":"#/components/schemas/RejectedReasonDetailCode"},"description":{"description":"The description to explain rejected eligibility request status.","type":"string"}},"required":["code","description"],"type":"object"},"RejectedReasonDetailCode":{"description":"The code string that describes the rejected reason.\n**RejectedReasonDetailCode Enum:**\n\n| RejectedReasonDetailCode | Description |\n|------|------|\n| `BUSINESS_VERIFICATION_FAILED` | The advertiser failed to pass business verification checks. |\n| `SALES_VERIFICATION_FAILED` | The advertiser failed to pass sales verification checks. |\n","enum":["BUSINESS_VERIFICATION_FAILED","SALES_VERIFICATION_FAILED"],"type":"string"},"Report":{"properties":{"completedDateTime":{"format":"date-time","type":"string"},"completedReportParts":{"items":{"$ref":"#/components/schemas/ReportPart"},"maxItems":100,"minItems":0,"type":"array"},"creationDateTime":{"format":"date-time","type":"string"},"currencyOfView":{"$ref":"#/components/schemas/CurrencyCode"},"failureCode":{"type":"string"},"failureReason":{"type":"string"},"format":{"$ref":"#/components/schemas/ReportFormat"},"lastUpdatedDateTime":{"format":"date-time","type":"string"},"periods":{"items":{"$ref":"#/components/schemas/ReportPeriod"},"maxItems":1,"minItems":1,"type":"array"},"query":{"$ref":"#/components/schemas/ReportingQuery"},"reportId":{"type":"string"},"status":{"$ref":"#/components/schemas/ReportStatus"}},"required":["creationDateTime","format","lastUpdatedDateTime","periods","query","reportId","status"],"type":"object"},"ReportCreate":{"properties":{"currencyOfView":{"$ref":"#/components/schemas/CurrencyCode"},"format":{"$ref":"#/components/schemas/ReportFormat"},"periods":{"items":{"$ref":"#/components/schemas/CreateReportPeriod"},"maxItems":1,"minItems":1,"type":"array"},"query":{"$ref":"#/components/schemas/CreateReportingQuery"}},"required":["format","periods","query"],"type":"object"},"ReportCreateAccessRequestedAccountItem":{"description":"| ReportCreateAccessRequestedAccountItem | Description |\n| --- | --- |\n| `advertiserAccountId` | ADSP Regional Account or Global Account |\n| `managerAccountId` | Manager Account |","oneOf":[{"properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"],"title":"advertiserAccountId","type":"object"},{"properties":{"managerAccountId":{"type":"string"}},"required":["managerAccountId"],"title":"managerAccountId","type":"object"}]},"ReportFormat":{"description":"**ReportFormat Enum:**\n\n| ReportFormat | Description |\n|------|------|\n| `CSV` | Comma-separated values file containing plain text tabular data |\n| `GZIP_JSON` | JSON file compressed using GZIP format |\n| `PARTITIONED_CSV` | Contents split into multiple CSV files |\n| `PARTITIONED_GZIP_JSON` | Contents split into multiple GZIP-compressed JSON files |\n","enum":["CSV","GZIP_JSON","PARTITIONED_CSV","PARTITIONED_GZIP_JSON"],"type":"string"},"ReportMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/ReportMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"ReportMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"},"report":{"$ref":"#/components/schemas/Report"}},"required":["index","report"],"type":"object"},"ReportPart":{"description":"A downloadable part of the generated report","properties":{"sizeInBytes":{"description":"Size of the part file in bytes, could reach up to 100GB","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"url":{"description":"URL of the report part","type":"string"},"urlExpirationDateTime":{"description":"Expiration date and time when the above URL expires","format":"date-time","type":"string"}},"required":["sizeInBytes","url","urlExpirationDateTime"],"type":"object"},"ReportPeriod":{"oneOf":[{"properties":{"datePeriod":{"$ref":"#/components/schemas/DatePeriod"}},"required":["datePeriod"],"title":"datePeriod","type":"object"}]},"ReportStatus":{"enum":["COMPLETED","FAILED","PENDING","PROCESSING"],"type":"string"},"ReportingQuery":{"properties":{"fields":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"filter":{"$ref":"#/components/schemas/Filter"}},"required":["fields"],"type":"object"},"ResponsiveEcommerceAdVariations":{"enum":["ADD_TO_CART","COUPON","CUSTOMER_REVIEWS","SHOP_NOW"],"type":"string"},"ResponsiveEcommerceCreativePropertiesToOptimize":{"description":"**ResponsiveEcommerceCreativePropertiesToOptimize Enum:**\n\n| ResponsiveEcommerceCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"ResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"ResponsiveEcommerceLandingPageType":{"description":"**ResponsiveEcommerceLandingPageType Enum:**\n\n| ResponsiveEcommerceLandingPageType | Description |\n|------|------|\n| `MOMENT` | A moment landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["MOMENT","STORE"],"type":"string"},"ResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/Image"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","type":"string"}},"type":"object"},"ResponsiveSizingBehavior":{"enum":["DISABLED","ENABLED"],"type":"string"},"RetrieveLocationIndexRequest":{"properties":{"indexIds":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["indexIds"],"type":"object"},"RetrieveReportRequest":{"properties":{"reportIds":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["reportIds"],"type":"object"},"RetrieveRuleRequest":{"properties":{"ruleIds":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["ruleIds"],"type":"object"},"ReviewStars":{"description":"Review information for a product","properties":{"hasHalfStar":{"description":"Flag indicating if the product has a half star in the rating","type":"boolean"},"reviewCount":{"description":"Number of reviews for the product","format":"int32","type":"integer"},"wholeStars":{"description":"Number of whole stars in the rating","format":"int32","type":"integer"}},"required":["hasHalfStar","reviewCount","wholeStars"],"type":"object"},"RolloverStrategy":{"description":"**RolloverStrategy Enum:**\n\n| RolloverStrategy | Description |\n|------|------|\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"],"type":"string"},"Rule":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"creationDateTime":{"description":"The date time that the rule was created.","format":"date-time","type":"string"},"duration":{"$ref":"#/components/schemas/RuleDuration"},"expression":{"description":"A set of conditions and actions that define the rule behavior.","items":{"$ref":"#/components/schemas/RuleExpression"},"maxItems":1000,"minItems":1,"type":"array"},"expressionType":{"$ref":"#/components/schemas/RuleExpressionType"},"lastUpdatedDateTime":{"description":"The date time that the rule was last updated.","format":"date-time","type":"string"},"name":{"description":"The name of the rule.","type":"string"},"onRuleExpressionConflict":{"$ref":"#/components/schemas/RuleExpressionConflictStrategy"},"ruleId":{"description":"The unique identifier of the rule.","type":"string"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the rule","items":{"$ref":"#/components/schemas/Tag"},"maxItems":30,"minItems":0,"type":"array"}},"required":["adProduct","creationDateTime","expression","expressionType","lastUpdatedDateTime","name","ruleId","state","status"],"type":"object"},"RuleAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"RuleCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"duration":{"$ref":"#/components/schemas/CreateRuleDuration"},"expression":{"description":"A set of conditions and actions that define the rule behavior.","items":{"$ref":"#/components/schemas/CreateRuleExpression"},"maxItems":1000,"minItems":1,"type":"array"},"expressionType":{"$ref":"#/components/schemas/RuleExpressionType"},"name":{"description":"The name of the rule.","type":"string"},"onRuleExpressionConflict":{"$ref":"#/components/schemas/RuleExpressionConflictStrategy"},"ruleId":{"description":"The unique identifier of the rule.","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the rule","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":30,"minItems":0,"type":"array"}},"required":["adProduct","expression","expressionType","name","ruleId","state"],"type":"object"},"RuleCriteria":{"description":"| RuleCriteria | Description |\n|------|------|\n| `dimensionCriteria` | Defines dimension-based targeting criteria using generic dimension filters. |\n","oneOf":[{"properties":{"dimensionCriteria":{"$ref":"#/components/schemas/DimensionCriteria"}},"required":["dimensionCriteria"],"title":"dimensionCriteria","type":"object"}]},"RuleDuration":{"description":"Duration defined by a start and end date. startDateTime and endDateTime are ReadOnly if calendarEvent is also provided in duration.","properties":{"endDateTime":{"description":"The end date time for the rule.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the rule.","format":"date-time","type":"string"}},"type":"object"},"RuleExpression":{"description":"The conditions and actions that define the rule behavior.\n\n| RuleExpression | Description |\n|------|------|\n| `dimensionRuleExpression` | Dimension-based rule expression. |\n","oneOf":[{"properties":{"dimensionRuleExpression":{"$ref":"#/components/schemas/DimensionRuleExpression"}},"required":["dimensionRuleExpression"],"title":"dimensionRuleExpression","type":"object"}]},"RuleExpressionConflictStrategy":{"description":"Strategy to resolve conflicts when multiple rule expressions match the same impression.\n**RuleExpressionConflictStrategy Enum:**\n\n| RuleExpressionConflictStrategy | Description |\n|------|------|\n| `ALL` | Apply all matching rule expressions. |\n","enum":["ALL"],"type":"string"},"RuleExpressionType":{"description":"**RuleExpressionType Enum:**\n\n| RuleExpressionType | Description |\n|------|------|\n| `DIMENSION_RULE_EXPRESSION` | Dimension-based rule expression type. Supports targeting conditions using generic dimension filters. |\n","enum":["DIMENSION_RULE_EXPRESSION"],"type":"string"},"RuleLink":{"properties":{"creationDateTime":{"description":"The date time that the link was created.","format":"date-time","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the link was last updated.","format":"date-time","type":"string"},"ruleLinkId":{"$ref":"#/components/schemas/RuleLinkIdentity"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"}},"required":["creationDateTime","lastUpdatedDateTime","ruleLinkId","state","status"],"type":"object"},"RuleLinkCreate":{"properties":{"ruleLinkId":{"$ref":"#/components/schemas/CreateRuleLinkIdentity"},"state":{"$ref":"#/components/schemas/CreateState"}},"required":["ruleLinkId","state"],"type":"object"},"RuleLinkIdentity":{"properties":{"entityId":{"$ref":"#/components/schemas/RuleLinkedEntity"},"ruleId":{"description":"The associated rule.","type":"string"},"ruleLinkEntityType":{"$ref":"#/components/schemas/RuleLinkedEntityType"}},"required":["entityId","ruleId","ruleLinkEntityType"],"type":"object"},"RuleLinkMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/RuleLinkMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"RuleLinkMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"},"ruleLink":{"$ref":"#/components/schemas/RuleLink"}},"required":["index","ruleLink"],"type":"object"},"RuleLinkRuleLinkIdentityFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/RuleLinkIdentity"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"RuleLinkSuccessResponse":{"properties":{"nextToken":{"type":"string"},"ruleLinks":{"items":{"$ref":"#/components/schemas/RuleLink"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"RuleLinkedEntity":{"oneOf":[{"properties":{"adGroup":{"type":"string"}},"required":["adGroup"],"title":"adGroup","type":"object"},{"properties":{"campaign":{"type":"string"}},"required":["campaign"],"title":"campaign","type":"object"}]},"RuleLinkedEntityType":{"enum":["AD_GROUP","CAMPAIGN"],"type":"string"},"RuleMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/RuleMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"RuleMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"},"rule":{"$ref":"#/components/schemas/Rule"}},"required":["index","rule"],"type":"object"},"RuleRuleIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"RuleStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","items":{"$ref":"#/components/schemas/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"RuleSuccessResponse":{"properties":{"nextToken":{"type":"string"},"rules":{"items":{"$ref":"#/components/schemas/Rule"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"RuleTagsFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/Tag"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"RuleUpdate":{"properties":{"duration":{"$ref":"#/components/schemas/UpdateRuleDuration"},"expression":{"description":"A set of conditions and actions that define the rule behavior.","items":{"$ref":"#/components/schemas/CreateRuleExpression"},"maxItems":1000,"minItems":1,"type":"array"},"name":{"description":"The name of the rule.","type":"string"},"onRuleExpressionConflict":{"$ref":"#/components/schemas/RuleExpressionConflictStrategy"},"ruleId":{"description":"The unique identifier of the rule.","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the rule","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":30,"minItems":0,"type":"array"}},"required":["ruleId"],"type":"object"},"SalesChannel":{"description":"**SalesChannel Enum:**\n\n| SalesChannel | Description |\n|------|------|\n| `AMAZON` | A product sold on Amazon-owned sites. |\n| `OFF_AMAZON` | A product sold on a site not owned by Amazon. |\n","enum":["AMAZON","OFF_AMAZON"],"type":"string"},"Seller":{"properties":{"isActive":{"description":"Whether this seller is currently active.","type":"boolean"},"isConfidential":{"description":"Whether identity is confidential per IAB sellers.json.","type":"boolean"},"name":{"description":"Display name. Normalized across all advertising systems. NULL when isConfidential is true.","type":"string"},"sellerId":{"description":"The unique identifier of the seller (Long serialized as String).","type":"string"},"sellerParentId":{"description":"The identifier of the parent holding company that owns this seller.","type":"string"}},"required":["sellerId"],"type":"object"},"SellerNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SellerNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SellerNameFilterType":{"description":"**SellerNameFilterType Enum:**\n| SellerNameFilterType | Description |\n| --- | --- |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH"],"type":"string"},"SellerSellerIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SellerSellerParentIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SellerSortOption":{"properties":{"by":{"$ref":"#/components/schemas/SellerSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"SellerSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| name | ASCENDING,DESCENDING |","enum":["name"],"type":"string"},"SellerSuccessResponse":{"properties":{"nextToken":{"type":"string"},"sellers":{"items":{"$ref":"#/components/schemas/Seller"},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"SellingAccount":{"properties":{"business":{"$ref":"#/components/schemas/SellingAccountBusiness"},"countryCodes":{"description":"The countries of the selling account user can advertise in.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":30,"minItems":0,"type":"array"},"displayName":{"description":"Display name for the selling account.","type":"string"},"portals":{"description":"The portal(s) used to access the selling account.","items":{"$ref":"#/components/schemas/Portal"},"maxItems":6,"minItems":1,"type":"array"},"sellingAccountLinkToken":{"description":"The token to locate a selling account.","type":"string"},"sellingProgram":{"$ref":"#/components/schemas/SellingProgram"}},"required":["portals","sellingAccountLinkToken","sellingProgram"],"type":"object"},"SellingAccountAddress":{"description":"The business address of selling account.","format":"password","properties":{"addressLine1":{"description":"The address details - 1 of business.","type":"string"},"addressLine2":{"description":"The address details - 2 of business.","type":"string"},"addressToken":{"description":"The token to locate a business address.","type":"string"},"businessName":{"description":"The name of business.","type":"string"},"city":{"description":"The city where business is located.","type":"string"},"countryCode":{"description":"The country where business is located.","type":"string"},"phoneNumber":{"description":"The phone number of business.","type":"string"},"state":{"description":"The city where business is located.","type":"string"},"zipCode":{"description":"The zipCode where business is located.","type":"string"}},"required":["addressLine1","addressToken","businessName","city","countryCode","state","zipCode"],"type":"object"},"SellingAccountBusiness":{"description":"The business details of selling account.","properties":{"addresses":{"description":"A list of business address the selling account has.","items":{"$ref":"#/components/schemas/SellingAccountAddress"},"maxItems":10,"minItems":0,"type":"array"},"website":{"description":"The website of the business.","type":"string"}},"type":"object"},"SellingAccountLinkDetails":{"properties":{"linkStatus":{"$ref":"#/components/schemas/SellingAccountLinkStatus"},"sellingAccountLinkToken":{"description":"The token to locate a selling account to be linked.","type":"string"},"sellingProgram":{"$ref":"#/components/schemas/SellingProgram"}},"required":["linkStatus","sellingAccountLinkToken"],"type":"object"},"SellingAccountLinkRequest":{"oneOf":[{"properties":{"sellingAccountLinkDetails":{"$ref":"#/components/schemas/SellingAccountLinkDetails"}},"required":["sellingAccountLinkDetails"],"title":"sellingAccountLinkDetails","type":"object"}]},"SellingAccountLinkState":{"enum":["APPROVED","IN_PROGRESS","PENDING_APPROVAL","REJECTED"],"type":"string"},"SellingAccountLinkStatus":{"properties":{"statusCode":{"$ref":"#/components/schemas/SellingAccountLinkState"},"statusMessage":{"description":"The human friendly status message.","type":"string"}},"required":["statusCode","statusMessage"],"type":"object"},"SellingAccountSellingAccountLinkTokenFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SellingAccountSellingProgramFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/SellingProgram"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SellingAccountSuccessResponse":{"properties":{"nextToken":{"type":"string"},"sellingAccounts":{"items":{"$ref":"#/components/schemas/SellingAccount"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SellingProgram":{"enum":["AMAZON_AUTHOR","AMAZON_SELLER","AMAZON_VENDOR"],"type":"string"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/Image"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"}},"required":["brand"],"type":"object"},"ShopperSegment":{"enum":["NEW_TO_BRAND"],"type":"string"},"ShopperSegmentBidAdjustment":{"properties":{"percentage":{"description":"The selection of the percentage change associated with a given shopper segment and bid adjustment settings.","format":"int32","type":"integer"},"shopperSegment":{"$ref":"#/components/schemas/ShopperSegment"}},"required":["percentage","shopperSegment"],"type":"object"},"SiteLanguage":{"description":"**SiteLanguage Enum:**\n\n| SiteLanguage | Description |\n|------|------|\n| `AR` | Arabic. |\n| `BN` | Bengali. |\n| `CS` | Czech. |\n| `DA` | Danish. |\n| `DE` | German. |\n| `EN` | English. |\n| `ES` | Spanish. |\n| `FI` | Finnish. |\n| `FR` | French. |\n| `GU` | Gujarati. |\n| `HI` | Hindi. |\n| `IT` | Italian. |\n| `JA` | Japanese. |\n| `KN` | Kannada. |\n| `ML` | Malayalam. |\n| `MR` | Marathi. |\n| `NL` | Dutch. |\n| `NO` | Norwegian. |\n| `OTHER` | Other language. |\n| `PA` | Punjabi. |\n| `PL` | Polish. |\n| `PT` | Portuguese. |\n| `SV` | Swedish. |\n| `TA` | Tamil. |\n| `TE` | Telugu. |\n| `TR` | Turkish. |\n| `ZH` | Chinese. |\n","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"},"SiteRestriction":{"description":"**SiteRestriction Enum:**\n\n| SiteRestriction | Description |\n|------|------|\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n| `AMAZON_HAUL` | Restrict the ad to only show on Amazon Haul. |\n","enum":["AMAZON_BUSINESS","AMAZON_HAUL"],"type":"string"},"Size":{"properties":{"height":{"description":"The height of the creative placement.","format":"int32","type":"integer"},"width":{"description":"The width of the creative placement.","format":"int32","type":"integer"}},"required":["height","width"],"type":"object"},"SmartLocation":{"description":"A smart location targets postal codes based on a sales index.","properties":{"locationIndexId":{"description":"The ID of the index used for this smart location.","type":"string"},"maxIndexValuePercentile":{"description":"Maximum percentile value (0-100). Must be greater than minIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"minIndexValuePercentile":{"description":"Minimum percentile value (0-100). Must be less than maxIndexValuePercentile. Null will be treated as 0.","format":"int32","maximum":100,"minimum":0,"type":"integer"},"name":{"description":"Name for the smart location.","type":"string"}},"required":["locationIndexId","name"],"type":"object"},"SortDirection":{"description":"**SortDirection Enum:**\n\n| SortDirection | Description |\n|------|------|\n| `ASCENDING` | Sort in ascending order |\n| `DESCENDING` | Sort in descending order |\n","enum":["ASCENDING","DESCENDING"],"type":"string"},"SpendsFulfilmentCriterion":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"endDateTime":{"description":"The deadline by which the spend threshold must be met. This is only populated after the campaign is launched.","format":"date-time","type":"string"},"spend":{"description":"The current amount spent by the advertiser towards meeting the spend threshold. This is only populated after the campaign is launched.","format":"double","type":"number"},"startDateTime":{"description":"The date from which advertiser spends start being tracked towards the threshold. This is only populated after the campaign is launched.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/CriterionStatus"},"tiers":{"description":"Different spend threshold tiers with corresponding reward amounts associated to the same promotion offer.","items":{"$ref":"#/components/schemas/SpendsTier"},"maxItems":3,"minItems":1,"type":"array"}},"required":["currencyCode","status","tiers"],"type":"object"},"SpendsTier":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"description":{"description":"The description of the spending tier.","type":"string"},"reward":{"description":"The click credits amount to be rewarded when this tier\u0027s threshold is met.","format":"double","type":"number"},"threshold":{"description":"The minimum spend amount required for this tier.","format":"double","type":"number"}},"required":["currencyCode","description","reward","threshold"],"type":"object"},"SpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/Video"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"type":"object"},"StandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/Audio"},"callToActions":{"$ref":"#/components/schemas/AudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/Image"},"headlines":{"description":"The headline(s) to use for the standard audio experience. Headlines must be a maximum of 20 characters.","type":"string"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","companionImages","headlines","language"],"type":"object"},"StandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/DisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/Image"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"State":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**State Enum:**\n\n| State | Description |\n|------|------|\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n","enum":["ARCHIVED","ENABLED","PAUSED"],"type":"string"},"Status":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplaceSettings":{"description":"The list of marketplace level delivery status and reasons of global resources, for all the marketplaces the global resource is applicable in.","items":{"$ref":"#/components/schemas/StatusMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"required":["deliveryStatus"],"type":"object"},"StatusMarketplaceSetting":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["deliveryStatus","marketplace"],"type":"object"},"StoreASINSlide":{"properties":{"productAsin":{"description":"The ASIN of the product.","type":"string"},"tag":{"description":"Unique tag for the slide which will be ASIN.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"required":["productAsin","tag","type"],"type":"object"},"StoreAWLSTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreAWLSTileContent"},"externalWidgetId":{"description":"External widget identifier.","type":"string"}},"required":["commonProperties","externalWidgetId"],"type":"object"},"StoreAWLSTileContent":{"oneOf":[{"properties":{"brandedRecipeWidget":{"$ref":"#/components/schemas/BrandedRecipeWidget"}},"required":["brandedRecipeWidget"],"title":"brandedRecipeWidget","type":"object"},{"properties":{"storeProductSelectorWidget":{"$ref":"#/components/schemas/StoreProductSelectorWidget"}},"required":["storeProductSelectorWidget"],"title":"storeProductSelectorWidget","type":"object"},{"properties":{"storeVideoRevealWidget":{"$ref":"#/components/schemas/StoreVideoRevealWidget"}},"required":["storeVideoRevealWidget"],"title":"storeVideoRevealWidget","type":"object"}]},"StoreAWLSWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The AWLS tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreAWLSTile"},"maxItems":1,"minItems":1,"type":"array"},"widgetDependencies":{"description":"List of widget dependencies.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreBannerContent":{"properties":{"banners":{"$ref":"#/components/schemas/StoreBanners"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"StoreBannerWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreBannerContent"}},"required":["commonProperties","content"],"type":"object"},"StoreBanners":{"properties":{"blackLivesMatter":{"description":"Flag to display Black Lives Matter banner","type":"boolean"},"stopAsianHate":{"description":"Flag to display Stop Asian Hate banner","type":"boolean"}},"required":["blackLivesMatter","stopAsianHate"],"type":"object"},"StoreBleedImageType":{"description":"| StoreBleedImageType | Description |\n|------|------|\n| `ALL` | All sides image bleed |\n| `CORNER` | Corner image bleed |\n| `NONE` | No image bleed |\n| `SIDE` | Side image bleed |\n","enum":["ALL","CORNER","NONE","SIDE"],"type":"string"},"StoreCallToActionData":{"properties":{"customUrl":{"description":"Custom URL for the call to action.","type":"string"},"pageId":{"description":"Page identifier.","type":"string"},"productAsin":{"description":"ASIN for the call to action.","type":"string"},"text":{"description":"Call to action text.","type":"string"}},"type":"object"},"StoreCallToActionProductData":{"properties":{"customUrl":{"description":"Custom URL for the call to action.","type":"string"},"productAsin":{"description":"Product ASIN for the call to action.","type":"string"},"text":{"description":"Call to action text.","type":"string"}},"type":"object"},"StoreCallToActionType":{"description":"| StoreCallToActionType | Description |\n|------|------|\n| `BUTTON` | Button type call to action |\n| `LINK` | Link type call to action |\n","enum":["BUTTON","LINK"],"type":"string"},"StoreCanvasData":{"properties":{"canvasHeight":{"description":"Height in the canvas.","format":"double","type":"number"},"height":{"description":"Height in the canvas.","format":"double","type":"number"},"left":{"description":"Left position in the canvas.","format":"double","type":"number"},"naturalHeight":{"description":"Natural height of the image.","format":"double","type":"number"},"naturalWidth":{"description":"Natural width of the image.","format":"double","type":"number"},"top":{"description":"Top position in the canvas.","format":"double","type":"number"},"width":{"description":"Width in the canvas.","format":"double","type":"number"}},"type":"object"},"StoreCarouselContent":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"callToActionData":{"$ref":"#/components/schemas/StoreCallToActionData"},"includeOutOfStock":{"description":"Whether to include out of stock items.","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"productAsins":{"description":"List of ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"search":{"$ref":"#/components/schemas/StoreCarouselSearch"},"slides":{"description":"List of ASIN slides.","items":{"$ref":"#/components/schemas/StoreASINSlide"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content to track performance.","type":"string"},"text":{"description":"Description text.","type":"string"},"title":{"description":"Title of the carousel.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"required":["bulk","callToActionData","includeOutOfStock","keyword","tag","text","title","type"],"type":"object"},"StoreCarouselSearch":{"properties":{"includeOutOfStock":{"description":"Whether to include out of stock items in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"List of ASINs for search filtering.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["includeOutOfStock","keyword","node"],"type":"object"},"StoreColorPalette":{"description":"| StoreColorPalette | Description |\n|------|------|\n| `DEFAULT_INVERTED` | Inverted default color scheme |\n| `DEFAULT` | Default color scheme |\n| `SOLID_BLACK` | Solid black color scheme |\n| `SOLID_WHITE` | Solid white color scheme |\n| `TRANSLUCENT_BLACK` | Translucent black color scheme |\n| `TRANSLUCENT_WHITE` | Translucent white color scheme |\n| `TRANSPARENT_BLACK` | Transparent black color scheme |\n| `TRANSPARENT_WHITE` | Transparent white color scheme |\n","enum":["DEFAULT","DEFAULT_INVERTED","SOLID_BLACK","SOLID_WHITE","TRANSLUCENT_BLACK","TRANSLUCENT_WHITE","TRANSPARENT_BLACK","TRANSPARENT_WHITE"],"type":"string"},"StoreCropBoxData":{"properties":{"height":{"description":"Height of the crop box.","format":"double","type":"number"},"left":{"description":"Left position of the crop box.","format":"double","type":"number"},"top":{"description":"Top position of the crop box.","format":"double","type":"number"},"width":{"description":"Width of the crop box.","format":"double","type":"number"}},"type":"object"},"StoreCroppedImage":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBox":{"$ref":"#/components/schemas/StoreCropBoxData"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageNaturalHeight":{"description":"Natural height of the image.","format":"double","type":"number"},"imageNaturalWidth":{"description":"Natural width of the image.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"}},"type":"object"},"StoreCustomCodeContent":{"properties":{"autoDimension":{"description":"Whether to use automatic dimensioning.","type":"boolean"},"availableProductAsins":{"description":"List of available ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"cti":{"$ref":"#/components/schemas/CTI"},"embedCode":{"description":"Embedded code content.","type":"string"},"integrity":{"description":"Integrity hash for security.","type":"string"},"widgetName":{"description":"Name of the widget.","type":"string"},"widgetTag":{"description":"Widget identifier.","type":"string"}},"type":"object"},"StoreCustomCodeTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreCustomCodeContent"}},"required":["commonProperties"],"type":"object"},"StoreCustomCodeWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The custom code tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreCustomCodeTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreDealsConfig":{"properties":{"node":{"description":"Node identifier for deals.","type":"string"}},"type":"object"},"StoreDealsContent":{"properties":{"deals":{"$ref":"#/components/schemas/StoreDealsConfig"},"dealsMode":{"$ref":"#/components/schemas/StoreDealsMode"},"productAsins":{"description":"List of ASINs, maximum 500 unique items.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content to track performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"type":"object"},"StoreDealsMode":{"description":"| StoreDealsMode | Description |\n|------|------|\n| `AUTOMATIC` | Automatic mode |\n| `BULK` | Bulk mode |\n","enum":["AUTOMATIC","BULK"],"type":"string"},"StoreDealsWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreDealsContent"}},"required":["commonProperties"],"type":"object"},"StoreEditionSchedule":{"description":"Schedule information for store edition","properties":{"endAt":{"description":"End time for the store edition","format":"date-time","type":"string"},"startAt":{"description":"Start time for the store edition","format":"date-time","type":"string"}},"type":"object"},"StoreEmptyTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreEmptyTileContent"}},"required":["commonProperties","content"],"type":"object"},"StoreEmptyTileContent":{"properties":{"bondCustomerServiceLink":{"description":"Whether to include a customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"text":{"description":"Text content (must be empty).","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the tile (must be empty).","type":"string"}},"type":"object"},"StoreGalleryContent":{"properties":{"metadata":{"description":"Metadata associated with the gallery.","items":{"$ref":"#/components/schemas/StoreMetadataItem"},"maxItems":15,"minItems":0,"type":"array"},"slides":{"description":"List of slides in the gallery.","items":{"$ref":"#/components/schemas/StoreGallerySlide"},"maxItems":15,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content.","type":"string"},"text":{"description":"Text content of the gallery.","type":"string"},"title":{"description":"Title of the gallery.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"StoreGallerySlide":{"properties":{"alt":{"description":"Alternative text for the slide.","type":"string"},"assetId":{"description":"Asset identifier for the slide.","type":"string"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"type":"object"},"StoreGalleryWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreGalleryContent"}},"required":["commonProperties"],"type":"object"},"StoreHeroContent":{"properties":{"assetId":{"description":"Identifier for the asset.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"description":{"description":"Description of the hero image.","type":"string"},"imageHeight":{"description":"Height of the hero image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset of the image.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset of the image.","format":"double","type":"number"},"imageUrl":{"description":"URL of the hero image.","type":"string"},"imageWidth":{"description":"Width of the hero image.","format":"double","type":"number"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileContent"},"tag":{"description":"Unique tag for the content.","type":"string"},"textOverlay":{"description":"Text overlay displayed on the hero image.","type":"string"}},"required":["imageUrl"],"type":"object"},"StoreHeroImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreHeroContent"}},"required":["commonProperties"],"type":"object"},"StoreImageContent":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"customUrl":{"description":"Custom URL.","type":"string"},"hideTitle":{"description":"Whether to hide the title.","type":"boolean"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"pageId":{"description":"Page identifier.","type":"string"},"productAsins":{"description":"Single ASIN for the image.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreImageTextAlign"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the image.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StoreImageLayout":{"description":"| StoreImageLayout | Description |\n|------|------|\n| `CONTAIN` | Contain layout |\n| `COVER` | Cover layout |\n| `TEXT` | Text layout |\n","enum":["CONTAIN","COVER","TEXT"],"type":"string"},"StoreImageShape":{"description":"| StoreImageShape | Description |\n|------|------|\n| `SQUARE` | Square shape |\n","enum":["SQUARE"],"type":"string"},"StoreImageSlide":{"properties":{"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"tag":{"description":"Unique identifier for the slide.","type":"string"},"type":{"$ref":"#/components/schemas/StoreSlideType"}},"type":"object"},"StoreImageTextAlign":{"description":"| StoreImageTextAlign | Description |\n|------|------|\n| `LEFT` | Left text alignment |\n| `RIGHT` | Right text alignment |\n","enum":["LEFT","RIGHT"],"type":"string"},"StoreImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreImageContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileImageContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"}},"required":["commonProperties"],"type":"object"},"StoreImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The image tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreImageTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreImageWithTextContent":{"properties":{"altText":{"description":"Alternative text for the image.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"customUrl":{"description":"Custom URL.","type":"string"},"hideTitle":{"description":"Whether to hide the title.","type":"boolean"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"pageId":{"description":"Page identifier.","type":"string"},"productAsins":{"description":"Single ASIN for the image.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"shape":{"$ref":"#/components/schemas/StoreImageShape"},"text":{"description":"Text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"textOption":{"$ref":"#/components/schemas/StoreTextOption"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the image.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StoreImageWithTextTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreImageWithTextContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileImageWithTextContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"},"variation":{"$ref":"#/components/schemas/StoreImageWithTextTileVariation"}},"required":["commonProperties","variation"],"type":"object"},"StoreImageWithTextTileVariation":{"description":"| StoreImageWithTextTileVariation | Description |\n|------|------|\n| `IMAGE_WITH_TEXT` | Image with text variation |\n","enum":["IMAGE_WITH_TEXT"],"type":"string"},"StoreImageWithTextWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The image with text tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreImageWithTextTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreLayoutType":{"description":"| StoreLayoutType | Description |\n|------|------|\n| `DEFAULT` | Default layout configuration |\n| `SHOWCASE` | Showcase layout configuration for featured display |\n","enum":["DEFAULT","SHOWCASE"],"type":"string"},"StoreLiveVideoContent":{"properties":{"channel":{"description":"Channel of the video.","type":"string"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"required":["tag","type"],"type":"object"},"StoreLiveVideoWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreLiveVideoContent"}},"required":["commonProperties","content"],"type":"object"},"StoreManuallyCuratedProductCarouselWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreCarouselContent"}},"required":["commonProperties"],"type":"object"},"StoreMetadataItem":{"properties":{"alt":{"description":"Alternative text.","type":"string"},"assetId":{"description":"Asset identifier.","type":"string"},"filename":{"description":"Name of the file.","type":"string"},"imageKey":{"description":"Key identifier for the image.","type":"string"},"imageUrl":{"description":"The imageUrl of the item.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"},"url":{"description":"URL of the item.","type":"string"}},"type":"object"},"StoreMobileContent":{"properties":{"assetId":{"description":"Asset identifier for mobile view.","type":"string"},"assetTags":{"description":"Asset tags for mobile view.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"imageHeight":{"description":"Height of the image for mobile view.","format":"double","type":"number"},"imageKey":{"description":"Image key for mobile view.","type":"string"},"imageOffsetLeft":{"description":"Left offset of the image for mobile view.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset of the image for mobile view.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image for mobile view.","type":"string"},"imageWidth":{"description":"Width of the image for mobile view.","format":"double","type":"number"},"version":{"description":"Version identifier for mobile content","type":"string"}},"type":"object"},"StoreMobileImageContent":{"properties":{"altText":{"description":"Alternative text for the mobile image.","type":"string"},"assetId":{"description":"Asset identifier for mobile.","type":"string"},"assetTags":{"description":"Tags associated with the mobile asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"hideTitle":{"description":"Whether to hide the title on mobile.","type":"boolean"},"imageHeight":{"description":"Height of the mobile image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the mobile image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for mobile image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for mobile image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the mobile image.","type":"string"},"imageWidth":{"description":"Width of the mobile image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the mobile image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"tileLayers":{"description":"Layer configuration for the mobile tile.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title for mobile display.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StoreMobileImageWithTextContent":{"properties":{"altText":{"description":"Alternative text for the mobile image.","type":"string"},"assetId":{"description":"Asset identifier for mobile.","type":"string"},"assetTags":{"description":"Tags associated with the mobile asset.","type":"string"},"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"cropBoxData":{"$ref":"#/components/schemas/StoreCropBoxData"},"hideTitle":{"description":"Whether to hide the title on mobile.","type":"boolean"},"imageHeight":{"description":"Height of the mobile image.","format":"double","type":"number"},"imageKey":{"description":"Key identifier for the mobile image.","type":"string"},"imageOffsetLeft":{"description":"Left offset for mobile image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for mobile image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the mobile image.","type":"string"},"imageWidth":{"description":"Width of the mobile image.","format":"double","type":"number"},"isAiGen":{"description":"Whether the mobile image is AI-generated.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreImageLayout"},"renderTileLayers":{"description":"Whether to render tile layers on mobile.","type":"boolean"},"shape":{"$ref":"#/components/schemas/StoreImageShape"},"text":{"description":"Text content for mobile.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"textOption":{"$ref":"#/components/schemas/StoreTextOption"},"tileLayers":{"description":"Layer configuration for the mobile tile.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title for mobile display.","type":"string"},"verticalAlign":{"$ref":"#/components/schemas/StoreVerticalAlign"}},"type":"object"},"StorePageContent":{"description":"Structure containing the content elements of a store page","properties":{"description":{"description":"Description of the page","type":"string"},"template":{"$ref":"#/components/schemas/StorePageTemplate"},"title":{"description":"For store page, title of the page; for SB landing page, this can be optional","type":"string"},"widgets":{"description":"Collection of widgets displayed on the page","items":{"$ref":"#/components/schemas/StorePageWidget"},"maxItems":20,"minItems":0,"type":"array"}},"required":["template"],"type":"object"},"StorePageTemplate":{"description":"| StorePageTemplate | Description |\n|------|------|\n| `BLANK` | Empty template for custom layouts |\n| `HIGHLIGHT` | Template for highlighting specific content |\n| `MARQUEE` | Template featuring a prominent marquee section |\n| `PRODUCT_COLLECTION` | Template for displaying collections of products |\n| `PRODUCT_GRID` | Template displaying products in a grid layout |\n","enum":["BLANK","HIGHLIGHT","MARQUEE","PRODUCT_COLLECTION","PRODUCT_GRID"],"type":"string"},"StorePageType":{"description":"| StorePageType | Description |\n|------|------|\n| `BRAND_STORE_PAGE` | Standard brand store page that allows customization to show case the brand and product |\n| `LANDING_PAGE` | Landing page for specific ads program with predefined template |\n","enum":["BRAND_STORE_PAGE","LANDING_PAGE"],"type":"string"},"StorePageVersion":{"description":"Version information for a store page","properties":{"pageId":{"description":"Identifier of the page","type":"string"},"version":{"description":"Version number of the page","format":"int32","type":"integer"}},"required":["pageId","version"],"type":"object"},"StorePageWidget":{"description":"Union of all possible widget types that can be used on a store page\n\n","oneOf":[{"properties":{"storeAWLSWidget":{"$ref":"#/components/schemas/StoreAWLSWidget"}},"required":["storeAWLSWidget"],"title":"storeAWLSWidget","type":"object"},{"properties":{"storeBannerWidget":{"$ref":"#/components/schemas/StoreBannerWidget"}},"required":["storeBannerWidget"],"title":"storeBannerWidget","type":"object"},{"properties":{"storeCustomCodeWidget":{"$ref":"#/components/schemas/StoreCustomCodeWidget"}},"required":["storeCustomCodeWidget"],"title":"storeCustomCodeWidget","type":"object"},{"properties":{"storeDealsWidget":{"$ref":"#/components/schemas/StoreDealsWidget"}},"required":["storeDealsWidget"],"title":"storeDealsWidget","type":"object"},{"properties":{"storeGalleryWidget":{"$ref":"#/components/schemas/StoreGalleryWidget"}},"required":["storeGalleryWidget"],"title":"storeGalleryWidget","type":"object"},{"properties":{"storeHeroImageWidget":{"$ref":"#/components/schemas/StoreHeroImageWidget"}},"required":["storeHeroImageWidget"],"title":"storeHeroImageWidget","type":"object"},{"properties":{"storeImageWidget":{"$ref":"#/components/schemas/StoreImageWidget"}},"required":["storeImageWidget"],"title":"storeImageWidget","type":"object"},{"properties":{"storeImageWithTextWidget":{"$ref":"#/components/schemas/StoreImageWithTextWidget"}},"required":["storeImageWithTextWidget"],"title":"storeImageWithTextWidget","type":"object"},{"properties":{"storeLiveVideoWidget":{"$ref":"#/components/schemas/StoreLiveVideoWidget"}},"required":["storeLiveVideoWidget"],"title":"storeLiveVideoWidget","type":"object"},{"properties":{"storeManuallyCuratedProductCarouselWidget":{"$ref":"#/components/schemas/StoreManuallyCuratedProductCarouselWidget"}},"required":["storeManuallyCuratedProductCarouselWidget"],"title":"storeManuallyCuratedProductCarouselWidget","type":"object"},{"properties":{"storeProductCarouselWidget":{"$ref":"#/components/schemas/StoreProductCarouselWidget"}},"required":["storeProductCarouselWidget"],"title":"storeProductCarouselWidget","type":"object"},{"properties":{"storeProductCollectionWidget":{"$ref":"#/components/schemas/StoreProductCollectionWidget"}},"required":["storeProductCollectionWidget"],"title":"storeProductCollectionWidget","type":"object"},{"properties":{"storeProductGridWidget":{"$ref":"#/components/schemas/StoreProductGridWidget"}},"required":["storeProductGridWidget"],"title":"storeProductGridWidget","type":"object"},{"properties":{"storeProductWidget":{"$ref":"#/components/schemas/StoreProductWidget"}},"required":["storeProductWidget"],"title":"storeProductWidget","type":"object"},{"properties":{"storeShopTheLookWidget":{"$ref":"#/components/schemas/StoreShopTheLookWidget"}},"required":["storeShopTheLookWidget"],"title":"storeShopTheLookWidget","type":"object"},{"properties":{"storeShoppableImageWidget":{"$ref":"#/components/schemas/StoreShoppableImageWidget"}},"required":["storeShoppableImageWidget"],"title":"storeShoppableImageWidget","type":"object"},{"properties":{"storeTextWidget":{"$ref":"#/components/schemas/StoreTextWidget"}},"required":["storeTextWidget"],"title":"storeTextWidget","type":"object"},{"properties":{"storeTileWidget":{"$ref":"#/components/schemas/StoreTileWidget"}},"required":["storeTileWidget"],"title":"storeTileWidget","type":"object"},{"properties":{"storeVideoWidget":{"$ref":"#/components/schemas/StoreVideoWidget"}},"required":["storeVideoWidget"],"title":"storeVideoWidget","type":"object"}]},"StoreProductCarouselContent":{"properties":{"callToActionData":{"$ref":"#/components/schemas/StoreCallToActionProductData"},"searchContent":{"$ref":"#/components/schemas/StoreProductCarouselSearch"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"required":["tag","type"],"type":"object"},"StoreProductCarouselSearch":{"properties":{"node":{"description":"Node identifier for search","type":"string"},"type":{"$ref":"#/components/schemas/StoreProductCarouselSearchType"}},"type":"object"},"StoreProductCarouselSearchType":{"description":"| StoreProductCarouselSearchType | Description |\n|------|------|\n| `BEST_SELLING` | Best selling items |\n| `RECOMMENDATION_FOR_YOU` | Personalized recommendations |\n","enum":["BEST_SELLING","RECOMMENDATION_FOR_YOU"],"type":"string"},"StoreProductCarouselWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreProductCarouselContent"}},"required":["commonProperties","content"],"type":"object"},"StoreProductCollectionASINGrid":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"description":{"description":"Description of the product grid.","type":"string"},"displayProductGridHeader":{"description":"Whether to display the product grid header.","type":"boolean"},"includeOutOfStock":{"description":"Whether to include out of stock products.","type":"boolean"},"isAutomatedProductGrid":{"description":"Whether the product grid is automatically populated","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"productAsins":{"description":"List of ASINs, maximum 60 unique items.","items":{"type":"string"},"maxItems":60,"minItems":0,"type":"array"},"sort":{"description":"Sort order for products.","type":"string"},"tag":{"description":"Unique tag for the tile to track performance.","type":"string"},"title":{"description":"Title of the product grid.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"},"variation":{"description":"Variation of the product grid.","type":"string"}},"required":["type"],"type":"object"},"StoreProductCollectionContent":{"properties":{"collectionTags":{"description":"Tags associated with the collection.","type":"string"},"productGridConversionTimestamp":{"description":"Timestamp of product grid conversion.","format":"double","type":"number"},"tag":{"description":"Unique tag for the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetType"}},"type":"object"},"StoreProductCollectionImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreImageWithTextContent"},"flexHeight":{"description":"Whether the height is flexible.","type":"boolean"},"mobileContent":{"$ref":"#/components/schemas/StoreMobileImageWithTextContent"},"uploadMobileImage":{"description":"Whether to upload a mobile-specific image.","type":"boolean"},"variation":{"$ref":"#/components/schemas/StoreImageWithTextTileVariation"}},"required":["commonProperties","variation"],"type":"object"},"StoreProductCollectionTile":{"oneOf":[{"properties":{"storeProductCollectionASINGrid":{"$ref":"#/components/schemas/StoreProductCollectionASINGrid"}},"required":["storeProductCollectionASINGrid"],"title":"storeProductCollectionASINGrid","type":"object"},{"properties":{"storeProductCollectionImageTile":{"$ref":"#/components/schemas/StoreProductCollectionImageTile"}},"required":["storeProductCollectionImageTile"],"title":"storeProductCollectionImageTile","type":"object"}]},"StoreProductCollectionWidget":{"properties":{"aiMetadata":{"description":"Metadata about AI generated fields.","items":{"$ref":"#/components/schemas/Tag"},"maxItems":1000,"minItems":0,"type":"array"},"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreProductCollectionContent"},"tiles":{"description":"The tiles for the product collection. Exactly two tiles are required.","items":{"$ref":"#/components/schemas/StoreProductCollectionTile"},"maxItems":2,"minItems":2,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreProductGridContent":{"properties":{"bulk":{"description":"Whether this is a bulk product grid.","type":"boolean"},"description":{"description":"Description of the product grid.","type":"string"},"displayProductGridHeader":{"description":"Whether to display the grid header.","type":"boolean"},"excludedProductAsins":{"description":"List of product ASINs exclude when dynamic.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"includeOutOfStock":{"description":"Whether to include out of stock products.","type":"boolean"},"isAutomatedProductGrid":{"description":"Whether the product grid is automatically populated","type":"boolean"},"keyword":{"description":"Keyword for product filtering.","type":"string"},"pinnedProductAsins":{"description":"List of product ASINs include when dynamic.","items":{"type":"string"},"maxItems":25,"minItems":0,"type":"array"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"productType":{"description":"Type of products to display","type":"string"},"search":{"$ref":"#/components/schemas/StoreProductGridSearch"},"showOnlyMarkdown":{"description":"Whether to only show products on markdown.","type":"boolean"},"sort":{"description":"Sort order for products.","type":"string"},"tag":{"description":"Unique tag for the content.","type":"string"},"title":{"description":"Title of the product grid.","type":"string"},"type":{"description":"Type of the content.","type":"string"}},"type":"object"},"StoreProductGridSearch":{"properties":{"brandId":{"description":"brand id to search.","type":"string"},"includeOutOfStock":{"description":"Whether to include out of stock products in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"sort":{"description":"Sort order for search results.","type":"string"}},"type":"object"},"StoreProductGridWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreProductGridContent"}},"required":["commonProperties","content"],"type":"object"},"StoreProductSelectorAnswer":{"description":"Represents a possible answer in the product selector questionnaire","properties":{"image":{"$ref":"#/components/schemas/StoreProductSelectorImage"},"nextStep":{"description":"Reference to the next question or step in the selection flow","type":"string"},"productAsins":{"description":"List of ASINs associated with this answer","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique identifier for the answer","type":"string"},"text":{"description":"Display text for the answer option","type":"string"}},"required":["nextStep","tag"],"type":"object"},"StoreProductSelectorButtonColor":{"description":"| StoreProductSelectorButtonColor | Description |\n|------|------|\n| `BLACK` | Black button color |\n| `TRANSPARENT` | Transparent button color |\n| `WHITE` | White button color |\n","enum":["BLACK","TRANSPARENT","WHITE"],"type":"string"},"StoreProductSelectorDesignOptions":{"description":"Visual styling options for the product selector widget","properties":{"backgroundColor":{"description":"Background color in hex or named color value","type":"string"},"backgroundShape":{"description":"Shape of the background container","type":"string"},"buttonColor":{"$ref":"#/components/schemas/StoreProductSelectorButtonColor"},"buttonShape":{"description":"Shape style for buttons in the selector","type":"string"},"textAlignment":{"description":"Alignment of text elements (left, center, right)","type":"string"},"textSize":{"description":"Size of the text elements","type":"string"},"textStyle":{"description":"Font family or style to be used","type":"string"},"textWeight":{"description":"Font weight for text elements","type":"string"}},"required":["backgroundColor","backgroundShape","buttonShape","textAlignment","textSize","textStyle","textWeight"],"type":"object"},"StoreProductSelectorImage":{"description":"Represents an image used in the product selector introduction","properties":{"assetId":{"description":"Asset ID of the image","type":"string"},"fileName":{"description":"File name of the image","type":"string"},"imageUrl":{"description":"URL of the image","type":"string"},"layout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"}},"required":["assetId","imageUrl"],"type":"object"},"StoreProductSelectorImageLayout":{"description":"| StoreProductSelectorImageLayout | Description |\n|------|------|\n| `BOTTOM` | Bottom image layout |\n| `LEFT` | Left image layout |\n| `RIGHT` | Right image layout |\n| `TOP` | Top image layout |\n","enum":["BOTTOM","LEFT","RIGHT","TOP"],"type":"string"},"StoreProductSelectorImageOptions":{"description":"Image options for the product selector introduction","properties":{"image":{"$ref":"#/components/schemas/StoreProductSelectorImage"},"layoutConfiguration":{"$ref":"#/components/schemas/StoreProductSelectorLayoutConfiguration"}},"required":["image","layoutConfiguration"],"type":"object"},"StoreProductSelectorIntroduction":{"description":"Introduction section for the product selector widget","properties":{"buttonText":{"description":"Text displayed on the introduction button","type":"string"},"description":{"description":"Description text for the introduction section","type":"string"},"heading":{"description":"Heading text for the introduction section","type":"string"},"headline":{"description":"Headline text for the introduction section","type":"string"},"imageOptions":{"$ref":"#/components/schemas/StoreProductSelectorImageOptions"},"isEnabled":{"description":"Flag indicating whether the introduction is enabled","type":"boolean"}},"required":["buttonText","description","heading","imageOptions","isEnabled"],"type":"object"},"StoreProductSelectorLayoutConfiguration":{"description":"Layout configuration for desktop and mobile views","properties":{"desktopLayout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"},"mobileLayout":{"$ref":"#/components/schemas/StoreProductSelectorImageLayout"}},"required":["desktopLayout","mobileLayout"],"type":"object"},"StoreProductSelectorQuestion":{"description":"Represents a question in the product selector questionnaire","properties":{"answerList":{"description":"List of possible answers for this question","items":{"$ref":"#/components/schemas/StoreProductSelectorAnswer"},"maxItems":500,"minItems":0,"type":"array"},"areImagesEnabled":{"description":"Flag indicating whether images are enabled","type":"boolean"},"description":{"description":"Additional descriptive text or context for the question","type":"string"},"hasImage":{"description":"Flag indicating whether the question has an image","type":"boolean"},"tag":{"description":"Unique identifier for the question","type":"string"},"text":{"description":"Main question text displayed to the user","type":"string"}},"required":["tag"],"type":"object"},"StoreProductSelectorResults":{"description":"Configuration for displaying product selector results","properties":{"buttonText":{"description":"Text to display on the call-to-action button","type":"string"},"description":{"description":"Descriptive text explaining the results","type":"string"},"disclaimer":{"description":"Legal or additional information text for the results","type":"string"},"headline":{"description":"Main heading text for the results section","type":"string"},"storeUrl":{"description":"URL to the store page for the selected products","type":"string"}},"required":["disclaimer","headline"],"type":"object"},"StoreProductSelectorWidget":{"description":"Main widget structure for the product selector feature","properties":{"designOptions":{"$ref":"#/components/schemas/StoreProductSelectorDesignOptions"},"introduction":{"$ref":"#/components/schemas/StoreProductSelectorIntroduction"},"productAsins":{"description":"Master list of ASINs available in the selector","items":{"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"questionList":{"description":"Ordered list of questions in the selector flow","items":{"$ref":"#/components/schemas/StoreProductSelectorQuestion"},"maxItems":500,"minItems":0,"type":"array"},"results":{"$ref":"#/components/schemas/StoreProductSelectorResults"}},"required":["designOptions","results"],"type":"object"},"StoreProductTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreProductTileContent"}},"required":["commonProperties"],"type":"object"},"StoreProductTileContent":{"properties":{"bleedImage":{"$ref":"#/components/schemas/StoreBleedImageType"},"displayOutOfStockASIN":{"description":"Whether to display out of stock ASIN.","type":"boolean"},"layout":{"$ref":"#/components/schemas/StoreLayoutType"},"productAsins":{"description":"Single ASIN for the product.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Description text for the product.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the product.","type":"string"}},"type":"object"},"StoreProductWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The product tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreProductTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StorePublishState":{"description":"User State for content\n\n| StorePublishState | Description |\n|------|------|\n| `DRAFT` | Content is in draft form |\n| `PUBLISH` | Submit Content to Publish to LIVE / SCHEDULED |\n","enum":["DRAFT","PUBLISH"],"type":"string"},"StorePublishStatus":{"description":"Status of content publish\n\n| StorePublishStatus | Description |\n|------|------|\n| `DRAFT` | Content is in draft state |\n| `REVIEW_IN_PROGRESS` | Content is pending publication for review |\n","enum":["DRAFT","REVIEW_IN_PROGRESS"],"type":"string"},"StoreShopTheLookContent":{"properties":{"bulk":{"description":"Whether this is a bulk configuration.","type":"boolean"},"callToActionData":{"$ref":"#/components/schemas/StoreCallToActionData"},"includeOutOfStock":{"description":"Whether to include out of stock items.","type":"boolean"},"keyword":{"description":"Keyword for searching.","type":"string"},"productAsins":{"description":"List of product ASINs, maximum 25 unique items.","items":{"type":"string"},"maxItems":25,"minItems":0,"type":"array"},"search":{"$ref":"#/components/schemas/StoreShopTheLookSearch"},"slides":{"description":"List of slides in the carousel.","items":{"$ref":"#/components/schemas/StoreShopTheLookSlide"},"maxItems":500,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the content.","type":"string"},"text":{"description":"Text content.","type":"string"},"title":{"description":"Title of the content.","type":"string"},"type":{"$ref":"#/components/schemas/StoreWidgetSectionType"}},"type":"object"},"StoreShopTheLookSearch":{"properties":{"includeOutOfStock":{"description":"Whether to include out of stock items in search.","type":"boolean"},"keyword":{"description":"Search keyword.","type":"string"},"node":{"description":"Node identifier for search.","type":"string"},"productAsins":{"description":"Single ASIN for search filtering.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"StoreShopTheLookSlide":{"oneOf":[{"properties":{"storeASINSlide":{"$ref":"#/components/schemas/StoreASINSlide"}},"required":["storeASINSlide"],"title":"storeASINSlide","type":"object"},{"properties":{"storeImageSlide":{"$ref":"#/components/schemas/StoreImageSlide"}},"required":["storeImageSlide"],"title":"storeImageSlide","type":"object"}]},"StoreShopTheLookWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"content":{"$ref":"#/components/schemas/StoreShopTheLookContent"}},"required":["commonProperties"],"type":"object"},"StoreShoppableImageContent":{"properties":{"croppedImage":{"$ref":"#/components/schemas/StoreCroppedImage"},"points":{"description":"Interactive points on the image.","items":{"$ref":"#/components/schemas/StoreShoppablePoint"},"maxItems":6,"minItems":0,"type":"array"},"productAsins":{"description":"Single ASIN for the point.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"textOption":{"$ref":"#/components/schemas/StoreShoppableTextOption"},"tileLayers":{"description":"Layer configuration for the tile.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"StoreShoppableImageTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreShoppableImageContent"}},"required":["commonProperties"],"type":"object"},"StoreShoppableImageWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The shoppable image tile configuration. Exactly one tile is required.","items":{"$ref":"#/components/schemas/StoreShoppableImageTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreShoppablePoint":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates"},"productAsins":{"description":"Single ASIN for the point.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"tag":{"description":"Unique tag for the point.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"required":["coordinates"],"type":"object"},"StoreShoppableTextOption":{"description":"| StoreShoppableTextOption | Description |\n|------|------|\n| `NO_TEXT_UNDER_INTERACTIVE_IMAGE` | No text under interactive image |\n| `TEXT_OVER_IMAGE` | Text over interactive image |\n| `TEXT_UNDER_INTERACTIVE_IMAGE` | Text under interactive image |\n","enum":["NO_TEXT_UNDER_INTERACTIVE_IMAGE","TEXT_OVER_IMAGE","TEXT_UNDER_INTERACTIVE_IMAGE"],"type":"string"},"StoreSlideType":{"description":"| StoreSlideType | Description |\n|------|------|\n| `ASIN` | Slide type for StoreASINSlide |\n| `IMAGE` | Slide type for StoreGallerySlide, StoreImageSlide |\n","enum":["ASIN","IMAGE"],"type":"string"},"StoreSpotlightCreativePropertiesToOptimize":{"description":"**StoreSpotlightCreativePropertiesToOptimize Enum:**\n\n| StoreSpotlightCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"StoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"StoreSpotlightLandingPageType":{"description":"**StoreSpotlightLandingPageType Enum:**\n\n| StoreSpotlightLandingPageType | Description |\n|------|------|\n| `STORE` | A brand Store landing page. |\n","enum":["STORE"],"type":"string"},"StoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/CardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/StoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"StoreTextAlignment":{"description":"| StoreTextAlignment | Description |\n|------|------|\n| `CENTER` | Center alignment |\n| `JUSTIFY` | Justified alignment |\n| `LEFT` | Left alignment. Default value configured for StoreEmptyTile |\n| `RIGHT` | Right alignment |\n","enum":["CENTER","JUSTIFY","LEFT","RIGHT"],"type":"string"},"StoreTextContent":{"properties":{"bold":{"description":"Whether text should be bold.","type":"boolean"},"bondCustomerServiceLink":{"description":"Whether to include customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"customUrl":{"description":"Custom URL for the content.","type":"string"},"pageId":{"description":"Identifier for the page.","type":"string"},"productAsins":{"description":"Single product ASIN for the content.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"text":{"description":"Main text content.","type":"string"},"textAlign":{"$ref":"#/components/schemas/StoreTextAlignment"},"title":{"description":"Title of the content.","type":"string"},"uppercase":{"description":"Whether text should be uppercase.","type":"boolean"}},"required":["bold","text","title","uppercase"],"type":"object"},"StoreTextOption":{"description":"| StoreTextOption | Description |\n|------|------|\n| `TEXT_NEXT_TO_IMAGE` | Text next to image |\n| `TEXT_OVER_IMAGE` | Text overlaid on image |\n","enum":["TEXT_NEXT_TO_IMAGE","TEXT_OVER_IMAGE"],"type":"string"},"StoreTextOptionType":{"description":"| StoreTextOptionType | Description |\n|------|------|\n| `NO_TEXT_OVER_VIDEO` | No text overlay on video |\n| `TEXT_OVER_VIDEO` | Text overlay on video |\n","enum":["NO_TEXT_OVER_VIDEO","TEXT_OVER_VIDEO"],"type":"string"},"StoreTextTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreTextContent"}},"required":["commonProperties"],"type":"object"},"StoreTextWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"Single text tile configuration.","items":{"$ref":"#/components/schemas/StoreTextTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreTile":{"oneOf":[{"properties":{"storeCustomCodeTile":{"$ref":"#/components/schemas/StoreCustomCodeTile"}},"required":["storeCustomCodeTile"],"title":"storeCustomCodeTile","type":"object"},{"properties":{"storeEmptyTile":{"$ref":"#/components/schemas/StoreEmptyTile"}},"required":["storeEmptyTile"],"title":"storeEmptyTile","type":"object"},{"properties":{"storeImageTile":{"$ref":"#/components/schemas/StoreImageTile"}},"required":["storeImageTile"],"title":"storeImageTile","type":"object"},{"properties":{"storeImageWithTextTile":{"$ref":"#/components/schemas/StoreImageWithTextTile"}},"required":["storeImageWithTextTile"],"title":"storeImageWithTextTile","type":"object"},{"properties":{"storeProductTile":{"$ref":"#/components/schemas/StoreProductTile"}},"required":["storeProductTile"],"title":"storeProductTile","type":"object"},{"properties":{"storeShoppableImageTile":{"$ref":"#/components/schemas/StoreShoppableImageTile"}},"required":["storeShoppableImageTile"],"title":"storeShoppableImageTile","type":"object"},{"properties":{"storeTextTile":{"$ref":"#/components/schemas/StoreTextTile"}},"required":["storeTextTile"],"title":"storeTextTile","type":"object"},{"properties":{"storeVideoTile":{"$ref":"#/components/schemas/StoreVideoTile"}},"required":["storeVideoTile"],"title":"storeVideoTile","type":"object"}]},"StoreTileBorderSize":{"description":"| StoreTileBorderSize | Description |\n|------|------|\n| `LARGE` | Large border size |\n| `MEDIUM` | Medium border size |\n| `NONE` | No border |\n| `SMALL` | Small border size |\n","enum":["LARGE","MEDIUM","NONE","SMALL"],"type":"string"},"StoreTileLayer":{"properties":{"colorPalette":{"$ref":"#/components/schemas/StoreColorPalette"},"content":{"$ref":"#/components/schemas/StoreTileLayerContent"},"coverTile":{"description":"Whether the layer covers the entire tile.","type":"boolean"},"margin":{"$ref":"#/components/schemas/StoreTileBorderSize"},"opacity":{"description":"Opacity level of the layer.","format":"double","type":"number"},"outOfBounds":{"description":"Whether the layer is out of bounds.","type":"boolean"},"padding":{"$ref":"#/components/schemas/StoreTileBorderSize"},"position":{"$ref":"#/components/schemas/StoreTilePosition"},"tag":{"description":"Unique tag for the tile layer to track performance.","type":"string"},"type":{"$ref":"#/components/schemas/StoreTileType"}},"type":"object"},"StoreTileLayerContent":{"properties":{"bodyText":{"description":"Body text for the layer.","type":"string"},"bondCustomerServiceLink":{"description":"Whether to include a customer service link.","type":"boolean"},"callToAction":{"description":"Call to action text for the layer.","type":"string"},"callToActionType":{"$ref":"#/components/schemas/StoreCallToActionType"},"customUrl":{"description":"Custom URL for the layer.","type":"string"},"headerText":{"description":"Header text for the layer.","type":"string"},"pageId":{"description":"Page identifier for the layer.","type":"string"},"prefixText":{"description":"Prefix text for the layer.","type":"string"},"productAsins":{"description":"Single ASIN for the layer.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"tileTextAlignment":{"$ref":"#/components/schemas/StoreTextAlignment"},"tileTextSize":{"$ref":"#/components/schemas/StoreTileTextSize"}},"type":"object"},"StoreTilePosition":{"properties":{"x":{"$ref":"#/components/schemas/HorizontalPosition"},"y":{"$ref":"#/components/schemas/VerticalPosition"}},"type":"object"},"StoreTileSize":{"description":"| StoreTileSize | Description |\n|------|------|\n| `LARGE` | Large tile size, StoreAWLSTile only uses LARGE |\n| `MEDIUM` | Medium tile size |\n| `MINI` | Mini tile size |\n| `SMALL` | Small tile size |\n","enum":["LARGE","MEDIUM","MINI","SMALL"],"type":"string"},"StoreTileTextSize":{"description":"| StoreTileTextSize | Description |\n|------|------|\n| `LARGE` | Large text size |\n| `MEDIUM` | Medium text size |\n| `MINI` | Mini text size |\n| `SMALL` | Small text size |\n","enum":["LARGE","MEDIUM","MINI","SMALL"],"type":"string"},"StoreTileType":{"description":"| StoreTileType | Description |\n|------|------|\n| `CUSTOM_CODE` | Tile type for StoreCustomCodeTile |\n| `EMPTY` | Tile type for StoreEmptyTile |\n| `EXTERNAL_WIDGET` | Tile type for StoreAWLSTile |\n| `IMAGE` | Tile type for StoreImageTile, StoreImageWithTextTile, StoreMetadataItem type |\n| `INTERACTIVE_IMAGE` | Tile type for StoreShoppableImageTile |\n| `PRODUCT` | Tile type for StoreProductTile and StoreShoppablePoint type |\n| `TEXT` | Tile type for StoreTextTile and tile layers |\n| `VIDEO` | Tile type for StoreVideoTile |\n","enum":["CUSTOM_CODE","EMPTY","EXTERNAL_WIDGET","IMAGE","INTERACTIVE_IMAGE","PRODUCT","TEXT","VIDEO"],"type":"string"},"StoreTileWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"rowHeight":{"description":"Height of the row in pixels.","format":"int32","type":"integer"},"tiles":{"description":"The tiles for the widget. Minimum 2 and maximum 8 tiles are allowed.","items":{"$ref":"#/components/schemas/StoreTile"},"maxItems":8,"minItems":2,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreVerticalAlign":{"description":"| StoreVerticalAlign | Description |\n|------|------|\n| `BOTTOM` | Bottom alignment |\n| `MIDDLE` | Middle alignment |\n| `TOP` | Top alignment |\n","enum":["BOTTOM","MIDDLE","TOP"],"type":"string"},"StoreVideoContent":{"properties":{"assetId":{"description":"Asset identifier.","type":"string"},"assetTags":{"description":"Tags associated with the asset.","type":"string"},"autoPlay":{"description":"Whether video should auto-play.","type":"boolean"},"callToAction":{"description":"Call to action text.","type":"string"},"canvasData":{"$ref":"#/components/schemas/StoreCanvasData"},"customUrl":{"description":"Custom URL for the content.","type":"string"},"imageHeight":{"description":"Height of the image.","format":"double","type":"number"},"imageKey":{"description":"Key for the image asset.","type":"string"},"imageOffsetLeft":{"description":"Left offset for image positioning.","format":"double","type":"number"},"imageOffsetTop":{"description":"Top offset for image positioning.","format":"double","type":"number"},"imageUrl":{"description":"URL of the image.","type":"string"},"imageWidth":{"description":"Width of the image.","format":"double","type":"number"},"mute":{"description":"Whether video should be muted.","type":"boolean"},"pageId":{"description":"Page identifier","type":"string"},"productAsins":{"description":"List of product ASINs.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"renderTileLayers":{"description":"Whether to render tile layers.","type":"boolean"},"resourceId":{"description":"Resource identifier.","type":"string"},"text":{"description":"Text content.","type":"string"},"textAlign":{"description":"Text alignment.","type":"string"},"textOption":{"$ref":"#/components/schemas/StoreTextOptionType"},"tileLayers":{"description":"Configuration for tile layers.","items":{"$ref":"#/components/schemas/StoreTileLayer"},"maxItems":1,"minItems":0,"type":"array"},"title":{"description":"Title of the content.","type":"string"},"videoAssetId":{"description":"Video asset identifier.","type":"string"},"videoAssetTags":{"description":"Tags associated with the video asset.","type":"string"},"videoDescription":{"description":"Description of the video.","type":"string"},"videoKey":{"description":"Key for the video asset.","type":"string"},"videoName":{"description":"Name of the video.","type":"string"},"videoSize":{"description":"Size of the video in bytes.","format":"double","type":"number"},"videoUrl":{"description":"URL of the video.","type":"string"}},"type":"object"},"StoreVideoRevealVRVideo":{"description":"Configuration for a single video reveal video asset","properties":{"assetId":{"description":"Unique identifier for the video asset","type":"string"},"url":{"description":"URL of the video content","type":"string"}},"required":["assetId","url"],"type":"object"},"StoreVideoRevealVideos":{"description":"Collection of video assets for different device types","properties":{"desktop":{"$ref":"#/components/schemas/StoreVideoRevealVRVideo"},"mobile":{"$ref":"#/components/schemas/StoreVideoRevealVRVideo"}},"required":["desktop","mobile"],"type":"object"},"StoreVideoRevealWidget":{"description":"Main widget structure for the video reveal feature","properties":{"backgroundColor":{"description":"Background color (CSS property)","type":"string"},"csmTag":{"description":"CSM tracking tag for the video reveal","type":"string"},"fadeoutDuration":{"description":"Fadeout duration (in ms)","type":"string"},"objectFit":{"description":"Object fit (CSS property)","type":"string"},"skipReveal":{"description":"Skip reveal (to be used in development only)","type":"boolean"},"throttleLimit":{"description":"Play video every X minutes","type":"string"},"videos":{"$ref":"#/components/schemas/StoreVideoRevealVideos"}},"required":["backgroundColor","csmTag","fadeoutDuration","objectFit","skipReveal","throttleLimit","videos"],"type":"object"},"StoreVideoTile":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonTileProperties"},"content":{"$ref":"#/components/schemas/StoreVideoContent"}},"required":["commonProperties"],"type":"object"},"StoreVideoWidget":{"properties":{"commonProperties":{"$ref":"#/components/schemas/CommonWidgetProperties"},"tiles":{"description":"The content configuration for the video widget.","items":{"$ref":"#/components/schemas/StoreVideoTile"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commonProperties","tiles"],"type":"object"},"StoreWidgetSectionType":{"description":"| StoreWidgetSectionType | Description |\n|------|------|\n| `BANNER` | Section type for StoreBannerWidget |\n| `BEST_SELLING` | Section type for StoreProductCarouselWidget and StoreProductCarouselContent type |\n| `DEALS_AND_COUPONS` | Section type for StoreDealsWidget and StoreDealsContent type |\n| `EDITORIAL_ROW` | Widget type for StoreCustomCodeWidget, StoreImageWithTextWidget, StoreImageWidget, StoreProductWidget, StoreShoppableImageWidget, StoreTextWidget, StoreTileWidget, StoreVideoWidget and StoreAWLSWidget |\n| `GALLERY` | Section type for StoreGalleryWidget |\n| `HERO` | Section type for StoreHeroImageWidget |\n| `LIVE_VIDEO` | Section type for StoreLiveVideoWidget |\n| `MANUALLY_CURATED_PRODUCT_CAROUSEL` | Section type for StoreManuallyCuratedProductCarouselWidget and StoreCarouselContent type |\n| `PREMIUM_BEST_SELLING` | Section type for StoreProductCarouselWidget and StoreProductCarouselContent type |\n| `PRODUCT_COLLECTION` | Section type for StoreProductCollectionWidget |\n| `PRODUCT_GRID` | Section type for StoreProductGridWidget and type for StoreProductCollectionASINGrid |\n| `RECOMMENDED` | Section type for StoreProductCarouselWidget and StoreProductCarouselContent type |\n| `SHOP_THE_LOOK_CAROUSEL` | Section type for StoreShopTheLookWidget and type for StoreShopTheLookContent |\n","enum":["BANNER","BEST_SELLING","DEALS_AND_COUPONS","EDITORIAL_ROW","GALLERY","HERO","LIVE_VIDEO","MANUALLY_CURATED_PRODUCT_CAROUSEL","PREMIUM_BEST_SELLING","PRODUCT_COLLECTION","PRODUCT_GRID","RECOMMENDED","SHOP_THE_LOOK_CAROUSEL"],"type":"string"},"StoreWidgetType":{"description":"| StoreWidgetType | Description |\n|------|------|\n| `BANNER` | Widget type and content type for StoreBannerWidget |\n| `EDITORIAL_ROW` | Widget type for StoreCustomCodeWidget, StoreImageWithTextWidget, StoreImageWidget, StoreProductWidget, StoreShoppableImageWidget, StoreTextWidget, StoreTileWidget, StoreVideoWidget and StoreAWLSWidget |\n| `GALLERY` | Widget type for StoreGalleryWidget and StoreGalleryContent type |\n| `HERO` | Widget type for StoreHeroImageWidget |\n| `LIVE_VIDEO` | Widget type and content type for StoreLiveVideoWidget |\n| `MULTI_MEDIA_CAROUSEL` | Widget type for StoreShopTheLookWidget, StoreManuallyCuratedProductCarouselWidget and StoreProductCarouselWidget |\n| `PRODUCT_CAROUSEL` | Widget type for StoreProductCarouselWidget |\n| `PRODUCT_COLLECTION` | Widget type for StoreProductCollectionWidget and StoreProductCollection type |\n| `PRODUCT_GRID` | Widget type for StoreProductGridWidget and StoreDealsWidget |\n","enum":["BANNER","EDITORIAL_ROW","GALLERY","HERO","LIVE_VIDEO","MULTI_MEDIA_CAROUSEL","PRODUCT_CAROUSEL","PRODUCT_COLLECTION","PRODUCT_GRID"],"type":"string"},"StreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/VideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/VideoLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/Video"}},"required":["videos"],"type":"object"},"Supplier":{"properties":{"domain":{"description":"Corporate SCO domain in sellers.json supply chain object (e.g., pubmatic.com).","type":"string"},"integrationType":{"$ref":"#/components/schemas/IntegrationType"},"owner":{"description":"Parent owner company name of the Supplier. Defaults to brand name if unspecified.","type":"string"},"state":{"$ref":"#/components/schemas/SupplierState"},"supplierId":{"description":"The unique identifier of the supplier (Long serialized as String).","type":"string"},"supplierName":{"description":"Canonical display name of the Supplier. Normalized across systems.","type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"}},"required":["supplierId","supplierName"],"type":"object"},"SupplierIntegrationTypeFilter":{"properties":{"include":{"description":"**IntegrationType Enum:**\n| IntegrationType | Description |\n| --- | --- |\n| `DIRECT` | Supplier is directly integrated with ADSP via OpenRTB. |\n| `BIDSWITCH` | Supplier routes inventory through BidSwitch as an intermediary. |","items":{"$ref":"#/components/schemas/IntegrationType"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierSellerTargetingEntry":{"description":"A supplier seller targeting entry. All entries must share the same negative value.","properties":{"groupId":{"description":"Identifies the group this entry belongs to. Entries sharing the same groupId are OR\u0027d together.","type":"string"},"negative":{"description":"When true, this entry is a negative (exclusion) target. Defaults to false when omitted.","type":"boolean"},"supplierSellerId":{"description":"The supplier seller to target.","type":"string"}},"required":["groupId","supplierSellerId"],"type":"object"},"SupplierSortOption":{"properties":{"by":{"$ref":"#/components/schemas/SupplierSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"SupplierSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| supplierName | ASCENDING,DESCENDING |","enum":["supplierName"],"type":"string"},"SupplierState":{"description":"**SupplierState Enum:**\n| SupplierState | Description |\n| --- | --- |\n| `CREATED` | Supplier record created but not yet in testing. |\n| `TESTING` | Integration is in testing or onboarding phase. |\n| `ACTIVE` | Supplier is live and sending production traffic to ADSP. |\n| `INACTIVE` | Supplier integration has been disabled or deprecated. |","enum":["ACTIVE","CREATED","INACTIVE","TESTING"],"type":"string"},"SupplierSuccessResponse":{"properties":{"nextToken":{"type":"string"},"suppliers":{"items":{"$ref":"#/components/schemas/Supplier"},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"SupplierSupplierIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierSupplierNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SupplierSupplierNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SupplierSupplierNameFilterType":{"description":"**SupplierSupplierNameFilterType Enum:**\n| SupplierSupplierNameFilterType | Description |\n| --- | --- |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH"],"type":"string"},"SupplierSupplierStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `CREATED` | Supplier record created but not yet in testing. |\n| `TESTING` | Integration is in testing or onboarding phase. |\n| `ACTIVE` | Supplier is live and sending production traffic to ADSP. |\n| `INACTIVE` | Supplier integration has been disabled or deprecated. |","items":{"$ref":"#/components/schemas/SupplierState"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierSupplierTypeFilter":{"properties":{"include":{"description":"**Type Enum:**\n| Type | Description |\n| --- | --- |\n| `THIRD_PARTY_EXCHANGE` | External SSP/exchange (Magnite, PubMatic, Index Exchange, etc.). |\n| `AMAZON_PUBLISHER_SERVICES` | Amazon Publisher Services - first-party header bidding supply. |\n| `PUBTECH` | Amazon PubTech - Amazon-owned O\u0026O publisher supply. |\n| `DIRECT` | Direct deal integration with no SSP intermediary. |","items":{"$ref":"#/components/schemas/SupplierType"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierType":{"description":"**SupplierType Enum:**\n| SupplierType | Description |\n| --- | --- |\n| `THIRD_PARTY_EXCHANGE` | External SSP/exchange (Magnite, PubMatic, Index Exchange, etc.). |\n| `AMAZON_PUBLISHER_SERVICES` | Amazon Publisher Services - first-party header bidding supply. |\n| `PUBTECH` | Amazon PubTech - Amazon-owned O\u0026O publisher supply. |\n| `DIRECT` | Direct deal integration with no SSP intermediary. |","enum":["AMAZON_PUBLISHER_SERVICES","DIRECT","PUBTECH","THIRD_PARTY_EXCHANGE"],"type":"string"},"SupportedThirdPartySellers":{"enum":["ALL","NONE"],"type":"string"},"TacticKey":{"description":"A tactic type paired with its compatible inventory type","properties":{"primaryInventoryType":{"$ref":"#/components/schemas/PrimaryInventoryType"},"tacticType":{"$ref":"#/components/schemas/AutomatedTargetingTactic"}},"required":["primaryInventoryType","tacticType"],"type":"object"},"TacticsConvertersExclusionType":{"description":"**TacticsConvertersExclusionType Enum:**\n\n| TacticsConvertersExclusionType | Description |\n|------|------|\n| `NO_EXCLUSION` | Do not exclude any converters from targeting. |\n| `RECENT_CONVERTERS` | Exclude recent converters from targeting to focus on new customers. |\n","enum":["NO_EXCLUSION","RECENT_CONVERTERS"],"type":"string"},"Tag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"Target":{"properties":{"adGroupId":{"description":"A unique identifier for the ad group associated with the target. Only used for ad-group level targets.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"bid":{"$ref":"#/components/schemas/TargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"creationDateTime":{"description":"The date time the target was created.","format":"date-time","type":"string"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"lastUpdatedDateTime":{"description":"The date time the target was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceTargetConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global target is applicable. The marketplaces included should either be same as or subset of parent campaign/ad group","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/TargetDetails"},"targetId":{"description":"A unique identifier for the target.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/TargetLevel"},"targetType":{"$ref":"#/components/schemas/TargetType"}},"required":["adProduct","creationDateTime","lastUpdatedDateTime","negative","state","targetDetails","targetId","targetType"],"type":"object"},"TargetAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"marketplaceSettings":{"description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/TargetBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"TargetBidMarketplaceSetting":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["currencyCode","marketplace"],"type":"object"},"TargetCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetCreate":{"properties":{"adGroupId":{"description":"A unique identifier for the ad group associated with the target. Only used for ad-group level targets.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"bid":{"$ref":"#/components/schemas/CreateTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceTargetConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global target is applicable. The marketplaces included should either be same as or subset of parent campaign/ad group","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/CreateTargetDetails"},"targetType":{"$ref":"#/components/schemas/TargetType"}},"required":["adProduct","negative","state","targetDetails","targetType"],"type":"object"},"TargetDetails":{"oneOf":[{"properties":{"adInitiationTarget":{"$ref":"#/components/schemas/AdInitiationTarget"}},"required":["adInitiationTarget"],"title":"adInitiationTarget","type":"object"},{"properties":{"adPlayerSizeTarget":{"$ref":"#/components/schemas/AdPlayerSizeTarget"}},"required":["adPlayerSizeTarget"],"title":"adPlayerSizeTarget","type":"object"},{"properties":{"appTarget":{"$ref":"#/components/schemas/AppTarget"}},"required":["appTarget"],"title":"appTarget","type":"object"},{"properties":{"audienceTarget":{"$ref":"#/components/schemas/AudienceTarget"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"brandSafetyCategoryTarget":{"$ref":"#/components/schemas/BrandSafetyCategoryTarget"}},"required":["brandSafetyCategoryTarget"],"title":"brandSafetyCategoryTarget","type":"object"},{"properties":{"brandSafetyTierTarget":{"$ref":"#/components/schemas/BrandSafetyTierTarget"}},"required":["brandSafetyTierTarget"],"title":"brandSafetyTierTarget","type":"object"},{"properties":{"contentCategoryTarget":{"$ref":"#/components/schemas/ContentCategoryTarget"}},"required":["contentCategoryTarget"],"title":"contentCategoryTarget","type":"object"},{"properties":{"contentGenreTarget":{"$ref":"#/components/schemas/ContentGenreTarget"}},"required":["contentGenreTarget"],"title":"contentGenreTarget","type":"object"},{"properties":{"contentInstreamPositionTarget":{"$ref":"#/components/schemas/ContentInstreamPositionTarget"}},"required":["contentInstreamPositionTarget"],"title":"contentInstreamPositionTarget","type":"object"},{"properties":{"contentOutstreamPositionTarget":{"$ref":"#/components/schemas/ContentOutstreamPositionTarget"}},"required":["contentOutstreamPositionTarget"],"title":"contentOutstreamPositionTarget","type":"object"},{"properties":{"contentRatingTarget":{"$ref":"#/components/schemas/ContentRatingTarget"}},"required":["contentRatingTarget"],"title":"contentRatingTarget","type":"object"},{"properties":{"dayPartTarget":{"$ref":"#/components/schemas/DayPartTarget"}},"required":["dayPartTarget"],"title":"dayPartTarget","type":"object"},{"properties":{"deviceTarget":{"$ref":"#/components/schemas/DeviceTarget"}},"required":["deviceTarget"],"title":"deviceTarget","type":"object"},{"properties":{"domainTarget":{"$ref":"#/components/schemas/DomainTarget"}},"required":["domainTarget"],"title":"domainTarget","type":"object"},{"properties":{"foldPositionTarget":{"$ref":"#/components/schemas/FoldPositionTarget"}},"required":["foldPositionTarget"],"title":"foldPositionTarget","type":"object"},{"properties":{"inventorySourceTarget":{"$ref":"#/components/schemas/InventorySourceTarget"}},"required":["inventorySourceTarget"],"title":"inventorySourceTarget","type":"object"},{"properties":{"keywordTarget":{"$ref":"#/components/schemas/KeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/LocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"nativeContentPositionTarget":{"$ref":"#/components/schemas/NativeContentPositionTarget"}},"required":["nativeContentPositionTarget"],"title":"nativeContentPositionTarget","type":"object"},{"properties":{"placementTypeTarget":{"$ref":"#/components/schemas/PlacementTypeTarget"}},"required":["placementTypeTarget"],"title":"placementTypeTarget","type":"object"},{"properties":{"productAudienceTarget":{"$ref":"#/components/schemas/ProductAudienceTarget"}},"required":["productAudienceTarget"],"title":"productAudienceTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/ProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/ProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/ThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"},{"properties":{"thirdPartyTarget":{"$ref":"#/components/schemas/ThirdPartyTarget"}},"required":["thirdPartyTarget"],"title":"thirdPartyTarget","type":"object"},{"properties":{"videoAdFormatTarget":{"$ref":"#/components/schemas/VideoAdFormatTarget"}},"required":["videoAdFormatTarget"],"title":"videoAdFormatTarget","type":"object"},{"properties":{"videoContentDurationTarget":{"$ref":"#/components/schemas/VideoContentDurationTarget"}},"required":["videoContentDurationTarget"],"title":"videoContentDurationTarget","type":"object"}]},"TargetEvent":{"description":"**TargetEvent Enum:**\n\n| TargetEvent | Description |\n|------|------|\n| `PURCHASE` | A product purchase event. |\n| `VIEW` | A product view event. |\n","enum":["PURCHASE","VIEW"],"type":"string"},"TargetInventorySourceTypeFilter":{"properties":{"include":{"description":"**InventorySourceType Enum:**\n| InventorySourceType | Description |\n| --- | --- |\n| `AMAZON` | Amazon-owned inventory. |\n| `APD` | Amazon Publisher Direct inventory. |\n| `THIRD_PARTY_EXCHANGE` | Third-party exchange inventory. |\n| `DEAL` | Deal-based inventory. |\n| `INVENTORY_GROUP` | A group representing a set of inventories. |","items":{"$ref":"#/components/schemas/InventorySourceType"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetKeywordFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/TargetKeywordFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"TargetKeywordFilterType":{"description":"**TargetKeywordFilterType Enum:**\n| TargetKeywordFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"TargetLanguageLocaleFilter":{"properties":{"include":{"description":"**NativeLanguageLocale Enum:**\n| NativeLanguageLocale | Description |\n| --- | --- |\n| `aa_ET` | Afar (Ethiopia). |\n| `ab_GE` | Abkhazian (Georgia). |\n| `ae_INT` | Avestan (International). |\n| `af_ZA` | Afrikaans (South Africa). |\n| `ak_GH` | Akan (Ghana). |\n| `am_ET` | Amharic (Ethiopia). |\n| `an_ES` | Aragonese (Spain). |\n| `ar_AE` | Arabic (UAE). |\n| `as_IN` | Assamese (India). |\n| `av_RU` | Avaric (Russia). |\n| `ay_BO` | Aymara (Bolivia). |\n| `az_AZ` | Azerbaijani (Azerbaijan). |\n| `ba_RU` | Bashkir (Russia). |\n| `be_BY` | Belarusian (Belarus). |\n| `bg_BG` | Bulgarian (Bulgaria). |\n| `bh_IN` | Bihari (India). |\n| `bi_VU` | Bislama (Vanuatu). |\n| `bm_ML` | Bambara (Mali). |\n| `bn_BD` | Bengali (Bangladesh). |\n| `bo_CN` | Tibetan (China). |\n| `br_FR` | Breton (France). |\n| `bs_BA` | Bosnian (Bosnia and Herzegovina). |\n| `ca_ES` | Catalan (Spain). |\n| `ce_RU` | Chechen (Russia). |\n| `ch_GU` | Chamorro (Guam). |\n| `co_FR` | Corsican (France). |\n| `cr_CA` | Cree (Canada). |\n| `cs_CZ` | Czech (Czech Republic). |\n| `cu_INT` | Church Slavonic (International). |\n| `cv_RU` | Chuvash (Russia). |\n| `cy_GB` | Welsh (United Kingdom). |\n| `da_DK` | Danish (Denmark). |\n| `de_DE` | German (Germany). |\n| `dv_MV` | Divehi (Maldives). |\n| `dz_BT` | Dzongkha (Bhutan). |\n| `ee_GH` | Ewe (Ghana). |\n| `el_GR` | Greek (Greece). |\n| `en_US` | English (United States). |\n| `eo_INT` | Esperanto (International). |\n| `es_ES` | Spanish (Spain). |\n| `et_EE` | Estonian (Estonia). |\n| `eu_ES` | Basque (Spain). |\n| `fa_IR` | Persian (Iran). |\n| `ff_SN` | Fulah (Senegal). |\n| `fi_FI` | Finnish (Finland). |\n| `fj_FJ` | Fijian (Fiji). |\n| `fo_FO` | Faroese (Faroe Islands). |\n| `fr_FR` | French (France). |\n| `fy_NL` | Western Frisian (Netherlands). |\n| `ga_IE` | Irish (Ireland). |\n| `gd_GB` | Scottish Gaelic (United Kingdom). |\n| `gl_ES` | Galician (Spain). |\n| `gn_PY` | Guarani (Paraguay). |\n| `gu_IN` | Gujarati (India). |\n| `gv_IM` | Manx (Isle of Man). |\n| `ha_NG` | Hausa (Nigeria). |\n| `he_IL` | Hebrew (Israel). |\n| `hi_IN` | Hindi (India). |\n| `ho_PG` | Hiri Motu (Papua New Guinea). |\n| `hr_HR` | Croatian (Croatia). |\n| `ht_HT` | Haitian Creole (Haiti). |\n| `hu_HU` | Hungarian (Hungary). |\n| `hy_AM` | Armenian (Armenia). |\n| `hz_NA` | Herero (Namibia). |\n| `ia_INT` | Interlingua (International). |\n| `id_ID` | Indonesian (Indonesia). |\n| `ie_INT` | Interlingue (International). |\n| `ig_NG` | Igbo (Nigeria). |\n| `ii_CN` | Sichuan Yi (China). |\n| `ik_US` | Inupiaq (United States). |\n| `io_INT` | Ido (International). |\n| `is_IS` | Icelandic (Iceland). |\n| `it_IT` | Italian (Italy). |\n| `iu_CA` | Inuktitut (Canada). |\n| `iw_IL` | Hebrew (Israel). |\n| `ja_JP` | Japanese (Japan). |\n| `ji_IL` | Yiddish (Israel). |\n| `jv_ID` | Javanese (Indonesia). |\n| `ka_GE` | Georgian (Georgia). |\n| `kg_CD` | Kongo (Democratic Republic of the Congo). |\n| `ki_KE` | Kikuyu (Kenya). |\n| `kj_NA` | Kwanyama (Namibia). |\n| `kk_KZ` | Kazakh (Kazakhstan). |\n| `kl_GL` | Kalaallisut (Greenland). |\n| `km_KH` | Khmer (Cambodia). |\n| `kn_IN` | Kannada (India). |\n| `ko_KR` | Korean (South Korea). |\n| `kr_NG` | Kanuri (Nigeria). |\n| `ks_IN` | Kashmiri (India). |\n| `ku_TR` | Kurdish (Turkey). |\n| `kv_RU` | Komi (Russia). |\n| `kw_GB` | Cornish (United Kingdom). |\n| `ky_KG` | Kyrgyz (Kyrgyzstan). |\n| `la_VA` | Latin (Vatican City). |\n| `lb_LU` | Luxembourgish (Luxembourg). |\n| `lg_UG` | Ganda (Uganda). |\n| `li_NL` | Limburgish (Netherlands). |\n| `ln_CD` | Lingala (Democratic Republic of the Congo). |\n| `lo_LA` | Lao (Laos). |\n| `lt_LT` | Lithuanian (Lithuania). |\n| `lu_CD` | Luba-Katanga (Democratic Republic of the Congo). |\n| `lv_LV` | Latvian (Latvia). |\n| `mg_MG` | Malagasy (Madagascar). |\n| `mh_MH` | Marshallese (Marshall Islands). |\n| `mi_NZ` | Māori (New Zealand). |\n| `mk_MK` | Macedonian (North Macedonia). |\n| `ml_IN` | Malayalam (India). |\n| `mn_MN` | Mongolian (Mongolia). |\n| `mo_MD` | Moldavian (Moldova). |\n| `mr_IN` | Marathi (India). |\n| `ms_MY` | Malay (Malaysia). |\n| `mt_MT` | Maltese (Malta). |\n| `my_MM` | Burmese (Myanmar). |\n| `na_NR` | Nauru (Nauru). |\n| `nb_NO` | Norwegian Bokmål (Norway). |\n| `nd_ZW` | North Ndebele (Zimbabwe). |\n| `ne_NP` | Nepali (Nepal). |\n| `ng_NA` | Ndonga (Namibia). |\n| `nl_NL` | Dutch (Netherlands). |\n| `nn_NO` | Norwegian Nynorsk (Norway). |\n| `no_NO` | Norwegian (Norway). |\n| `nr_ZA` | South Ndebele (South Africa). |\n| `nv_US` | Navajo (United States). |\n| `ny_MW` | Chichewa (Malawi). |\n| `oc_FR` | Occitan (France). |\n| `oj_CA` | Ojibwa (Canada). |\n| `om_ET` | Oromo (Ethiopia). |\n| `or_IN` | Oriya (India). |\n| `os_RU` | Ossetian (Russia). |\n| `pa_IN` | Punjabi (India). |\n| `pi_IN` | Pali (India). |\n| `pl_PL` | Polish (Poland). |\n| `ps_AF` | Pashto (Afghanistan). |\n| `pt_PT` | Portuguese (Portugal). |\n| `qu_PE` | Quechua (Peru). |\n| `rm_CH` | Romansh (Switzerland). |\n| `rn_BI` | Kirundi (Burundi). |\n| `ro_RO` | Romanian (Romania). |\n| `ru_RU` | Russian (Russia). |\n| `rw_RW` | Kinyarwanda (Rwanda). |\n| `sa_IN` | Sanskrit (India). |\n| `sc_IT` | Sardinian (Italy). |\n| `sd_PK` | Sindhi (Pakistan). |\n| `se_NO` | Northern Sami (Norway). |\n| `sg_CF` | Sango (Central African Republic). |\n| `si_LK` | Sinhala (Sri Lanka). |\n| `sk_SK` | Slovak (Slovakia). |\n| `sl_SI` | Slovenian (Slovenia). |\n| `sm_WS` | Samoan (Samoa). |\n| `sn_ZW` | Shona (Zimbabwe). |\n| `so_SO` | Somali (Somalia). |\n| `sq_AL` | Albanian (Albania). |\n| `sr_RS` | Serbian (Serbia). |\n| `ss_SZ` | Swati (Eswatini). |\n| `st_LS` | Southern Sotho (Lesotho). |\n| `su_ID` | Sundanese (Indonesia). |\n| `sv_SE` | Swedish (Sweden). |\n| `sw_TZ` | Swahili (Tanzania). |\n| `ta_IN` | Tamil (India). |\n| `te_IN` | Telugu (India). |\n| `tg_TJ` | Tajik (Tajikistan). |\n| `th_TH` | Thai (Thailand). |\n| `ti_ET` | Tigrinya (Ethiopia). |\n| `tk_TM` | Turkmen (Turkmenistan). |\n| `tl_PH` | Tagalog (Philippines). |\n| `tn_BW` | Tswana (Botswana). |\n| `to_TO` | Tonga (Tonga). |\n| `tr_TR` | Turkish (Turkey). |\n| `ts_ZA` | Tsonga (South Africa). |\n| `tt_RU` | Tatar (Russia). |\n| `tw_GH` | Twi (Ghana). |\n| `ty_PF` | Tahitian (French Polynesia). |\n| `ug_CN` | Uyghur (China). |\n| `uk_UA` | Ukrainian (Ukraine). |\n| `ur_PK` | Urdu (Pakistan). |\n| `uz_UZ` | Uzbek (Uzbekistan). |\n| `ve_ZA` | Venda (South Africa). |\n| `vi_VN` | Vietnamese (Vietnam). |\n| `vo_INT` | Volapük (International). |\n| `wa_BE` | Walloon (Belgium). |\n| `wo_SN` | Wolof (Senegal). |\n| `xh_ZA` | Xhosa (South Africa). |\n| `yi_IL` | Yiddish (Israel). |\n| `yo_NG` | Yoruba (Nigeria). |\n| `za_CN` | Zhuang (China). |\n| `zh_CN` | Chinese (China). |\n| `zu_ZA` | Zulu (South Africa). |","items":{"$ref":"#/components/schemas/LanguageLocale"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetLevel":{"description":"**TargetLevel Enum:**\n\n| TargetLevel | Description |\n|------|------|\n| `AD_GROUP` | Target applied at the ad group level. |\n| `CAMPAIGN` | Target applied at the campaign level. |\n","enum":["AD_GROUP","CAMPAIGN"],"type":"string"},"TargetMarketplaceScopeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetMarketplaceStringValueFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceStringValue"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetMatchTypeFilter":{"properties":{"include":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_REMARKETING` | Products to target users who have previously interacted with the specified product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `PRODUCT_COMPLEMENTS` |  |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","items":{"$ref":"#/components/schemas/MatchType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/TargetPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/TargetMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"TargetMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/Target"}},"required":["index","target"],"type":"object"},"TargetNegativeFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetPartialIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/Target"}},"required":["errors","index","target"],"type":"object"},"TargetProductIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/TargetProductIdFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"TargetProductIdFilterType":{"description":"**TargetProductIdFilterType Enum:**\n| TargetProductIdFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"TargetStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetSuccessResponse":{"properties":{"nextToken":{"type":"string"},"targets":{"items":{"$ref":"#/components/schemas/Target"},"maxItems":5000,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"TargetTargetIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetTargetTypeFilter":{"properties":{"include":{"description":"**TargetType Enum:**\n| TargetType | Description |\n| --- | --- |\n| `KEYWORD` | Target based on customer search terms. |\n| `PRODUCT` | Target based on a specific product. |\n| `PRODUCT_CATEGORY` | Target based on a product category. |\n| `PRODUCT_AUDIENCE` | Target customers who interacted with a specific product. |\n| `AUDIENCE` | Target based on an audience segment. |\n| `LOCATION` | Target based on geographic location. |\n| `DOMAIN` | Target based on a domain. |\n| `APP` | Target based on an application. |\n| `DEVICE` | Target based on device type. |\n| `DAYPART` | Target based on time of day and day of week. |\n| `CONTENT_CATEGORY` | Target based on content category. |\n| `CONTENT_GENRE` | Target based on content genre. |\n| `CONTENT_RATING` | Target based on content rating. |\n| `BRAND_SAFETY_TIER` | Target based on brand suitability tier. |\n| `BRAND_SAFETY_CATEGORY` | Target based on brand safety category. |\n| `INVENTORY_SOURCE` | Target based on inventory source. |\n| `AD_INITIATION` | Target based on how the video ad is initiated. |\n| `AD_PLAYER_SIZE` | Target based on video player size. |\n| `VIDEO_AD_FORMAT` | Target based on video ad format. This is an older function being replaced by newer targets for instream and outstream targets. |\n| `THIRD_PARTY` | Target based on third-party data. |\n| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |\n| `CONTENT_INSTREAM_POSITION` | Target based on instream ad position. |\n| `CONTENT_OUTSTREAM_POSITION` | Target based on outstream ad position. |\n| `VIDEO_CONTENT_DURATION` | Target based on video content duration. |\n| `FOLD_POSITION` | Target based on above or below the fold placement. |\n| `NATIVE_CONTENT_POSITION` | Target based on native content position. |\n| `PLACEMENT_TYPE` | Target based on placement type. |","items":{"$ref":"#/components/schemas/TargetType"},"maxItems":17,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"TargetType":{"description":"**TargetType Enum:**\n\n| TargetType | Description |\n|------|------|\n| `AD_INITIATION` | Target based on how the video ad is initiated. |\n| `AD_PLAYER_SIZE` | Target based on video player size. |\n| `APP` | Target based on an application. |\n| `AUDIENCE` | Target based on an audience segment. |\n| `BRAND_SAFETY_CATEGORY` | Target based on brand safety category. |\n| `BRAND_SAFETY_TIER` | Target based on brand suitability tier. |\n| `CONTENT_CATEGORY` | Target based on content category. |\n| `CONTENT_GENRE` | Target based on content genre. |\n| `CONTENT_INSTREAM_POSITION` | Target based on instream ad position. |\n| `CONTENT_OUTSTREAM_POSITION` | Target based on outstream ad position. |\n| `CONTENT_RATING` | Target based on content rating. |\n| `DAYPART` | Target based on time of day and day of week. |\n| `DEVICE` | Target based on device type. |\n| `DOMAIN` | Target based on a domain. |\n| `FOLD_POSITION` | Target based on above or below the fold placement. |\n| `INVENTORY_SOURCE` | Target based on inventory source. |\n| `KEYWORD` | Target based on customer search terms. |\n| `LOCATION` | Target based on geographic location. |\n| `NATIVE_CONTENT_POSITION` | Target based on native content position. |\n| `PLACEMENT_TYPE` | Target based on placement type. |\n| `PRODUCT_AUDIENCE` | Target customers who interacted with a specific product. |\n| `PRODUCT_CATEGORY` | Target based on a product category. |\n| `PRODUCT` | Target based on a specific product. |\n| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |\n| `THIRD_PARTY` | Target based on third-party data. |\n| `VIDEO_AD_FORMAT` | Target based on video ad format. This is an older function being replaced by newer targets for instream and outstream targets. |\n| `VIDEO_CONTENT_DURATION` | Target based on video content duration. |\n","enum":["AD_INITIATION","AD_PLAYER_SIZE","APP","AUDIENCE","BRAND_SAFETY_CATEGORY","BRAND_SAFETY_TIER","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_INSTREAM_POSITION","CONTENT_OUTSTREAM_POSITION","CONTENT_RATING","DAYPART","DEVICE","DOMAIN","FOLD_POSITION","INVENTORY_SOURCE","KEYWORD","LOCATION","NATIVE_CONTENT_POSITION","PLACEMENT_TYPE","PRODUCT","PRODUCT_AUDIENCE","PRODUCT_CATEGORY","THEME","THIRD_PARTY","VIDEO_AD_FORMAT","VIDEO_CONTENT_DURATION"],"type":"string"},"TargetUpdate":{"properties":{"bid":{"$ref":"#/components/schemas/UpdateTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceTargetConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global target is applicable. The marketplaces included should either be same as or subset of parent campaign/ad group","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetId":{"description":"A unique identifier for the target.","type":"string"}},"required":["targetId"],"type":"object"},"TargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/AmazonViewability"},"automatedTargetingTactic":{"$ref":"#/components/schemas/AutomatedTargetingTactic"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"siteLanguage":{"$ref":"#/components/schemas/SiteLanguage"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionType"},"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/TimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTier"}},"required":["amazonViewability","timeZoneType","userLocationSignal"],"type":"object"},"ThemeMatchType":{"description":"**ThemeMatchType Enum:**\n\n| ThemeMatchType | Description |\n|------|------|\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n","enum":["INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_SUBSTITUTES"],"type":"string"},"ThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/ThemeMatchType"}},"required":["matchType"],"type":"object"},"ThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/ThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/ThirdPartyVideoSettings"}},"type":"object"},"ThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["adChoicesPosition","language"],"type":"object"},"ThirdPartyTarget":{"properties":{"thirdPartyTargetDetails":{"$ref":"#/components/schemas/ThirdPartyTargetDetails"},"thirdPartyTargetType":{"$ref":"#/components/schemas/ThirdPartyTargetType"}},"required":["thirdPartyTargetDetails","thirdPartyTargetType"],"type":"object"},"ThirdPartyTargetDetails":{"oneOf":[{"properties":{"doubleVerifyAuthenticAttention":{"$ref":"#/components/schemas/DoubleVerifyAuthenticAttention"}},"required":["doubleVerifyAuthenticAttention"],"title":"doubleVerifyAuthenticAttention","type":"object"},{"properties":{"doubleVerifyAuthenticBrandSafety":{"$ref":"#/components/schemas/DoubleVerifyAuthenticBrandSafety"}},"required":["doubleVerifyAuthenticBrandSafety"],"title":"doubleVerifyAuthenticBrandSafety","type":"object"},{"properties":{"doubleVerifyBrandSafety":{"$ref":"#/components/schemas/DoubleVerifyBrandSafety"}},"required":["doubleVerifyBrandSafety"],"title":"doubleVerifyBrandSafety","type":"object"},{"properties":{"doubleVerifyCustomContextualSegmentId":{"$ref":"#/components/schemas/DoubleVerifyCustomContextualSegmentId"}},"required":["doubleVerifyCustomContextualSegmentId"],"title":"doubleVerifyCustomContextualSegmentId","type":"object"},{"properties":{"doubleVerifyFraudInvalidTraffic":{"$ref":"#/components/schemas/DoubleVerifyFraudInvalidTraffic"}},"required":["doubleVerifyFraudInvalidTraffic"],"title":"doubleVerifyFraudInvalidTraffic","type":"object"},{"properties":{"doubleVerifyStandardDisplayBrandSafety":{"$ref":"#/components/schemas/DoubleVerifyStandardDisplayBrandSafety"}},"required":["doubleVerifyStandardDisplayBrandSafety"],"title":"doubleVerifyStandardDisplayBrandSafety","type":"object"},{"properties":{"doubleVerifyViewability":{"$ref":"#/components/schemas/DoubleVerifyViewability"}},"required":["doubleVerifyViewability"],"title":"doubleVerifyViewability","type":"object"},{"properties":{"integralAdScienceBrandSafety":{"$ref":"#/components/schemas/IntegralAdScienceBrandSafety"}},"required":["integralAdScienceBrandSafety"],"title":"integralAdScienceBrandSafety","type":"object"},{"properties":{"integralAdScienceContextualAvoidance":{"$ref":"#/components/schemas/IntegralAdScienceContextualAvoidance"}},"required":["integralAdScienceContextualAvoidance"],"title":"integralAdScienceContextualAvoidance","type":"object"},{"properties":{"integralAdScienceContextualTargeting":{"$ref":"#/components/schemas/IntegralAdScienceContextualTargeting"}},"required":["integralAdScienceContextualTargeting"],"title":"integralAdScienceContextualTargeting","type":"object"},{"properties":{"integralAdScienceFraudInvalidTraffic":{"$ref":"#/components/schemas/IntegralAdScienceFraudInvalidTraffic"}},"required":["integralAdScienceFraudInvalidTraffic"],"title":"integralAdScienceFraudInvalidTraffic","type":"object"},{"properties":{"integralAdScienceQualitySync":{"$ref":"#/components/schemas/IntegralAdScienceQualitySync"}},"required":["integralAdScienceQualitySync"],"title":"integralAdScienceQualitySync","type":"object"},{"properties":{"integralAdScienceViewability":{"$ref":"#/components/schemas/IntegralAdScienceViewability"}},"required":["integralAdScienceViewability"],"title":"integralAdScienceViewability","type":"object"},{"properties":{"newsGuardBrandGuardMisinformationSafety":{"$ref":"#/components/schemas/NewsGuardBrandGuardMisinformationSafety"}},"required":["newsGuardBrandGuardMisinformationSafety"],"title":"newsGuardBrandGuardMisinformationSafety","type":"object"},{"properties":{"newsGuardBrandGuardTrustedNewsTargeting":{"$ref":"#/components/schemas/NewsGuardBrandGuardTrustedNewsTargeting"}},"required":["newsGuardBrandGuardTrustedNewsTargeting"],"title":"newsGuardBrandGuardTrustedNewsTargeting","type":"object"},{"properties":{"pixalateFraudInvalidTraffic":{"$ref":"#/components/schemas/PixalateFraudInvalidTraffic"}},"required":["pixalateFraudInvalidTraffic"],"title":"pixalateFraudInvalidTraffic","type":"object"}]},"ThirdPartyTargetType":{"description":"**ThirdPartyTargetType Enum:**\n\n| ThirdPartyTargetType | Description |\n|------|------|\n| `DOUBLE_VERIFY_AUTHENTIC_ATTENTION` |  |\n| `DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID` |  |\n| `DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC` |  |\n| `DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY` |  |\n| `DOUBLE_VERIFY_VIEWABILITY` |  |\n| `INTEGRAL_AD_SCIENCE_BRAND_SAFETY` |  |\n| `INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE` |  |\n| `INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING` |  |\n| `INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC` |  |\n| `INTEGRAL_AD_SCIENCE_QUALITY_SYNC` | Integral Ad Science (IAS) Quality |\n| `INTEGRAL_AD_SCIENCE_VIEWABILITY` |  |\n| `NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY` | NewsGuard Misinformation Safety. NewsGuard is a rating system for news and information websites. |\n| `NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING` | NewsGuard Trusted News Targeting. NewsGuard is a rating system for news and information websites. |\n| `PIXALATE_FRAUD_INVALID_TRAFFIC` |  |\n","enum":["DOUBLE_VERIFY_AUTHENTIC_ATTENTION","DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY","DOUBLE_VERIFY_BRAND_SAFETY","DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID","DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC","DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY","DOUBLE_VERIFY_VIEWABILITY","INTEGRAL_AD_SCIENCE_BRAND_SAFETY","INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE","INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING","INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC","INTEGRAL_AD_SCIENCE_QUALITY_SYNC","INTEGRAL_AD_SCIENCE_VIEWABILITY","NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY","NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING","PIXALATE_FRAUD_INVALID_TRAFFIC"],"type":"string"},"ThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["language"],"type":"object"},"TierAdjustment":{"description":"An ordinal adjustment that expresses a ranked preference level rather than a specific numeric value.","properties":{"adjustmentType":{"$ref":"#/components/schemas/TierAdjustmentType"}},"required":["adjustmentType"],"type":"object"},"TierAdjustmentType":{"enum":["DECREASE","DEFAULT","INCREASE"],"type":"string"},"TimeOfDay":{"properties":{"endTime":{"description":"Selected end time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"},"startTime":{"description":"Selected start time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"}},"required":["endTime","startTime"],"type":"object"},"TimeUnit":{"enum":["DAYS","HOURS","MINUTES"],"type":"string"},"TimeZoneIana":{"description":"Each enum member is in the IANA Time Zone Database\n**TimeZoneIana Enum:**\n\n| TimeZoneIana | Description |\n|------|------|\n| `America/Anchorage` | Alaska Time Zone (UTC-09:00) |\n| `America/Caracas` | Venezuela Time Zone (UTC-04:00) |\n| `America/Chicago` | Central Time Zone (UTC-06:00) |\n| `America/Denver` | Mountain Time Zone (UTC-07:00) |\n| `America/Halifax` | Atlantic Time Zone (UTC-04:00) |\n| `America/Los_Angeles` | Pacific Time Zone (UTC-08:00) |\n| `America/Mexico_City` | Central Mexico Time Zone (UTC-06:00) |\n| `America/New_York` | Eastern Time Zone (UTC-05:00) |\n| `America/Sao_Paulo` | Brasilia Time Zone (UTC-03:00) |\n| `America/St_Johns` | Newfoundland Time Zone (UTC-03:30) |\n| `Asia/Almaty` | Kazakhstan Time Zone (UTC+06:00) |\n| `Asia/Baghdad` | Arabian Time Zone (UTC+03:00) |\n| `Asia/Bangkok` | Indochina Time Zone (UTC+07:00) |\n| `Asia/Dubai` | Gulf Time Zone (UTC+04:00) |\n| `Asia/Hong_Kong` | Hong Kong Time Zone (UTC+08:00) |\n| `Asia/Kabul` | Afghanistan Time Zone (UTC+04:30) |\n| `Asia/Kathmandu` | Nepal Time Zone (UTC+05:45) |\n| `Asia/Kolkata` | India Time Zone (UTC+05:30) |\n| `Asia/Magadan` | Magadan Time Zone (UTC+11:00) |\n| `Asia/Riyadh` | Saudi Arabia Time Zone (UTC+03:00) |\n| `Asia/Shanghai` | China Time Zone (UTC+08:00) |\n| `Asia/Singapore` | Singapore Time Zone (UTC+08:00) |\n| `Asia/Tehran` | Iran Time Zone (UTC+03:30) |\n| `Asia/Tokyo` | Japan Time Zone (UTC+09:00) |\n| `Asia/Yekaterinburg` | Yekaterinburg Time Zone (UTC+05:00) |\n| `Asia/Yerevan` | Armenia Time Zone (UTC+04:00) |\n| `Atlantic/Azores` | Azores Time Zone (UTC-01:00) |\n| `Atlantic/South_Georgia` | South Georgia Time Zone (UTC-02:00) |\n| `Australia/Brisbane` | Australian Eastern Time Zone (UTC+10:00) |\n| `Australia/Darwin` | Australian Central Time Zone (UTC+09:30) |\n| `Australia/Sydney` | Australian Eastern Time Zone (UTC+10:00/+11:00) |\n| `EET` | Eastern European Time Zone (UTC+02:00) |\n| `Europe/Amsterdam` | Central European Time Zone (UTC+01:00) |\n| `Europe/Istanbul` | Turkey Time Zone (UTC+03:00) |\n| `Europe/London` | British Time Zone (UTC+00:00) |\n| `Europe/Paris` | Central European Time Zone (UTC+01:00) |\n| `Europe/Stockholm` | Central European Time Zone (UTC+01:00) |\n| `Indian/Cocos` | Cocos Islands Time Zone (UTC+06:30) |\n| `Pacific/Auckland` | New Zealand Time Zone (UTC+12:00/+13:00) |\n| `Pacific/Fiji` | Fiji Time Zone (UTC+12:00) |\n| `Pacific/Honolulu` | Hawaii Time Zone (UTC-10:00) |\n| `Pacific/Kwajalein` | Marshall Islands Time Zone (UTC+12:00) |\n| `Pacific/Midway` | Samoa Time Zone (UTC-11:00) |\n","enum":["America/Anchorage","America/Caracas","America/Chicago","America/Denver","America/Halifax","America/Los_Angeles","America/Mexico_City","America/New_York","America/Sao_Paulo","America/St_Johns","Asia/Almaty","Asia/Baghdad","Asia/Bangkok","Asia/Dubai","Asia/Hong_Kong","Asia/Kabul","Asia/Kathmandu","Asia/Kolkata","Asia/Magadan","Asia/Riyadh","Asia/Shanghai","Asia/Singapore","Asia/Tehran","Asia/Tokyo","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/South_Georgia","Australia/Brisbane","Australia/Darwin","Australia/Sydney","EET","Europe/Amsterdam","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Indian/Cocos","Pacific/Auckland","Pacific/Fiji","Pacific/Honolulu","Pacific/Kwajalein","Pacific/Midway"],"type":"string","x-enum-varnames":["AMERICA_ANCHORAGE","AMERICA_CARACAS","AMERICA_CHICAGO","AMERICA_DENVER","AMERICA_HALIFAX","AMERICA_LOS_ANGELES","AMERICA_MEXICO_CITY","AMERICA_NEW_YORK","AMERICA_SAO_PAULO","AMERICA_ST_JOHNS","ASIA_ALMATY","ASIA_BAGHDAD","ASIA_BANGKOK","ASIA_DUBAI","ASIA_HONG_KONG","ASIA_KABUL","ASIA_KATHMANDU","ASIA_KOLKATA","ASIA_MAGADAN","ASIA_RIYADH","ASIA_SHANGHAI","ASIA_SINGAPORE","ASIA_TEHRAN","ASIA_TOKYO","ASIA_YEKATERINBURG","ASIA_YEREVAN","ATLANTIC_AZORES","ATLANTIC_SOUTH_GEORGIA","AUSTRALIA_BRISBANE","AUSTRALIA_DARWIN","AUSTRALIA_SYDNEY","EET","EUROPE_AMSTERDAM","EUROPE_ISTANBUL","EUROPE_LONDON","EUROPE_PARIS","EUROPE_STOCKHOLM","INDIAN_COCOS","PACIFIC_AUCKLAND","PACIFIC_FIJI","PACIFIC_HONOLULU","PACIFIC_KWAJALEIN","PACIFIC_MIDWAY"]},"TimeZoneType":{"description":"**TimeZoneType Enum:**\n\n| TimeZoneType | Description |\n|------|------|\n| `ADVERTISER_REGION` | Use the advertiser\u0027s regional time zone for daypart targeting. |\n| `VIEWER` | Use the viewer\u0027s local time zone for daypart targeting. |\n","enum":["ADVERTISER_REGION","VIEWER"],"type":"string"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TwitchContentRating":{"properties":{"twitchContentRating":{"$ref":"#/components/schemas/TwitchContentRatingEnum"}},"required":["twitchContentRating"],"type":"object"},"TwitchContentRatingEnum":{"description":"**TwitchContentRatingEnum Enum:**\n\n| TwitchContentRatingEnum | Description |\n|------|------|\n| `TWITCH_MODERATE` | Twitch Content with moderate content exclusions based on content classification labels received from Twitch. |\n| `TWITCH_RESTRICTIVE` | Twitch Content with restrictive content exlcusions based on content classification labels received from Twitch. |\n","enum":["TWITCH_MODERATE","TWITCH_RESTRICTIVE"],"type":"string"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UpdateAccountCombinationInvitationRequest":{"properties":{"accountCombinationInvitations":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitationUpdate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["accountCombinationInvitations"],"type":"object"},"UpdateAdAssociationRequest":{"properties":{"adAssociations":{"items":{"$ref":"#/components/schemas/AdAssociationUpdate"},"maxItems":20,"minItems":1,"type":"array"}},"required":["adAssociations"],"type":"object"},"UpdateAdExtensionRequest":{"properties":{"adExtensions":{"items":{"$ref":"#/components/schemas/AdExtensionUpdate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["adExtensions"],"type":"object"},"UpdateAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group.","format":"double","type":"number"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"},"marketplaceSettings":{"description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateAdGroupBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"maxAverageBid":{"description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number).","format":"double","nullable":true,"type":"number"}},"type":"object"},"UpdateAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"UpdateAdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"}},"type":"object"},"UpdateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/AdGroupUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"UpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/AdUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"UpdateAdSettings":{"properties":{"productAttributeSetRefinementConfigurationId":{"description":"Identifier for the product attribute configuration set associated with this ad group.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"type":"object"},"UpdateAddress":{"description":"The business address of advertising account.","format":"password","properties":{"addressLine1":{"description":"The address details - 1 of business.","type":"string"},"addressLine2":{"description":"The address details - 2 of business.","type":"string"},"businessName":{"description":"The name of business.","type":"string"},"city":{"description":"The city where business is located.","type":"string"},"countryCode":{"description":"The country where business is located.","type":"string"},"phoneNumber":{"description":"The phone number of business.","type":"string"},"state":{"description":"The city where business is located.","type":"string"},"zipCode":{"description":"The zipCode where business is located.","type":"string"}},"type":"object"},"UpdateAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/UpdateGlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateAdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"type":"object"},"UpdateAdvertiserAccountRequest":{"properties":{"advertiserAccounts":{"items":{"$ref":"#/components/schemas/AdvertiserAccountUpdate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["advertiserAccounts"],"type":"object"},"UpdateAdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"priceType":{"$ref":"#/components/schemas/AdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"type":"object"},"UpdateAdvertisingDealRequest":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/AdvertisingDealUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["advertisingDeals"],"type":"object"},"UpdateAdvertisingDealTerms":{"description":"Terms for a deal. Supports PA \u0026 PD deals along with both spend-based guarantees (standard PG) and share-of-voice based guarantees (PG-SOV).","properties":{"budget":{"$ref":"#/components/schemas/UpdateMonetaryBudget"},"price":{"$ref":"#/components/schemas/UpdateAdvertisingDealPrice"}},"type":"object"},"UpdateAmazonViewability":{"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/ViewabilityTier"}},"type":"object"},"UpdateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"UpdateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateAssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/UpdateVideo"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"UpdateAudio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"type":"object"},"UpdateAudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"UpdateAudioCreative":{"description":"| UpdateAudioCreative | Description |\n| --- | --- |\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/UpdateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"UpdateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/UpdateSharedCollectionSettings"}},"type":"object"},"UpdateBidAdjustments":{"properties":{"audienceBidAdjustments":{"description":"Bid Adjustments based on the audiences","items":{"$ref":"#/components/schemas/CreateAudienceBidAdjustment"},"maxItems":1,"minItems":0,"type":"array"},"creativeBidAdjustments":{"description":"Bid Adjustments based on ads being shown as a creative. Range of bid adjustment value would be 0:900","items":{"$ref":"#/components/schemas/CreateCreativeBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"},"placementBidAdjustments":{"description":"Bid adjustments based on ad placements. Not supported for Sponsored Brands campaigns using the SALES_UP_AND_DOWN bid strategy.","items":{"$ref":"#/components/schemas/CreatePlacementBidAdjustment"},"maxItems":4,"minItems":0,"type":"array"},"shopperSegmentBidAdjustments":{"description":"Legacy SB field (marked for deprecation)","items":{"$ref":"#/components/schemas/CreateShopperSegmentBidAdjustment"},"maxItems":2,"minItems":0,"type":"array"}},"type":"object"},"UpdateBidSettings":{"properties":{"bidAdjustments":{"$ref":"#/components/schemas/UpdateBidAdjustments"},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"}},"type":"object"},"UpdateBrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/CreateBrandGalleryCardCreativeElement"},"maxItems":5,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/BrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateStoreSpotlightLandingPage"}},"type":"object"},"UpdateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/UpdateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"UpdateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateBrandStoreEditionPublishVersionRequest":{"properties":{"brandStoreEditionPublishVersions":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionUpdate"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"UpdateBrandStorePageRequest":{"properties":{"brandStorePages":{"items":{"$ref":"#/components/schemas/BrandStorePageUpdate"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"UpdateBrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/UpdateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/UpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"UpdateBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocation"},"flightBudgetRolloverStrategy":{"$ref":"#/components/schemas/RolloverStrategy"},"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/OffAmazonBudgetControlStrategy"}},"type":"object"},"UpdateBusinessDetail":{"description":"The business details of advertising account.","format":"password","properties":{"address":{"$ref":"#/components/schemas/UpdateAddress"},"addressToken":{"description":"The token of the business address being linked.","type":"string"},"businessRegistrationNumber":{"description":"The business registration number of the business.","type":"string"},"website":{"description":"The website of the business.","type":"string"}},"type":"object"},"UpdateCampaignOptimizations":{"properties":{"bidSettings":{"$ref":"#/components/schemas/UpdateBidSettings"},"budgetSettings":{"$ref":"#/components/schemas/UpdateBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/UpdateGoalSettings"},"primaryInventoryTypes":{"description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"$ref":"#/components/schemas/PrimaryInventoryType"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["campaigns"],"type":"object"},"UpdateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"type":"object"},"UpdateClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"type":"object"},"UpdateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"type":"object"},"UpdateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/UpdateAutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/UpdateBrandGallerySettings"},"brandStoreSettings":{"$ref":"#/components/schemas/UpdateBrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/UpdateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/UpdateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/UpdateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/UpdateResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/UpdateStoreSpotlightSettings"}},"type":"object"},"UpdateConstituentIndexValues":{"properties":{"values":{"description":"List of brand and category sales values.","items":{"$ref":"#/components/schemas/CreateConstituentIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"type":"object"},"UpdateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/UpdateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/UpdateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/UpdateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/UpdateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/UpdateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/UpdateProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"}]},"UpdateCreativeRequirements":{"description":"Creative requirements associated with the deal.","type":"object"},"UpdateDirectIndexValues":{"properties":{"values":{"description":"List of direct index values.","items":{"$ref":"#/components/schemas/CreateDirectIndexValue"},"maxItems":1000000,"minItems":1,"type":"array"}},"type":"object"},"UpdateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"UpdateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/UpdateStandardDisplaySettings"}},"type":"object"},"UpdateGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"UpdateGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/KPI"},"kpiValue":{"description":"The value of the KPI that the campaign is working to optimize.","format":"double","nullable":true,"type":"number"}},"type":"object"},"UpdateImage":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/CreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateIndexValues":{"oneOf":[{"properties":{"directIndexValues":{"$ref":"#/components/schemas/UpdateDirectIndexValues"}},"required":["directIndexValues"],"title":"directIndexValues","type":"object"},{"properties":{"constituentIndexValues":{"$ref":"#/components/schemas/UpdateConstituentIndexValues"}},"required":["constituentIndexValues"],"title":"constituentIndexValues","type":"object"}]},"UpdateLandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"UpdateLocationIndexRequest":{"properties":{"locationIndexes":{"items":{"$ref":"#/components/schemas/LocationIndexUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["locationIndexes"],"type":"object"},"UpdateManagerAccountRequest":{"properties":{"managerAccounts":{"items":{"$ref":"#/components/schemas/ManagerAccountUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["managerAccounts"],"type":"object"},"UpdateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/UpdateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/UpdateSharedCollectionSettings"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","type":"string"}},"type":"object"},"UpdateMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"type":"object"},"UpdateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/UpdateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/UpdateVideo"}},"type":"object"},"UpdateOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/UpdateAdGroupBudgetSettings"},"goalSettings":{"$ref":"#/components/schemas/UpdateAdGroupGoalSettings"}},"type":"object"},"UpdatePacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DeliveryProfile"}},"type":"object"},"UpdateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/UpdateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"type":"object"},"UpdateProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"type":"object"},"UpdateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/UpdateProductCreativeSettings"}},"type":"object"},"UpdateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/UpdateAdvertisedProducts"},"spotlightVideos":{"$ref":"#/components/schemas/UpdateSpotlightVideoSettings"}},"type":"object"},"UpdateProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":2,"minItems":1,"type":"array"}},"type":"object"},"UpdateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/UpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"}},"type":"object"},"UpdateRuleDuration":{"description":"Duration defined by a start and end date. startDateTime and endDateTime are ReadOnly if calendarEvent is also provided in duration.","properties":{"endDateTime":{"description":"The end date time for the rule.","format":"date-time","type":"string"},"startDateTime":{"description":"The start date time for the rule.","format":"date-time","type":"string"}},"type":"object"},"UpdateRuleRequest":{"properties":{"rules":{"items":{"$ref":"#/components/schemas/RuleUpdate"},"maxItems":1,"minItems":1,"type":"array"}},"required":["rules"],"type":"object"},"UpdateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/UpdateImage"}},"type":"object"},"UpdateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"UpdateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/UpdateAudio"},"callToActions":{"$ref":"#/components/schemas/UpdateAudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/UpdateImage"},"headlines":{"description":"The headline(s) to use for the standard audio experience. Headlines must be a maximum of 20 characters.","type":"string"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/UpdateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"type":"object"},"UpdateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**UpdateState Enum:**\n\n| UpdateState | Description |\n|------|------|\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n","enum":["ENABLED","PAUSED"],"type":"string"},"UpdateStorePageContent":{"description":"Structure containing the content elements of a store page","properties":{"description":{"description":"Description of the page","type":"string"},"template":{"$ref":"#/components/schemas/StorePageTemplate"},"title":{"description":"For store page, title of the page; for SB landing page, this can be optional","type":"string"},"widgets":{"description":"Collection of widgets displayed on the page","items":{"$ref":"#/components/schemas/CreateStorePageWidget"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"UpdateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"UpdateStoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/CreateCardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/StoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateStoreSpotlightLandingPage"}},"type":"object"},"UpdateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/UpdateVideo"}},"type":"object"},"UpdateTargetBid":{"nullable":true,"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","nullable":true,"type":"number"},"marketplaceSettings":{"description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"$ref":"#/components/schemas/CreateTargetBidMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"UpdateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"UpdateTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/UpdateAmazonViewability"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/TacticsConvertersExclusionType"},"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/TimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/VideoCompletionTier"}},"type":"object"},"UpdateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/UpdateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/UpdateThirdPartyVideoSettings"}},"type":"object"},"UpdateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"type":"object"},"UpdateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"type":"object"},"UpdateVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"type":"object"},"UpdateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/UpdateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/UpdateStreamingTvSettings"}},"type":"object"},"UpdateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"UserLocationSignal":{"description":"**UserLocationSignal Enum:**\n\n| UserLocationSignal | Description |\n|------|------|\n| `CURRENT` | Target users based on their current geographic location. |\n| `MULTIPLE_SIGNALS` | Target users based on multiple location signals. |\n","enum":["CURRENT","MULTIPLE_SIGNALS"],"type":"string"},"ValueAdjustment":{"properties":{"adjustmentType":{"$ref":"#/components/schemas/AdjustmentTypes"},"adjustmentValue":{"format":"double","type":"number"}},"required":["adjustmentType","adjustmentValue"],"type":"object"},"VerticalPosition":{"description":"| VerticalPosition | Description |\n|------|------|\n| `BOTTOM` | Bottom position |\n| `MIDDLE` | Middle position |\n| `TOP` | Top position |\n","enum":["BOTTOM","MIDDLE","TOP"],"type":"string"},"Video":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"VideoAdFormat":{"description":"**VideoAdFormat Enum:**\n\n| VideoAdFormat | Description |\n|------|------|\n| `FULL_EPISODE_PLAYER` | Video ad plays within a full episode player. |\n| `INSTREAM` | Video ad plays within streaming video content. |\n| `OUTSTREAM` | Video ad plays outside of streaming video content. |\n","enum":["FULL_EPISODE_PLAYER","INSTREAM","OUTSTREAM"],"type":"string"},"VideoAdFormatTarget":{"description":"Target based on the video ad format.","properties":{"videoAdFormat":{"$ref":"#/components/schemas/VideoAdFormat"}},"required":["videoAdFormat"],"type":"object"},"VideoCallToAction":{"oneOf":[{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/LearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"VideoCallToActionPosition":{"enum":["LEFT","MINIMAL","RIGHT"],"type":"string"},"VideoCompletionTier":{"description":"**VideoCompletionTier Enum:**\n\n| VideoCompletionTier | Description |\n|------|------|\n| `ALL_TIERS` | Target all video completion tiers. |\n| `GREATER_THAN_10_PERCENT` | Target videos with greater than 10% predicted completion rate. |\n| `GREATER_THAN_20_PERCENT` | Target videos with greater than 20% predicted completion rate. |\n| `GREATER_THAN_30_PERCENT` | Target videos with greater than 30% predicted completion rate. |\n| `GREATER_THAN_40_PERCENT` | Target videos with greater than 40% predicted completion rate. |\n| `GREATER_THAN_50_PERCENT` | Target videos with greater than 50% predicted completion rate. |\n| `GREATER_THAN_60_PERCENT` | Target videos with greater than 60% predicted completion rate. |\n| `GREATER_THAN_70_PERCENT` | Target videos with greater than 70% predicted completion rate. |\n| `GREATER_THAN_80_PERCENT` | Target videos with greater than 80% predicted completion rate. |\n| `GREATER_THAN_90_PERCENT` | Target videos with greater than 90% predicted completion rate. |\n","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"},"VideoContentDuration":{"description":"**VideoContentDuration Enum:**\n\n| VideoContentDuration | Description |\n|------|------|\n| `EXTENDED` | Video content duration of 60+ minutes |\n| `LONG` | Video content duration of 30 to 60 minutes |\n| `MEDIUM` | Video content duration of 10 to 30 minutes |\n| `SHORT` | Video content duration of 0 to 10 minutes |\n| `UNKNOWN` | Unknown video content duration |\n","enum":["EXTENDED","LONG","MEDIUM","SHORT","UNKNOWN"],"type":"string"},"VideoContentDurationTarget":{"description":"Targets ads to a specific video content duration","properties":{"duration":{"$ref":"#/components/schemas/VideoContentDuration"}},"required":["duration"],"type":"object"},"VideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/OnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/StreamingTvSettings"}},"type":"object"},"VideoExtension":{"description":"Video Ad Extension","properties":{"renderedAssetId":{"description":"The video asset ID rendered in the ad.","type":"string"},"renderedCoverImageUrl":{"description":"The image displayed over the video player before the video is played.","type":"string"},"videoType":{"$ref":"#/components/schemas/VideoType"}},"required":["videoType"],"type":"object"},"VideoInitiationType":{"description":"**VideoInitiationType Enum:**\n\n| VideoInitiationType | Description |\n|------|------|\n| `AUTOPLAY` | Video ad starts automatically without user action. |\n| `UNKNOWN` | Unknown video initiation type. |\n| `USER_INITIATED` | Video ad started by user action such as a click. |\n","enum":["AUTOPLAY","UNKNOWN","USER_INITIATED"],"type":"string"},"VideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"VideoLandingPageType":{"description":"**VideoLandingPageType Enum:**\n\n| VideoLandingPageType | Description |\n|------|------|\n| `DETAIL_PAGE` | A product detail page. |\n| `MOMENT` | A moment landing page. |\n| `OFF_AMAZON_LINK` | An off-Amazon landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["DETAIL_PAGE","MOMENT","OFF_AMAZON_LINK","STORE"],"type":"string"},"VideoType":{"description":"Video Type: Video type of the asset added in the ad extension and its rendering form.\n**VideoType Enum:**\n\n| VideoType | Description |\n|------|------|\n| `SPOTLIGHT` | SPOTLIGHT Video Asset. |\n","enum":["SPOTLIGHT"],"type":"string"},"ViewabilityTier":{"description":"**ViewabilityTier Enum:**\n\n| ViewabilityTier | Description |\n|------|------|\n| `ALL_TIERS` | Target all viewability tiers with no filtering. |\n| `GREATER_THAN_40_PERCENT` | Target impressions with greater than 40% predicted viewability. |\n| `GREATER_THAN_50_PERCENT` | Target impressions with greater than 50% predicted viewability. |\n| `GREATER_THAN_60_PERCENT` | Target impressions with greater than 60% predicted viewability. |\n| `GREATER_THAN_70_PERCENT` | Target impressions with greater than 70% predicted viewability. |\n| `LESS_THAN_40_PERCENT` | Target impressions with less than 40% predicted viewability. |\n","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"},"ViewabilityTierType":{"description":"The type of viewability tier.\n\n\n\n\n\n","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_LT_40"],"type":"string"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Advertising API","title":"Amazon Ads API ALL Merged","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/brandStoreEditions":{"get":{"description":"Retrieve brand store page content\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"ListBrandStoreEdition","parameters":[{"$ref":"#/components/parameters/BrandStoreIdQuery"},{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionSuccessResponse"}}},"description":"ListBrandStoreEdition 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStoreEditions"]}},"/adsApi/v1/create/accountCombinationInvitations":{"post":{"description":"Create an invitation to combine Advertising Accounts under a Single Global Account. Currently supports combining a Global SA account with one or more DSP Accounts\n\n**Requires one of these permissions**:\n[]","operationId":"CreateAccountCombinationInvitation","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountCombinationInvitationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCombinationInvitationMultiStatusResponse"}}},"description":"CreateAccountCombinationInvitation 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AccountCombinationInvitations"]}},"/adsApi/v1/create/adAssociations":{"post":{"description":"Create Ad Association\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdAssociationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationMultiStatusResponse"}}},"description":"CreateAdAssociation 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdAssociations"]}},"/adsApi/v1/create/adExtensions":{"post":{"description":"Create ad extensions - API is in open beta\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdExtensionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdExtensionMultiStatusResponseWithPartialErrors"}}},"description":"CreateAdExtension 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdExtensions"]}},"/adsApi/v1/create/adGroups":{"post":{"description":"Create ad groups\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"CreateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMultiStatusResponseWithPartialErrors"}}},"description":"CreateAdGroup 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdGroups"]}},"/adsApi/v1/create/ads":{"post":{"description":"Create ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_edit\"]","operationId":"CreateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"CreateAd 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Ads"]}},"/adsApi/v1/create/advertiserAccounts":{"post":{"description":"Create advertiser accounts\n\n**Requires one of these permissions**:\n[]","operationId":"CreateAdvertiserAccount","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdvertiserAccountRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertiserAccountMultiStatusResponse"}}},"description":"CreateAdvertiserAccount 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertiserAccounts"]}},"/adsApi/v1/create/advertiserProductGroupEligibilities":{"post":{"description":"Create request for specific advertiser product group eligibility\n\n**Requires one of these permissions**:\n[\"account_edit\", \"MasterAccount_Manager\"]","operationId":"CreateAdvertiserProductGroupEligibility","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdvertiserProductGroupEligibilityRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibilityMultiStatusResponse"}}},"description":"CreateAdvertiserProductGroupEligibility 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertiserProductGroupEligibilities"]}},"/adsApi/v1/create/advertisingDeals":{"post":{"description":"Create advertising deals\n\n**Requires one of these permissions**:\n[\"inventory_edit\", \"inventory_view\"]","operationId":"CreateAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdvertisingDealRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertisingDealMultiStatusResponse"}}},"description":"CreateAdvertisingDeal 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertisingDeals"]}},"/adsApi/v1/create/campaigns":{"post":{"description":"Create campaigns\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"CreateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMultiStatusResponseWithPartialErrors"}}},"description":"CreateCampaign 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}},"/adsApi/v1/create/events":{"post":{"description":"Create Event Data\n\n**Requires one of these permissions**:\n[\"event_manager_view\", \"event_manager_edit\"]","operationId":"CreateEvent","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEventRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventMultiStatusResponse"}}},"description":"CreateEvent 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Events"]}},"/adsApi/v1/create/geoLocations":{"post":{"description":"Create geo location targeting definitions. Supports smart locations, which target users based on their percentile rank within a Smart Location Index, and radius locations, which target users within a specified distance of an address or coordinate. Note: radius locations are currently in beta.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\", \n\"MasterAccount_Manager\"]","operationId":"CreateGeoLocation","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"GeoLocationCreateRadiusRequestExample":{"summary":"Create Radius GeoLocation Request Example (Open Beta)","value":{"geoLocations":[{"location":{"radiusLocation":{"coordinates":{"latitude":38.897957,"longitude":-77.03656},"pointOfInterestAddress":"1600 Pennsylvania Ave NW, Washington, DC","pointOfInterestRadius":5,"units":"KILOMETERS"}}}]}},"GeoLocationCreateSmartRequestExample":{"summary":"Create Smart GeoLocation Request Example","value":{"geoLocations":[{"location":{"smartLocation":{"locationIndexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","maxIndexValuePercentile":100,"minIndexValuePercentile":75,"name":"High-value customers"}}}]}}},"schema":{"$ref":"#/components/schemas/CreateGeoLocationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"GeoLocationCreateRadiusResponseExample":{"summary":"Create Radius GeoLocation Response Example (Open Beta)","value":{"error":[],"success":[{"geoLocation":{"geoLocationId":"XHvCjcKHXsKGfcKLaMKMwoh_wpHCkWzChcKHfH_CjsKFT04tYzVkNjNiZDMtZTRhMS00NGUwLWE0YzQtNzk0M2Q4Mzk0M2Qx","location":{"radiusLocation":{"coordinates":{"latitude":38.897957,"longitude":-77.03656},"pointOfInterestAddress":"1600 Pennsylvania Ave NW, Washington, DC","pointOfInterestRadius":5,"units":"KILOMETERS"}}},"index":0}]}},"GeoLocationCreateSmartResponseExample":{"summary":"Create Smart GeoLocation Response Example","value":{"error":[],"success":[{"geoLocation":{"geoLocationId":"XHvCjcKHXsKGfcKLaMKMwoh_wpHCkWzChcKHfH_CjsKFT04tYzVkNjNiZDMtZTRhMS00NGUwLWE0YzQtNzk0M2Q4Mzk0M2Qx","location":{"smartLocation":{"locationIndexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","maxIndexValuePercentile":100,"minIndexValuePercentile":75,"name":"High-value customers"}}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/GeoLocationMultiStatusResponse"}}},"description":"CreateGeoLocation 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["GeoLocations"]}},"/adsApi/v1/create/linearTvIncrementalReachForecasts":{"post":{"description":"Generate Linear TV incremental reach forecast comparing with supported Streaming TV supplies\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateLinearTvIncrementalReachForecast","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinearTvIncrementalReachForecastRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecastMultiStatusResponse"}}},"description":"CreateLinearTvIncrementalReachForecast 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LinearTvIncrementalReachForecasts"]}},"/adsApi/v1/create/linearTvReachForecasts":{"post":{"description":"Generate Linear TV reach forecast\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateLinearTvReachForecast","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinearTvReachForecastRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearTvReachForecastMultiStatusResponse"}}},"description":"CreateLinearTvReachForecast 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LinearTvReachForecasts"]}},"/adsApi/v1/create/locationIndexes":{"post":{"description":"Create a Smart Location Index. A Smart Location Index is a named dataset that maps postal codes to index values representing relative audience quality or sales potential for a given advertiser. Index data is processed asynchronously; the index status will transition from PENDING to ENABLED once processing is complete.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\", \n\"MasterAccount_Manager\"]","operationId":"CreateLocationIndex","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"LocationIndexCreateRequestExample":{"summary":"Create Location Index Request Example","value":{"locationIndexes":[{"countryCode":"US","indexData":{"directIndexValues":{"values":[{"indexValue":42,"postalCode":"80202"},{"indexValue":72,"postalCode":"80301"},{"indexValue":13,"postalCode":"80424"}]}},"indexName":"test index name"}]}}},"schema":{"$ref":"#/components/schemas/CreateLocationIndexRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"LocationIndexCreateResponseExample":{"summary":"Create Location Index Response Example","value":{"error":[],"success":[{"index":0,"locationIndex":{"countryCode":"US","creationDateTime":"2025-09-22T22:24:46.229162573Z","indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","indexName":"test index name","lastUpdatedDateTime":"2025-09-22T22:24:46.229162573Z","status":"PENDING"}}]}}},"schema":{"$ref":"#/components/schemas/LocationIndexMultiStatusResponse"}}},"description":"CreateLocationIndex 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LocationIndexes"]}},"/adsApi/v1/create/managerAccounts":{"post":{"description":"Create manager accounts\n\n**Requires one of these permissions**:\n[]","operationId":"CreateManagerAccount","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManagerAccountRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagerAccountMultiStatusResponse"}}},"description":"CreateManagerAccount 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["ManagerAccounts"]}},"/adsApi/v1/create/promotionCodeRedemptions":{"post":{"description":"API to create promotion code redemptions for affiliate codes\n\n**Requires one of these permissions**:\n[\"nemo_transactions_edit\"]","operationId":"CreatePromotionCodeRedemption","parameters":[{"$ref":"#/components/parameters/AcceptLanguageHeaderOptional"},{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePromotionCodeRedemptionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionCodeRedemptionMultiStatusResponse"}}},"description":"CreatePromotionCodeRedemption 207 response","headers":{"Content-Language":{"required":true,"schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["PromotionCodeRedemptions"]}},"/adsApi/v1/create/reports":{"post":{"description":"Create a report\n\n**Requires one of these permissions**:\n[\"ManagerAccount_Dev\", \"advertiser_campaign_edit\", \"nemo_report_view\", \n\"MasterAccount_Viewer\", \"MA_ReadOnly\", \"advertiser_campaign_view\", \n\"reports_edit\", \"MasterAccount_Manager\", \"nemo_report_edit\", \n\"view_performance_dashboard\"]","operationId":"AdsApiv1CreateReport","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReportRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportMultiStatusResponse"}}},"description":"AdsApiv1CreateReport 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Reports"]}},"/adsApi/v1/create/ruleLinks":{"post":{"description":"Create adjustment rule associations\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"AdsApiv1CreateRuleLink","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRuleLinkRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleLinkMultiStatusResponse"}}},"description":"AdsApiv1CreateRuleLink 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["RuleLinks"]}},"/adsApi/v1/create/rules":{"post":{"description":"Create adjustment rules\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"AdsApiv1CreateRule","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"examples":{"CreateRuleRequest":{"summary":"Create a dimension-based bid adjustment rule","value":{"rules":[{"adProduct":"AMAZON_DSP","expression":[{"dimensionRuleExpression":{"actions":[{"bidAdjustment":{"adjustmentType":"MULTIPLIER","adjustmentValue":2}}],"conditions":{"criteriaCondition":{"criteria":[{"dimensionCriteria":{"dimensionJoinOperator":"AND","dimensions":[{"dimensionType":"DEVICE_TYPE","dimensionValues":["TABLET"],"negative":true}]}}],"criteriaJoinOperator":"AND"}}}},{"dimensionRuleExpression":{"actions":[{"bidAdjustment":{"adjustmentType":"MULTIPLIER","adjustmentValue":1.2}}],"conditions":{"criteriaCondition":{"criteria":[{"dimensionCriteria":{"dimensionJoinOperator":"AND","dimensions":[{"dimensionType":"BROWSER","dimensionValues":["Chrome","Safari"]}]}}],"criteriaJoinOperator":"AND"}}}}],"expressionType":"DIMENSION_RULE_EXPRESSION","name":"Device and browser based bid adjustment rule","onRuleExpressionConflict":"ALL","state":"ENABLED","tags":[{"key":"adjustmentType","value":"BID"}]}]}}},"schema":{"$ref":"#/components/schemas/CreateRuleRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleMultiStatusResponse"}}},"description":"AdsApiv1CreateRule 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Rules"]}},"/adsApi/v1/create/targets":{"post":{"description":"Create target\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"CreateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMultiStatusResponseWithPartialErrors"}}},"description":"CreateTarget 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Targets"]}},"/adsApi/v1/dealPerformances":{"get":{"description":"Retrieve performance metrics for each specified deal.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"ListDealPerformance","parameters":[{"$ref":"#/components/parameters/AdProductQuery"},{"$ref":"#/components/parameters/AdvertisingDealIdQuery"},{"$ref":"#/components/parameters/PerformanceEndDateQuery"},{"$ref":"#/components/parameters/PerformanceStartDateQuery"},{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealPerformanceSuccessResponse"}}},"description":"ListDealPerformance 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["DealPerformances"]}},"/adsApi/v1/dealPlanningMetricses":{"get":{"description":"List deal planning metrics for specified deals.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"ListDealPlanningMetrics","parameters":[{"$ref":"#/components/parameters/AdProductQuery"},{"$ref":"#/components/parameters/AdvertisingDealIdQuery"},{"$ref":"#/components/parameters/CurrencyCodeQuery"},{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealPlanningMetricsSuccessResponse"}}},"description":"ListDealPlanningMetrics 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["DealPlanningMetricses"]}},"/adsApi/v1/delete/adAssociations":{"post":{"description":"Delete Ad Association\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"DeleteAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdAssociationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationMultiStatusResponse"}}},"description":"DeleteAdAssociation 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdAssociations"]}},"/adsApi/v1/delete/adGroups":{"post":{"description":"Delete ad groups\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMultiStatusResponseWithPartialErrors"}}},"description":"DeleteAdGroup 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdGroups"]}},"/adsApi/v1/delete/ads":{"post":{"description":"Delete ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"DeleteAd 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Ads"]}},"/adsApi/v1/delete/campaigns":{"post":{"description":"Delete campaigns\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMultiStatusResponseWithPartialErrors"}}},"description":"DeleteCampaign 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}},"/adsApi/v1/delete/reports":{"post":{"description":"Delete a report by ID\n\n**Requires one of these permissions**:\n[]","operationId":"AdsApiv1DeleteReport","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReportRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportMultiStatusResponse"}}},"description":"AdsApiv1DeleteReport 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Reports"]}},"/adsApi/v1/delete/ruleLinks":{"post":{"description":"Delete adjustment rule associations\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"AdsApiv1DeleteRuleLink","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRuleLinkRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleLinkMultiStatusResponse"}}},"description":"AdsApiv1DeleteRuleLink 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["RuleLinks"]}},"/adsApi/v1/delete/rules":{"post":{"description":"Delete adjustment rules\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"AdsApiv1DeleteRule","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRuleRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleMultiStatusResponse"}}},"description":"AdsApiv1DeleteRule 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Rules"]}},"/adsApi/v1/delete/targets":{"post":{"description":"Delete target\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"DeleteTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMultiStatusResponseWithPartialErrors"}}},"description":"DeleteTarget 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Targets"]}},"/adsApi/v1/locationIndexes":{"get":{"description":"List all Smart Location Indexes for the authenticated advertiser. Returns a paginated collection of indexes including their current processing status. Use the nextToken from the response to retrieve subsequent pages.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"MasterAccount_Viewer\", \"dsp_campaign_view\", \n\"campaign_view\", \"advertiser_campaign_view\", \"campaign_edit\", \n\"dsp_campaign_edit\", \"MasterAccount_Manager\"]","operationId":"ListLocationIndex","parameters":[{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationIndexSuccessResponse"}}},"description":"ListLocationIndex 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LocationIndexes"]}},"/adsApi/v1/query/accountCombinationInvitations":{"post":{"description":"Query invitations to combine advertising accounts under a Single Global Account. This API allows the user to query any invitations open for a given ads account. \n\n**Requires one of these permissions**:\n[]","operationId":"QueryAccountCombinationInvitation","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAccountCombinationInvitationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCombinationInvitationSuccessResponse"}}},"description":"QueryAccountCombinationInvitation 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AccountCombinationInvitations"]}},"/adsApi/v1/query/adAssociations":{"post":{"description":"Query Ad Association\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"creatives_view\", \"campaign_view\"]","operationId":"QueryAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdAssociationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationSuccessResponse"}}},"description":"QueryAdAssociation 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdAssociations"]}},"/adsApi/v1/query/adExtensions":{"post":{"description":"Query ad_extension - API is in open beta\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"advertiser_campaign_view\"]","operationId":"QueryAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdExtensionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdExtensionSuccessResponse"}}},"description":"QueryAdExtension 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdExtensions"]}},"/adsApi/v1/query/adGroups":{"post":{"description":"List ad groups\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"QueryAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupSuccessResponse"}}},"description":"QueryAdGroup 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdGroups"]}},"/adsApi/v1/query/ads":{"post":{"description":"List ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_view\", \"creatives_edit\", \n\"advertiser_campaign_view\"]","operationId":"QueryAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdSuccessResponse"}}},"description":"QueryAd 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Ads"]}},"/adsApi/v1/query/advertiserAccounts":{"post":{"description":"List advertiser accounts\n\n**Requires one of these permissions**:\n[]","operationId":"QueryAdvertiserAccount","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdvertiserAccountRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertiserAccountSuccessResponse"}}},"description":"QueryAdvertiserAccount 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertiserAccounts"]}},"/adsApi/v1/query/advertiserProductGroupEligibilities":{"post":{"description":"Query requests for specific advertiser product group eligibility based on advertiser account id\n\n**Requires one of these permissions**:\n[\"account_view\"]","operationId":"QueryAdvertiserProductGroupEligibility","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdvertiserProductGroupEligibilityRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertiserProductGroupEligibilitySuccessResponse"}}},"description":"QueryAdvertiserProductGroupEligibility 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertiserProductGroupEligibilities"]}},"/adsApi/v1/query/advertisingDeals":{"post":{"description":"Query advertising deals with filters\n\n**Requires one of these permissions**:\n[\"inventory_edit\", \"inventory_view\"]","operationId":"QueryAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdvertisingDealRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertisingDealSuccessResponse"}}},"description":"QueryAdvertisingDeal 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertisingDeals"]}},"/adsApi/v1/query/brandStoreEditionPublishVersions":{"post":{"description":"Query store edition publish versions\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"QueryBrandStoreEditionPublishVersion","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandStoreEditionPublishVersionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionSuccessResponse"}}},"description":"QueryBrandStoreEditionPublishVersion 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStoreEditionPublishVersions"]}},"/adsApi/v1/query/brandStorePages":{"post":{"description":"Retrieve brand store page content\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"QueryBrandStorePage","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandStorePageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStorePageSuccessResponse"}}},"description":"QueryBrandStorePage 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStorePages"]}},"/adsApi/v1/query/brandStores":{"post":{"description":"Query brand store content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_view\", \"account_view\", \n\"creatives_edit\", \"account_edit\", \"campaign_view\", \n\"advertiser_campaign_view\", \"campaign_edit\"]","operationId":"QueryBrandStore","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandStoreRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreSuccessResponse"}}},"description":"QueryBrandStore 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStores"]}},"/adsApi/v1/query/campaigns":{"post":{"description":"Query campaign\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"QueryCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignSuccessResponse"}}},"description":"QueryCampaign 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}},"/adsApi/v1/query/dealAvailses":{"post":{"description":"Query deal avails by advertising deal ID. Returns avails records aggregated by selected attributes over the last 7 days, sorted by eligible avails descending.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QueryDealAvails","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDealAvailsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealAvailsSuccessResponse"}}},"description":"QueryDealAvails 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["DealAvailses"]}},"/adsApi/v1/query/linearTvDayparts":{"post":{"description":"List all supported Linear TV Daypart\n\n**Requires one of these permissions**:\n[]","operationId":"QueryLinearTvDaypart","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryLinearTvDaypartRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearTvDaypartSuccessResponse"}}},"description":"QueryLinearTvDaypart 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LinearTvDayparts"]}},"/adsApi/v1/query/managerAccounts":{"post":{"description":"List manager accounts\n\n**Requires one of these permissions**:\n[]","operationId":"QueryManagerAccount","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryManagerAccountRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagerAccountSuccessResponse"}}},"description":"QueryManagerAccount 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["ManagerAccounts"]}},"/adsApi/v1/query/promotionOffers":{"post":{"description":"API to list the promotion offers for a global account\n\n**Requires one of these permissions**:\n[\"nemo_transactions_view\", \"nemo_transactions_edit\"]","operationId":"QueryPromotionOffer","parameters":[{"$ref":"#/components/parameters/AcceptLanguageHeaderOptional"},{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPromotionOfferRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionOfferSuccessResponse"}}},"description":"QueryPromotionOffer 200 response","headers":{"Content-Language":{"required":true,"schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["PromotionOffers"]}},"/adsApi/v1/query/promotionRewards":{"post":{"description":"Query promotion rewards for an advertiser account. Returns reward details including type, amounts, consumption tracking, and linked account information.\n\n**Requires one of these permissions**:\n[\"nemo_transactions_view\", \"nemo_transactions_edit\"]","operationId":"QueryPromotionReward","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPromotionRewardRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionRewardSuccessResponse"}}},"description":"QueryPromotionReward 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["PromotionRewards"]}},"/adsApi/v1/query/publishers":{"post":{"description":"List all Publishers\n\n**Requires one of these permissions**:\n[]","operationId":"AdsApiv1QueryPublisher","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPublisherRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublisherSuccessResponse"}}},"description":"AdsApiv1QueryPublisher 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Publishers"]}},"/adsApi/v1/query/ruleLinks":{"post":{"description":"Query adjustment rule associations\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"AdsApiv1QueryRuleLink","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRuleLinkRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleLinkSuccessResponse"}}},"description":"AdsApiv1QueryRuleLink 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["RuleLinks"]}},"/adsApi/v1/query/rules":{"post":{"description":"Query adjustment rules\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"AdsApiv1QueryRule","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRuleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleSuccessResponse"}}},"description":"AdsApiv1QueryRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Rules"]}},"/adsApi/v1/query/sellers":{"post":{"description":"Query sellers. A seller is a business entity that has the rights to sell a publisher\u0027s advertising inventory and holds accounts with suppliers that send that inventory to Amazon DSP. Use this API to search sellers by ID or name, for example to identify a seller when creating a deal or commitment.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QuerySeller","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySellerRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerSuccessResponse"}}},"description":"QuerySeller 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Sellers"]}},"/adsApi/v1/query/sellingAccounts":{"post":{"description":"List selling accounts\n\n**Requires one of these permissions**:\n[]","operationId":"QuerySellingAccount","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySellingAccountRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellingAccountSuccessResponse"}}},"description":"QuerySellingAccount 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["SellingAccounts"]}},"/adsApi/v1/query/suppliers":{"post":{"description":"Query suppliers. A supplier is a business entity that sends advertising inventory to Amazon DSP, either through direct publisher relationships or as an intermediary such as a supply-side platform (SSP). Use this API to search suppliers by ID or name.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QuerySupplier","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySupplierRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierSuccessResponse"}}},"description":"QuerySupplier 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Suppliers"]}},"/adsApi/v1/query/targets":{"post":{"description":"List target\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"QueryTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryTargetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetSuccessResponse"}}},"description":"QueryTarget 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Targets"]}},"/adsApi/v1/retrieve/locationIndexes":{"post":{"description":"Retrieve one or more Smart Location Indexes by ID. Returns the current metadata and processing status for each requested index. An index with status PENDING is still being processed and is not yet available for use in smart location targeting.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"MasterAccount_Viewer\", \"dsp_campaign_view\", \n\"campaign_view\", \"advertiser_campaign_view\", \"campaign_edit\", \n\"dsp_campaign_edit\", \"MasterAccount_Manager\"]","operationId":"RetrieveLocationIndex","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"LocationIndexRetrieveRequestExample":{"summary":"Retrieve Location Index Example","value":{"indexIds":["518f53e3-1739-4644-8f9a-a0211a6188d0"]}}},"schema":{"$ref":"#/components/schemas/RetrieveLocationIndexRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"LocationIndexRetrieveResponseExample":{"summary":"Retrieve Location Index Response Example","value":{"error":[],"success":[{"index":0,"locationIndex":{"countryCode":"US","creationDateTime":"2025-09-22T22:24:46.229162573Z","indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","indexName":"test index name","lastUpdatedDateTime":"2025-09-22T22:24:46.229162573Z","status":"ENABLED"}}]}}},"schema":{"$ref":"#/components/schemas/LocationIndexMultiStatusResponse"}}},"description":"RetrieveLocationIndex 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LocationIndexes"]}},"/adsApi/v1/retrieve/reports":{"post":{"description":"Retrieve a report by ID\n\n**Requires one of these permissions**:\n[]","operationId":"AdsApiv1RetrieveReport","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveReportRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportMultiStatusResponse"}}},"description":"AdsApiv1RetrieveReport 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Reports"]}},"/adsApi/v1/retrieve/rules":{"post":{"description":"Retrieve adjustment rules\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"AdsApiv1RetrieveRule","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRuleRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleMultiStatusResponse"}}},"description":"AdsApiv1RetrieveRule 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Rules"]}},"/adsApi/v1/update/accountCombinationInvitations":{"post":{"description":"Update an invitation to combine Advertising Accounts under a Single Global Account. This API supports updating the invitations to approve, reject, or resend them.\n\n**Requires one of these permissions**:\n[]","operationId":"UpdateAccountCombinationInvitation","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountCombinationInvitationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCombinationInvitationMultiStatusResponse"}}},"description":"UpdateAccountCombinationInvitation 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AccountCombinationInvitations"]}},"/adsApi/v1/update/adAssociations":{"post":{"description":"Update Ad Association\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"UpdateAdAssociation","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdAssociationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAssociationMultiStatusResponse"}}},"description":"UpdateAdAssociation 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdAssociations"]}},"/adsApi/v1/update/adExtensions":{"post":{"description":"Update ad_extension - API is in open beta\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateAdExtension","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdExtensionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdExtensionMultiStatusResponseWithPartialErrors"}}},"description":"UpdateAdExtension 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdExtensions"]}},"/adsApi/v1/update/adGroups":{"post":{"description":"Update ad groups\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"UpdateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdGroupMultiStatusResponseWithPartialErrors"}}},"description":"UpdateAdGroup 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdGroups"]}},"/adsApi/v1/update/ads":{"post":{"description":"Update ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"creatives_edit\"]","operationId":"UpdateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"UpdateAd 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Ads"]}},"/adsApi/v1/update/advertiserAccounts":{"post":{"description":"Update advertiser accounts\n\n**Requires one of these permissions**:\n[]","operationId":"UpdateAdvertiserAccount","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdvertiserAccountRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertiserAccountMultiStatusResponse"}}},"description":"UpdateAdvertiserAccount 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertiserAccounts"]}},"/adsApi/v1/update/advertisingDeals":{"post":{"description":"Update advertising deals\n\n**Requires one of these permissions**:\n[\"inventory_edit\", \"inventory_view\"]","operationId":"UpdateAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdvertisingDealRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertisingDealMultiStatusResponse"}}},"description":"UpdateAdvertisingDeal 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdvertisingDeals"]}},"/adsApi/v1/update/brandStoreEditionPublishVersions":{"post":{"description":"Update store edition publish versions\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\"]","operationId":"UpdateBrandStoreEditionPublishVersion","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandStoreEditionPublishVersionRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionMultiStatusResponse"}}},"description":"UpdateBrandStoreEditionPublishVersion 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStoreEditionPublishVersions"]}},"/adsApi/v1/update/brandStorePages":{"post":{"description":"Update brand store page content\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\"]","operationId":"UpdateBrandStorePage","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandStorePageRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStorePageMultiStatusResponse"}}},"description":"UpdateBrandStorePage 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStorePages"]}},"/adsApi/v1/update/campaigns":{"post":{"description":"Update campaign\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"UpdateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMultiStatusResponseWithPartialErrors"}}},"description":"UpdateCampaign 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Campaigns"]}},"/adsApi/v1/update/locationIndexes":{"post":{"description":"Update the data for an existing Smart Location Index. Replaces the index\u0027s postal code values with the provided dataset. The update is processed asynchronously; the index status will return to PENDING until the new data has been fully processed.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\", \n\"MasterAccount_Manager\"]","operationId":"UpdateLocationIndex","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"examples":{"LocationIndexUpdateRequestExample":{"summary":"Update Location Index Request Example","value":{"locationIndexes":[{"indexData":{"directIndexValues":{"values":[{"indexValue":55,"postalCode":"80202"},{"indexValue":80,"postalCode":"80301"},{"indexValue":20,"postalCode":"80424"}]}},"indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0"}]}}},"schema":{"$ref":"#/components/schemas/UpdateLocationIndexRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"LocationIndexUpdateResponseExample":{"summary":"Update Location Index Response Example","value":{"error":[],"success":[{"index":0,"locationIndex":{"countryCode":"US","creationDateTime":"2025-09-22T22:24:46.229162573Z","indexId":"518f53e3-1739-4644-8f9a-a0211a6188d0","indexName":"test index name","lastUpdatedDateTime":"2025-09-23T10:00:00.000000000Z","status":"PENDING"}}]}}},"schema":{"$ref":"#/components/schemas/LocationIndexMultiStatusResponse"}}},"description":"UpdateLocationIndex 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LocationIndexes"]}},"/adsApi/v1/update/managerAccounts":{"post":{"description":"Update manager accounts\n\n**Requires one of these permissions**:\n[]","operationId":"UpdateManagerAccount","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateManagerAccountRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagerAccountMultiStatusResponse"}}},"description":"UpdateManagerAccount 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["ManagerAccounts"]}},"/adsApi/v1/update/rules":{"post":{"description":"Update adjustment rules\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"AdsApiv1UpdateRule","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRuleRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleMultiStatusResponse"}}},"description":"AdsApiv1UpdateRule 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Rules"]}},"/adsApi/v1/update/targets":{"post":{"description":"Update target\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetMultiStatusResponseWithPartialErrors"}}},"description":"UpdateTarget 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Targets"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}