7.2.22 Setup of the Campaign Builder

Accessing the Campaign Builder

The Campaign Builder can be accessed by two different ways:

• via Media Search

• via Campaign Item Related List.

The two options can be set up without major effort by an admin. Please follow the steps below.

Via Media Search

In order to navigate to the Campaign Builder from the Media Search please go to the Administration settings and enable in the section “Media Search” the checkbox Redirect to Campaign Builder.

Via Campaign Item Related List

Existing Campaign Items can be opened and edited via the Campaign Item Related List. To show the Action Button that allows editing items in the Campaign Builder, the following feature settings has to be edited:

• Feature Setting Name: ActionButtons

• Feature Name: CampaignItemRelatedList

Please include in the Value field of the Feature Setting the following record inside of the json structure. You can define the label of the button however you like. Depending on where you would like to show it you can also move it around in the value list:

{
    "title":"Change Items",
    "label":"Change Items",
    "componentDefinition":{
      "componentDef":"ADvendio:campaignBuilderWrapper",
      "attributes":{
          "mode":"edititems",
          "recordId":"$mcId$",
          "campaignItemIds":"$recordIds$"
      }
    },
    "type":"lwc"
}

 Here is a full example of the setting where the Campaign Builder button is second:

{
   "Buttons":[
   {
         "title":"Add Items",
         "label":"Add Items",
         "action":"/apex/ADvendio__SelectSearch?Id=$mcId$",
         "type":"vf"
      },
      {
         "title":"Change Items",
         "label":"Change Items",
         "componentDefinition":{
            "componentDef":"ADvendio:campaignBuilderWrapper",
            "attributes":{
               "mode":"edititems",
               "recordId":"$mcId$",
               "campaignItemIds":"$recordIds$"
            }
         },
         "type":"lwc"
      },
      {
         "title":"Edit Items",
         "label":"Edit Items",
         "action":"/apex/ADvendio__MediaConfiguration?id=$mcId$&selected=$recordIds$",
         "type":"vf"
      },
      {
         "title":"Optimize Items",
         "label":"Optimize Items",
         "action":"/apex/ADvendio__NavigateToOptimizer?id=$mcId$&selected=$recordIds$",
         "type":"vf"
      },
      {
         "title":"Delete Items",
         "label":"Delete Items",
         "action":"/apex/ADvendio__DeleteCampaignItems?id=$mcId$&selectedIds=$recordIds$",
         "type":"vf"
      },
      {
         "title":"Sort Items",
         "label":"Sort Items",
         "action":"/apex/ADvendio__SortCampaignItems?Id=$mcId$",
         "type":"vf"
      },
      {
         "title":"Show Recommendations",
         "label":"Show Recommendations",
         "action":"/apex/ADvendio__ProductRecomm?id=$mcId$",
         "type":"vf"
      },
      {
         "title":"Check Availability",
         "label":"Check Availability",
         "action":"/apex/ADvendio__CheckAvailabilityCi?id=$mcId$&selectedIds=$recordIds$",
         "type":"vf"
      },
      {
         "title":"Submit to AdServer",
         "label":"Submit to AdServer",
         "action":"/apex/ADvendio__SubmitToAdServer?id=$mcId$&selectedIds=$recordIds$",
         "type":"vf"
      },
      {
         "title":"Creative Upload",
         "label":"Creative Upload",
         "action":"/apex/ADvendio__CreativeUploadCi?id=$mcId$&selectedIds=$recordIds$",
         "type":"vf"
      },
      {
         "title":"Update Ad-Status in AdServer",
         "label":"Update Ad-Status in AdServer",
         "action":"/apex/ADvendio__UpdateAdServerAdStatus?id=$mcId$&selectedIds=$recordIds$",
         "type":"vf"
      },
      {
         "title":"Get Delivered Clicks/Impressions",
         "label":"Get Delivered Clicks/Impressions",
         "action":"/apex/ADvendio__DeliveredClicksAndImpressionsImport?id=$mcId$&selectedIds=$recordIds$",
         "type":"vf"
      }
   ]
}

