{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessDeniedErrorCode":{"enum":["ACCESS_DENIED"],"type":"string"},"AccessDeniedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/AccessDeniedErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"CampaignsConfigurations":{"description":"The campaign validation configuration values for a specific advertiser context. This includes budget\n    and inputted name field configuration values.","properties":{"maxAdGroupNameLength":{"description":"The maximum allowed length of an ad group name.","type":"number"},"maxCampaignNameLength":{"description":"The maximum allowed length of a campaign name.","type":"number"},"maxDailyBudget":{"description":"The maximum daily budget allowed for campaigns.","format":"double","type":"number"},"maxLifetimeBudget":{"description":"The maximum lifetime budget allowed for campaigns.","format":"double","type":"number"},"maxPortfolioNameLength":{"description":"The maximum allowed length of a portfolio name.","type":"number"},"minDailyBudget":{"description":"The minimum daily budget allowed for campaigns.","format":"double","type":"number"},"minLifetimeBudget":{"description":"The minimum lifetime budget allowed for campaigns.","format":"double","type":"number"},"textFieldValidationRegex":{"description":"The regex string used to validate the characters and order of characters for campaign names,\n        ad group names, and portfolio names.","minLength":1,"type":"string"}},"required":["maxAdGroupNameLength","maxCampaignNameLength","maxDailyBudget","maxPortfolioNameLength","minDailyBudget","textFieldValidationRegex"],"type":"object"},"CountryCode":{"description":"The countryCode for a given country.","enum":["AE","AU","BE","BR","CA","CN","DE","EG","ES","FR","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","UK","US","ZA"],"type":"string"},"CountryToProgramToEntityToCampaignsConfigurations":{"additionalProperties":{"$ref":"#/components/schemas/ProgramToEntityToCampaignsConfigurations"},"description":"A nested structure mapping advertiser contexts to campaign configuration values. The keys at this level\nare country codes, two capitalized characters mapping to a marketplace. The valid country codes are:\n- US: United States\n- CA: Canada\n- MX: Mexico\n- BR: Brazil\n- UK: United Kingdom\n- DE: Germany\n- FR: France\n- ES: Spain\n- IN: India\n- IT: Italy\n- NL: Netherlands\n- AE: United Arab Emirates\n- SA: Saudi Arabia\n- SE: Sweden\n- TR: Turkey\n- PL: Poland\n- EG: Egypt\n- JP: Japan\n- AU: Australia\n- SG: Singapore\n- CN: China\n- BE: Belgium\n- ZA: South Africa\n- IE: Ireland","type":"object"},"CountryToProgramToEntityToTargetingConfigurations":{"additionalProperties":{"$ref":"#/components/schemas/ProgramToEntityToTargetingConfigurations"},"description":"A nested structure mapping advertiser contexts to targeting clause configuration values. The keys at\nthis level are country codes, two capitalized characters mapping to a marketplace. The valid country codes are:\n- US: United States\n- CA: Canada\n- MX: Mexico\n- BR: Brazil\n- UK: United Kingdom\n- DE: Germany\n- FR: France\n- ES: Spain\n- IN: India\n- IT: Italy\n- NL: Netherlands\n- AE: United Arab Emirates\n- SA: Saudi Arabia\n- SE: Sweden\n- TR: Turkey\n- PL: Poland\n- EG: Egypt\n- JP: Japan\n- AU: Australia\n- SG: Singapore\n- CN: China\n- BE: Belgium\n- ZA: South Africa\n- IE: Ireland","type":"object"},"EntityToCampaignsConfigurations":{"additionalProperties":{"$ref":"#/components/schemas/CampaignsConfigurations"},"description":"A nested structure mapping advertiser contexts to campaign configuration values. The keys at this level\nare entity types, capitalized strings mapping to the advertiser\u0027s account profile. The valid entity types are:\n- SELLER: seller\n- VENDOR: vendor","type":"object"},"EntityToTargetingConfigurations":{"additionalProperties":{"$ref":"#/components/schemas/TargetingClausesConfiguration"},"description":"A nested structure mapping advertiser contexts to targeting clause configuration values. The keys at\nthis level are entity types, capitalized strings mapping to the advertiser\u0027s account profile. The valid entity types\nare:\n- SELLER: seller\n- VENDOR: vendor","type":"object"},"EntityType":{"description":"Identifier of supported entity types.","enum":["SELLER","VENDOR"],"type":"string"},"InternalErrorErrorCode":{"enum":["INTERNAL_ERROR"],"type":"string"},"InternalServerExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InternalErrorErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"InvalidArgumentErrorCode":{"enum":["INVALID_ARGUMENT"],"type":"string"},"NotFoundErrorCode":{"enum":["NOT_FOUND"],"type":"string"},"ProgramToEntityToCampaignsConfigurations":{"additionalProperties":{"$ref":"#/components/schemas/EntityToCampaignsConfigurations"},"description":"A nested structure mapping advertiser contexts to campaign configuration values. The keys at this level\nare program types, two capitalized characters mapping to a specific builder. The valid program types are:\n- SB: Sponsored Brands\n- SP: Sponsored Products\n- SD: Sponsored Display","type":"object"},"ProgramToEntityToTargetingConfigurations":{"additionalProperties":{"$ref":"#/components/schemas/EntityToTargetingConfigurations"},"description":"A nested structure mapping advertiser contexts to targeting clause configuration values. The keys at\nthis level are program types, two capitalized characters mapping to a specific builder. The valid program types are:\n- SB: Sponsored Brands\n- SP: Sponsored Products\n- SD: Sponsored Display","type":"object"},"ProgramType":{"description":"Identifier of supported program types.","enum":["SB","SD","SP"],"type":"string"},"ResourceNotFoundExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/NotFoundErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"TargetingClausesConfiguration":{"description":"The targeting group configuration values for a specific advertiser context. This includes bid and\n    keyword validation values.","properties":{"keywordValidationRegex":{"description":"Regex string used to validate keywords.","minLength":1,"type":"string"},"maxBid":{"description":"The default maximum CPC bid value for campaigns.","format":"double","type":"number"},"maxBidVCpm":{"description":"The default maximum vCPM bid value for campaigns.","format":"double","type":"number"},"maxBidVideoAdvertisement":{"description":"The maximum CPC bid value for a Sponsored Brands video campaign.","format":"double","type":"number"},"maxBidVideoAdvertisementVCpm":{"description":"The maximum vCPM bid value for a Sponsored Brands video campaign.","format":"double","type":"number"},"maxKeywordLength":{"description":"The maximum allowed length of a keyword.","type":"number"},"minBid":{"description":"The default minimum CPC bid value for campaigns.","format":"double","type":"number"},"minBidVCpm":{"description":"The default minimum vCPM bid value for campaigns.","format":"double","type":"number"},"minBidVideoAdvertisement":{"description":"The minimum CPC bid value for a Sponsored Brands video campaign.","format":"double","type":"number"},"minBidVideoAdvertisementVCpm":{"description":"The minimum vCPM bid value for a Sponsored Brands video campaign.","format":"double","type":"number"}},"required":["maxBid","minBid"],"type":"object"},"ThrottledErrorCode":{"enum":["THROTTLED"],"type":"string"},"ThrottlingExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ThrottledErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"ValidationExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/InvalidArgumentErrorCode"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"],"type":"object"},"getCampaignsValidationConfigsRequestContent":{"description":"An advertiser context is a combination of specific marketplace, entity, and program type that an\n    advertiser belongs to. This context defines the specific configuration values the API is requesting. From this\n    input, the API will request all permutations of the input lists. For example, if the country code list includes\n    US and UK, entity type list includes seller, and program type includes SP and SB, the API will output the\n    configuration values for US seller SP, US seller SB, UK seller SP, and UK seller SB. If the country code list,\n    entity type list, and program type lists are null (not defined by the user) will output the configuration values\n    for all marketplace, entity type, and program type combinations (a get all request).","properties":{"countryCodesList":{"description":"The list of countryCode enums defining the marketplaces whose configuration values are requested.\n        When `null` is selected and no value is attributed to this key, all countryCode options are selected.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":5,"minItems":1,"type":"array"},"entityTypesList":{"description":"The list of entityType enums defining the marketplaces whose configuration values are requested.\n        When `null` is selected and no value is attributed to this key, all countryCode options are selected.","items":{"$ref":"#/components/schemas/EntityType"},"maxItems":2,"minItems":1,"type":"array"},"programTypesList":{"description":"The list of programType enums defining the marketplaces whose configuration values are requested.\n        When `null` is selected and no value is attributed to this key, all countryCode options are selected.","items":{"$ref":"#/components/schemas/ProgramType"},"maxItems":3,"minItems":1,"type":"array"}},"type":"object"},"getCampaignsValidationConfigsResponseContent":{"description":"The key `campaignsValidationConfigs` is mapped to this API\u0027s returned object: a nested structure mapping\ncountry code to program type to entity type to campaign configuration values. The campaign configuration values\ncorrespond to the specified path it resides on. For example, the configuration values at the path `US`, `SB`, `SELLER`\nis for the US SB SELLER advertiser context. Only the requested keys will be included in the returned object.","properties":{"campaignValidationConfigs":{"$ref":"#/components/schemas/CountryToProgramToEntityToCampaignsConfigurations"}},"required":["campaignValidationConfigs"],"type":"object"},"getTargetingClausesValidationConfigsRequestContent":{"description":"An advertiser context is a combination of specific marketplace, entity, and program type that an\n    advertiser belongs to. This context defines the specific configuration values the API is requesting. From this\n    input, the API will request all permutations of the input lists. For example, if the country code list includes\n    US and UK, entity type list includes seller, and program type includes SP and SB, the API will output the\n    configuration values for US seller SP, US seller SB, UK seller SP, and UK seller SB. If the country code list,\n    entity type list, and program type lists are null (not defined by the user) will output the configuration values\n    for all marketplace, entity type, and program type combinations (a get all request).","properties":{"countryCodesList":{"description":"The list of countryCode enums defining the marketplaces whose configuration values are requested.\n        When `null` is selected and no value is attributed to this key, all countryCode options are selected.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":5,"minItems":1,"type":"array"},"entityTypesList":{"description":"The list of entityType enums defining the marketplaces whose configuration values are requested.\n        When `null` is selected and no value is attributed to this key, all countryCode options are selected.","items":{"$ref":"#/components/schemas/EntityType"},"maxItems":2,"minItems":1,"type":"array"},"programTypesList":{"description":"The list of programType enums defining the marketplaces whose configuration values are requested.\n        When `null` is selected and no value is attributed to this key, all countryCode options are selected.","items":{"$ref":"#/components/schemas/ProgramType"},"maxItems":3,"minItems":1,"type":"array"}},"type":"object"},"getTargetingClausesValidationConfigsResponseContent":{"description":"The key `targetingClausesValidationConfigs` is mapped to this API\u0027s returned object: a nested structure\nmapping country code to program type to entity type to targeting clause configuration values. The targeting clause\nconfiguration values correspond to the specified path it resides on. For example, the configuration values at the path\n`US`, `SB`, `SELLER` is for the US SB SELLER advertiser context. Only the requested keys will be included in the\nreturned object.","properties":{"targetingClausesValidationConfigs":{"$ref":"#/components/schemas/CountryToProgramToEntityToTargetingConfigurations"}},"required":["targetingClausesValidationConfigs"],"type":"object"}},"securitySchemes":{}},"info":{"description":"This API allows users to retrieve campaign validation configuration values per marketplace, entity type, and program type.","title":"Validation Configurations API","version":"3.0"},"openapi":"3.0.1","paths":{"/validationConfigurations/campaigns":{"post":{"description":"Retrieves the campaign configuration values used for campaign validation for the requested marketplace,\n    entityType, and programType context/contexts.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getCampaignsValidationConfigs","parameters":[{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n        resource to list profiles associated with the access token passed in the HTTP Authorization header and choose\n        profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n        resource to list profiles associated with the access token passed in the HTTP Authorization header and choose\n        profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.AdsApiValidationConfigsServiceLambda.CampaignsResource.v1+json":{"schema":{"$ref":"#/components/schemas/getCampaignsValidationConfigsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.AdsApiValidationConfigsServiceLambda.CampaignsResource.v1+json":{"schema":{"$ref":"#/components/schemas/getCampaignsValidationConfigsResponseContent"}}},"description":"getCampaignsValidationConfigs 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before next recommended re-try attempt.","schema":{"description":"Delay in seconds, before next recommended re-try attempt.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Validation Configurations Retrieval"]}},"/validationConfigurations/targetingClauses":{"post":{"description":"Retrieves the configuration values used in targeting clause validation for the requested inputted\n    marketplace, entityType, and programType context/contexts.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getTargetingClausesValidationConfigs","parameters":[{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n        resource to list profiles associated with the access token passed in the HTTP Authorization header and choose\n        profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n        resource to list profiles associated with the access token passed in the HTTP Authorization header and choose\n        profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.AdsApiValidationConfigsServiceLambda.TargetingClausesResource.v1+json":{"schema":{"$ref":"#/components/schemas/getTargetingClausesValidationConfigsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.AdsApiValidationConfigsServiceLambda.TargetingClausesResource.v1+json":{"schema":{"$ref":"#/components/schemas/getTargetingClausesValidationConfigsResponseContent"}}},"description":"getTargetingClausesValidationConfigs 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before next recommended re-try attempt.","schema":{"description":"Delay in seconds, before next recommended re-try attempt.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Validation Configurations Retrieval"]}}}}