Validation Configuration

class ad_api.api.ValidationConfigurations(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, proxies=None, verify=True, timeout=None, debug=False, access_token=None)

Validation Configurations API Version 3

Documentation: https://dtrnk0o2zy01c.cloudfront.net/openapi/en-us/dest/ValidationConfigurationsAPI_prod_3p.json

This API allows users to retrieve campaign validation configuration values per marketplace, entity type, and program type.

retrieve_validation_campaigns(self, **kwargs) → ApiResponse:

Retrieves the campaign configuration values used for campaign validation for the requested marketplace, entityType, and programType context/contexts.

Request body

countryCodesList (Array): [optional] The list of countryCode enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN, IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]

entityTypesList (Array): [optional] The list of entityType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SELLER, VENDOR ]

programTypesList (Array): [optional] The list of programType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SB, SP, SD ]

Returns:

ApiResponse

### Example python

from ad_api.api import ValidationConfigurations

dictionary = \
{
    "countryCodesList": [
        "ES"
    ],
    "entityTypesList": [
        "SELLER"
    ],
    "programTypesList": [
        "SB"
    ]
}

result = ValidationConfigurations().retrieve_validation_campaigns(
    body=dictionary
)
payload = result.payload

ad_api.api.ValidationConfigurations.retrieve_validation_targeting_clauses(self, **kwargs) → ApiResponse:

Retrieves the configuration values used in targeting clause validation for the requested inputted marketplace, entityType, and programType context/contexts.

Request body

countryCodesList (Array): [optional] The list of countryCode enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN, IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]

entityTypesList (Array): [optional] The list of entityType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SELLER, VENDOR ]

programTypesList (Array): [optional] The list of programType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SB, SP, SD ]

Returns:

ApiResponse

### Example python

from ad_api.api import ValidationConfigurations

dictionary = \
{
    "countryCodesList": [
        "ES"
    ],
    "entityTypesList": [
        "VENDOR"
    ],
    "programTypesList": [
        "SP"
    ]
}

result = ValidationConfigurations().retrieve_validation_targeting_clauses(
    body=dictionary
)
payload = result.payload