Advertisers Validation Lists
- Arunima Kurup Prasad
- Muge Budak
Platform URL | https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/validation-lists |
|---|---|
API Endpoints | Retrieves Suppression/Validation Lists: GET https://{enterprise}.cvtr.io/api/v4/suppression-listsCreates Suppression/Validation Lists: POST https://{enterprise}.cvtr.io/api/v4/suppression-listsRetrieves Suppression/Validation Values: GET https://{enterprise}.cvtr.io/api/v4/suppression-list-valuesCreates Suppression/Validation Values: Downloads Suppression/Validation Values: Upload CSV file containing Suppression/Validation Values: Import Suppression/Validation Values: Retrieves/Removes/Replaces a Suppression/Validation Values: |
Epic | |
Document status | REVIEWED |
Document owner | @Adam Carter |
Technical Writers | @Anu Kalangi @Muge Budak @Arunima Kurup Prasad |
Related Content |
Feature Overview
Validation Lists
Validation lists allow users to check the leads against the list of values to either target or suppress and pass/reject a lead based on the condition selected. For example, if the user is targeting a list of specific companies in a campaign, the user can set up a validation list to ensure that the lead data contains only the exact values required.
Validation Lists can be set up in two areas:
System Level: Lists applied at this level will be accessible across all campaigns in your enterprise. Please refer the documentation mentioned in ‘Related Content’ above
Advertiser Level: Lists applied at this level will only be available to campaigns set up under this advertiser.
Setting Up Validation Lists At An Advertiser Level
By clicking on the ‘View’ button or on the ‘Company Name’ hyperlink on the Advertiser listing page, the user will be able to see the Validation Lists menu, based on their user role.
The page lists validation lists configured for the advertiser. Users have the option to perform search on some of the columns. There is also a ‘download’ icon at the bottom of the table which will download the contents of the table as a CSV file.
The Add button opens a modal as shown below. Here the user must provide a name for the validation list and specify if it should be a private list.
Name | Required | Notes |
Name | Enter the validation list name | |
Privatise | Privatise toggle affects the view of the list for any Agency type users on your platform. If set to Private, Agency users will not be able to see the values that are added to the list, or make any changes to it. The role of private validation lists is to allow the advertiser to upload potentially sensitive information without exposing it to Agency or Publisher user types. Admin + Super Admin users should still be able to see private validations lists. |
Clicking on Save will open a modal called ‘Add Validation List’. Here, the user can either add values or import values into the list.
Add Values
User can add values by entering the details in ‘New Value’ and clicking on ‘Add’.
Import Values
If the user chooses to import values to the list, they can do so by selecting the ‘Import Values’ tab which will allow the user to upload a CSV file containing the values. Sample CSV file for reference can be downloaded by clicking on the link in the blue banner.
Values added/imported will be listed as shown below.
Users can remove individual values from the list by checking the corresponding checkbox and clicking on ‘Remove’ button. Alternately, the user can remove all values from the list by clicking on the ‘Remove All’ button.
Add/Edit
Existing validation lists may be edited using the Add/Edit button available on the the listing table.
Download
Clicking on the Download button will make the validation list available under Exports option. User can then download the list to their environment.
Summary
Functionality | User Story | |
|---|---|---|
| 1 | Validation Lists | Users can see the table listing all the validation lists and can edit the name of the validation list and make them private/non private |
| 2 | Validation Lists > Add | Users can add private and non private validation lists |
| 3 | Validation Lists > Add/Edit | Users can add, import and remove values in the validation lists |
| 4 | Validation Lists > Delete | Users can select and delete multiple Validation Lists at a time |
| 5 | Validation Lists > Download | Users can download the contents of a validation list using the Download button available in Actions |
| 6 | Advertisers > Create Campaign | Allows users to create campaigns for the advertiser |
| 7 | Table Download | Allows user to download the validation lists shown on the table |
| 8 | Table Filtering | Allows the user to filter the table values using Id and Name |
User Permissions
Admin users, agency users and advertiser users associated with the advertiser can access this tab.
https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=1710197291 Connect to preview