As a result one or many items can be edited via the Campaign item Related List and the Campaign Builder.

Item Configuration Setting

The object “Item Configuration Settings” keeps all configuration needed to run the Campaign Builder and is also allowing to define certain fields and their state to be shown based on conditions.

A default setup of the Item Configuration will be installed with version 2.149 and up.

The following information can be set in the Item Configuration Settings:

• Tabs and Columns: to set up which tabs and which fields per tab will be shown.

• Static Columns: to define which fields should be shown as a part of every tab in the beginning.

• Actions: to define which actions should be offered per row.

• Tab Rules: to define certain fields and their state to be shown based on conditions.

• Page Size: to define a pagination being used to handle big campaigns with a better overview. The number defines how many items will be shown per page (packages count as 1 item).

Tabs and Columns

The block below shows a short example of a possible tab and column setup value. The names define the tab names and the columns contain the field names to the relevant fields you would like to show. Please make sure to add the "fieldpath" in front of every field you would like to add and take also note that the API name needs to be added for the fields. To add our new targeting component to the setup you can simply enter the name “targeting” behind the fieldpath.

[
   {
      "name":"Tab 1",
      "columns":[
         {
            "fieldpath":"ADvendio__from_Date__c"
         },
         {
            "fieldpath":"ADvendio__until_Date__c"
         },
         {
            "fieldpath":"ADvendio__Quantity__c"
         }
      ]
   },
   {
      "name":"Tab 2",
      "columns":[
         {
            "fieldpath":"targeting"
         }
      ]
   }
]

Static Columns

These define which static columns you would like to show as a part of every tab in the beginning.

The block below shows a short example of a possible static column value. You can add more fields by adding a comma after the last field and setting the API name framed in quotes.

["Name","ADvendio__Billing_Category__c"]

Actions

The actions are relevant to offer your user some quick options while working with Campaign items. Currently we support actions to copy items and to delete items.

Please find an example setup in the block below. You can change the boolean values (true or false) if you want to hide certain action on row level or if you want to show certain actions on Package component level.

[
    {
      "label": "Delete",
      "value": "delete",
      "isItemAction": true,
      "isSubitemAction": false
    },
    { "label": "Copy", 
      "value": "copy",
      "isItemAction": true,
      "isSubitemAction": false
    }
]

Page Size

Defines the amount of records to be shown on a page. Package Items are considered as one record regardless the amount of components. Please enter a number depending on your needs.

Tab Rules

The Tab Rules define if certain fields should be hidden under conditions or if certain fields should be shown as read only or required under certain conditions.

The conditions will be connected with the logical Connector AND or OR.

A Tab Rule contains the following information:

• name

• conditions

• readonlyFields

• hiddenFields

• requiredFields

• logicalConnector

• allFieldsReadonly

• applyRuleInChildItem

Where:

Tab Rules Example

In the following example we have one rule:

Hide Sales Price

with logicalConnector AND:

when the condition is met:

user.isactive == true

hide the following field:

advendio__sales_price__c

[
  {
    "name": "Hide Sales Price",
    "logicalConnector": "AND",
    "conditions": [
      {
        "fieldpath": "user.isactive",
        "operator": "==",
        "value": "true"
      }
    ],
    "hiddenFields": [
      "advendio__sales_price__c"
    ]
  }
]

 You can start the field path for the conditions either from the user object as in the example above or from the campaign item with the first relevant field, e.g. "advendio__ad_price__r.advendio__ad_spec__r.advendio__distribution__c" .

Error Handling in Item Configuration Setting

When there is an error in one of the field values due to a wrong JSON you will get an error while saving. Errors are shown with the message: “Please check the json structure.”. If this is happening please check if the values you entered are valid following an online JSON formatter as mentioned above.