Value Transformations
- Arunima Kurup Prasad
- Muge Budak
Platform URL | https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/value-transforms/list |
|---|---|
API Endpoints | Retrieves Value Transforms: GET https://{enterprise}.cvtr.io/api/v4/advertiser-value-transformsCreates a AdvertiserValueTransformField resource: POST https://{enterprise}.cvtr.io/api/v4/advertiser-value-transformsRetrieves/Removes/Replaces a AdvertiserValueTransformField resource: GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4//api/v4/advertiser-value-transforms/{id}Retrieves Value Transforms Groups: Retrieves the collection of AdvertiserValueTransformValue resources: Creates a AdvertiserValueTransformValue resource: Retrieves/Removes/Replaces a AdvertiserValueTransformValue resource resource: Creates a AdvertiserValueTransformImport resource: |
Epic | |
Document status | REVIEWED |
Document owner | @Adam Carter |
Technical Writer | @Anu Kalangi @Muge Budak @Arunima Kurup Prasad |
Related Content |
Feature Overview
Value Transformation
Value Transforms solves data formatting issues. Value Transforms lets the user take the data that already exists in the platform, and create new data based on them that can be used to report, integrate and categorise your leads.
There are two types of Value Transforms: Transforms and Manipulation
Transforms: This allows the user to take known data values which are expecting to receive, and transform them into a new value in a new field.
Manipulation : This allows the user to reformat unknown data values - combine different fields together (concatenation), or change a telephone number's format (Regex Find and Replace).
Users can create value transforms by importing or creating new ones.
Importing Value Transforms
For a selected advertiser, value transforms can be created by navigating to the ‘Value Transformations’ tab and clicking on the ‘Import’ button or ‘Add’ button.
Click on ‘Import’ shows the below modal where the user can download a sample CSV template from the link in the blue banner.
Once downloaded, fill in each row with the value transform you want to add - values with the same ‘Original Fieldname’, ‘New Fieldname’ and ‘Group Name’ will be grouped together.
Imported value transforms will have the type: Transform.
Add Value Transforms
By clicking on the ‘Add’ button, value transforms can be added via the ‘Add Field Name’ modal.
When adding an entry to the value transform, the user enters the following fields and clicks Save
Name | Required | Notes |
Label | Enter a label name | |
Original Field Name | Select from the dropdown | |
New Field Name | Enter new field name | |
Type | Specify the type of value transform | |
Original Value | The original value of the field in the lead | |
New Value | The manipulated value of the field |
Type: Transform
This allows you to take known data values you are expecting to receive, and transform them into a new value in a new field. E.g. Transforming country names to country code.
Type: Manipulate
This allows you to reformat unknown data values; there are a number of options available, such as concatenation (combine different fields together), Regex Find and Replace (change a telephone number's format), MD5 and SHA256 (for encrypting values), etc.
There is also a 'Preview Input’ and ‘Preview Output’ option available where the user can provide an input in the former and view the output after manipulation in the latter. This helps the user to confirm the manipulation they want to apply.
Value Transform Groups
User can create value transform groups to group together Value Transforms. These groups may be imported to individual campaigns of the Advertiser. (More details in Campaign > Value Transforms in Related Content)
Summary
Functionality | User Story | |
|---|---|---|
| 1 | Value Transformation Listing | Users can see the value transforms listing and edit the ‘Label’, ‘Original Name’ and ‘New Name’ fields |
| 2 | Value Transformation > Add | Users can add value transform values using the Add button |
| 3 | Value Transformation > Add/Edit | Users can add and edit value transforms using the Add/Edit button |
| 4 | Value Transformation > Delete | Users can select and delete multiple value transform lists at a time |
| 5 | Value Transformation > Import | Users can import CSV file for 'transform' type of value transforms |
| 6 | Value Transformation > Group Listing | Users can see the value transforms groups listing and edit the ‘Id’ and ‘Group Name’ fields |
| 7 | Value Transformation > Group > Add | User can create value transform groups in which value transforms can be grouped |
| 8 | Value Transformation > Group > Add/Edit | User can add/edit value transform groups |
| 9 | Value Transformation > Group > Delete | User can delete value transform groups |
| 10 | Value Transformation > Table Filtering | Allows the user to filter the table values using Id, Original Name and New Name fields |
| 11 | Value Transformation > Group > Table Filtering | Allows the user to filter the table values using Id and Group Name fields |
User Permissions
Admin users and agency users who belong with agencies associated with the advertiser can access this tab.
https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=1710197291 Connect to preview