Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties

Platform URL

https://[enterprise].cvtr.io/v2/advertisers

API Endpoints

Page Properties

Platform URL

https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/value-transforms/list

API Endpoints

Retrieves Value Transforms:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/advertiser-value-transforms

Creates a AdvertiserValueTransformField resource:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/advertiser-value-transforms

Retrieves/Removes/Replaces a AdvertiserValueTransformField resource:

Code Block
GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4//api/v4/advertiser-value-transforms/{id}

Retrieves Value Transforms Groups:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/advertiser-value-transform-groups

Retrieves the collection of AdvertiserValueTransformValue resources:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/api/v4/advertiser-value-transform-values

Creates a AdvertiserValueTransformValue resource:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/advertiser-value-transform-values

Retrieves/Removes/Replaces a AdvertiserValueTransformValue resource resource:

Code Block
GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/advertiser-value-transform-values/{id}

Creates a AdvertiserValueTransformImport resource:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/advertiser-value-transform-import

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyDAS-14

Document status

Status
colourGreen
titleDRAFTREVIEWED

Document owner

Anu Kalangi

Designer

@ designer

Tech lead

@ lead

Technical writers

@ writers

QA

Related Content

Adam Carter

Technical Writer

Anu Kalangi Muge Budak Arunima Kurup Prasad

Related Content

Value Transforms

🏠 Feature Overview

Value Transformation

Value Transform 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 off of 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 - combines combine different fields together (concatenation), or change a telephone number's format (Regex Find and Replace).

User Users can create value transform transforms by importing or creating the new ones.

Importing Value Transforms

Click import and download the csv file 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 field name, new fieldname and group name ‘Original Fieldname’, ‘New Fieldname’ and ‘Group Name’ will be grouped together.

Imported value transforms will have the type: Transform.

...

Add Value Transforms

Click Add on the Field Names tab.By clicking on the ‘Add’ button, value transforms can be added via the ‘Add Field Name’ modal.

...

When adding a an entry to the value transform, the user enter enters the following fields and clicks Save

Name

Required

Notes

Label

(tick)

Enter a label name

Original Field Name

(tick)

Select from the dropdown

New Field Name

(tick)

Enter new field name

Type

(tick)

Specify the type of value transform

Original Value

(tick)

The original value of the field in the lead

New Value

(tick)

The manipulated value of the field

Transform

...

Manipulate

...

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 groups into which user can add previously-created Value Transform Fieldnames.

...

🎯 Objective

The advertiser is the client accepting the leads. The advertiser will be able to set up multiple campaigns per advertiser and assign publishers to campaigns to provide leads to these campaigns.

\uD83E\uDD14 Assumptions

Info

Provide any assumptions/pre requisites that are needed for the feature to work.

\uD83D\uDDD2 Requirements

User Permissions

The users should have access to the advertisers to be able to view the advertisers

...

Requirement

...

User Story

...

Importance

...

Jira Issue

...

Notes

...

Status
colourRed
titleHIGH

...

 

...

 

...

 

...

 

...

 

\uD83C\uDFA8 User interaction and design

Advertiser-Create Campaign -https://www.figma.com/proto/XSFJYyCCNM0Z41Lh961pMm/ADVERTISERS---Create-Campaign-V3?scaling=min-zoom&page-id=0%3A1&starting-point-node-id=9%3A2&node-id=9%3A2

Advertiser- Import-https://www.figma.com/proto/AsU5TdoA31PwSqZsuTRKY4/ADVERTISER---Import?node-id=2%3A7&scaling=min-zoom&page-id=0%3A1&starting-point-node-id=2%3A7

Advertiser- Validation Lists-https://invis.io/WQ10SOR1P56B

Advertiser-Value Transform-https://invis.io/MEUGRPETYWK

https://invis.io/59UA4R5H3QR

(question) Open Questions

...

Question

...

Answer

...

Date Answered

(warning) Out of Scope

...

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)

...

\uD83D\uDDD2 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

\uD83D\uDDD2 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