Skip to content

Settings

The settings.json file in the project root directory stores the messenger ad template settings. When you initialize the messenger ad scaffolding template, this is the default configuration of the settings.json file.

json
{
  "name": "messenger-ad-3",
  "id": "a2bdcf85-47ff-49d9-bff9-d844e05852bb",
  "metadata": {
    "targetMessenger": {
      "default": "wechat",
      "current": "wechat"
    }
  },
  "localization": {
    "current": "eng",
    "original": "",
    "langs": [
      "eng"
    ]
  },
  "screenshoter": {
    "delay": 1000,
    "icons": {
      "blocks": {
        "width": 150,
        "enabled": true,
        "mode": "view"
      }
    }
  },
  "clms": {
    "irep": {
      "assetFileNameTemplate": "{settings.name}_slide_{settings.id}",
      "customSwipe": true,
      "swipeSensitivity": 400,
      "irepDisplayOrder": false,
      "vault": {
        "presentation": {
          "name__v": "{settings.name}",
          "title__v": "{settings.name}",
          "external_id__v": "{settings.clms.irep.vault.presentation.name__v}_{settings.id}",
          "clm_content__v": "false",
          "cobrowse_content__v": "false",
          "engage_content__v": "true",
          "shareable_in_wechat_wec__v": "true",
          "website__v.name__v": "Approved WeChat"
        },
        "keyMessage": {
          "name__v": "{settings.name}_slide",
          "title__v": "{settings.name}_slide",
          "external_id__v": "{settings.clms.irep.assetFileNameTemplate}",
          "clm_content__v": "false",
          "engage_content__v": "true",
          "crm_media_type__v": "HTML"
        }
      },
      "crm": {
        "presentation": {},
        "keyMessage": {
          "Name": "{settings.name}_slide",
          "Product_vod__c": "",
          "Description_vod__c": "{settings.name}_slide"
        }
      }
    }
  },
  "browserslist": [
    "last 2 versions"
  ]
}
FieldDescription
nameThe messenger ad template name.
idThe unique ID of the created messenger ad.
metadataInformation about the default and current target messenger. For more information, see Target messenger settings.
localizationInformation about the current localization and available languages of the messenger ad template.
screenshoter.delayThe delay with which the icon is generated in milliseconds. For more information, see Set delay for generating a screenshot.
screenshoter.icons.blocks.enabledA boolean property that defines if the automatic generation of block icons is on. The default value is false. For more information, see Generate icons for blocks.
screenshoter.icons.blocks.widthDefines the width of the generated block icons in pixels. The property works if the screenshoter.icons.blocks.enabled is true. For more information, see Set generated icon width.
screenshoter.icons.blocks.modeDefines if the block icons are generated as in the Editor PREVIEW or EDIT mode. The default value is view. The property works if the screenshoter.icons.blocks.enabled is true. For more information, see Icons for view/edit mode.
clmsSettings for messenger ad export for specific target systems.
browserslistDefine the supported browsers for demonstrating your messenger ad. This configuration is applicable in prefixing the CSS rules and polyfilling JS. The exporting engine applies these settings only when building the messenger ad for the target CLM app. For more information, see the Browserslist configuration syntax.

For more information about settings in other template types, see Configuration.