Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/value_transforms

API Endpoints

Enable/Disable Value Transforms

PUT /api/v4/campaigns/{campaignId}

Load Value Transforms

GET /api/v4/campaign-value-transform-values?itemsPerPage=5&page=1&field.id=0&order%5Bid%5D=asc&campaign.id={campaignId}

GET /api/v4/lead-data-fields?itemsPerPage=10&source%5B%5D=publisher&source%5B%5D=Connected%20App

Update Value Transform details

PUT /api/v4/campaign-value-transform-fields/{valueTransformId}

Save Transform Fields and Values

POST /api/v4/campaign-value-transform-fields

POST /api/v4/campaign-value-transform-values

Delete Transform Field-Value

DELETE /api/v4/campaign-value-transform-values/{transformId}

Load Manipulate value transforms

GET /api/v4/campaign-value-manipulate-values?page=1&itemsPerPage=5&field.id=2&order%5Bid%5D=asc

GET api/v4/lead-data-fields?itemsPerPage=10&source%5B%5D=publisher&source%5B%5D=Connected%20App

Load Preview for Manipulate type

POST api/v4/advertiser-value-manipulate-preview

Save Manipulate Fields and Values

POST /api/v4/campaign-value-transform-fields

POST /api/v4/campaign-value-manipulate-values

Delete Manipulate Fields and Values

DELETE /api/v4/campaign-value-manipulate-values/{manipulateValueTransformId}

Deleting Value Transforms

DELETE /api/v4/campaign-value-transform-fields/{valuetransformId}

Epic

CON-5665 - Getting issue details... STATUS

Document status

IN PROGRESS

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Value Transformations

🏠 Feature Overview

Value Transforms can be defined in the platform at the Advertiser level and at the campaign level. Please refer to Value Transformations to understand about Value Transforms at the Advertiser level. This section describes Value Transforms at the campaign level.

Campaign level value transforms can be accessed from Campaign > Admin menu.

Screenshot 2024-01-09 at 14.04.22.png

Screenshot 2024-01-09 at 16.04.23.png

The Value Transforms table has the following fields:

Name

Notes

Enable Value Transforms

Unless the toggle is enabled, the value transforms will not be enabled on the campaign

ID

Unique ID of the value transform

Label

Name of the Value Transform

Original Name

It is possible to add multiple mail ids

New Name

Original Name of the field on which Value Transform is being applied

Type

Value Transform Type- Manipulate/Transform

Count

Order

Order in which the value transforms must be applied

Last Updated

Date/time the value transform was last updated

Actions

Edit option

The following functionalities are available for Value Transforms:

i. Add

ii. Delete

iii. Edit

iv. Import

v. Enable Value Transforms

The working of Add, Delete, Edit of Value Transforms is similar to that in the Advertisers > Value Transformations section. Please refer the section for details.

Import

At the advertiser level multiple Value transforms may be created and grouped together, as shown below.

Screenshot 2024-01-26 at 16.03.51.png

In the above image, the given Advertiser has 4 different Value Transform fields. They are grouped into 2 Value transform groups as shown.

Screenshot 2024-01-26 at 16.04.01.png

For the given advertiser, the value transform groups may be reused at the campaign level without having to create the same value transforms at the campaign level. This can be done using the ‘Import’ functionality available in Campaign > Admin > Value Transforms.

Screenshot 2024-01-26 at 16.07.31.png

When the 'Import' button is clicked, the below modal opens which shows all Value Transform groups available at the Advertiser level.

Screenshot 2024-01-26 at 16.07.09.png

The user can select the required groups and Import them onto the campaign. Once the value transforms are imported, they will be available in the value transforms table.

Screenshot 2024-01-26 at 16.09.13.png

The values in the table may be edited using the pen icon available or usimg the ‘Edit’option against each value transform.

Enable Value Transforms

Although Value Transforms may be created at campaign level or imported from advertiser level, they will not work until the ‘Enable Value Transforms’ toggle is enabled/turned ON.

Once the toggle is enabled, the user gets the below success message.

Screenshot 2024-01-26 at 16.13.50.png

Similarly, if the toggle is disabled, they will see the below message.

Screenshot 2024-01-26 at 16.14.27.png

However, disabling the toggle does not remove any of the value transforms configurations already created/imported. Any value transforms and manipulation configurations will persist even if the feature is toggled off.

Once the value transforms are created/imported and the toggle is enabled, the user must ensure the QA job for Value Transforms is configured on the campaign for the value transforms to run.

\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

Add Value Transforms

Admin and Agency users can add value transform values using the Add button

2

Edit Value Transforms

Admin and Agency users can edit value transform values using the Edit button or the pen icon available

3

Delete Value Transforms

Admin and Agency users can delete multiple value transform values using the Delete button

4

Import Value Transforms

Admin and Agency users can import value transform groups available at Advertiser level so that they need not be created again at campaign level

5

Enable Value Transforms

Admin and Agency users can enable/disable value transforms at the campaign level. Disabling the toggle does not remove any configured Value transforms.

6

Pagination

Pagination is available on the value transforms table

7

Table Filtering

Allows the user to filter the table values using

\uD83D\uDDD2 User Permissions

Only Admin and Agency users have access to Campaign Value Transforms.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=1693497632

  • No labels