Skip to main content
Sign in

Search

Flight Control Help Center

Custom Coded Ads: Building Parameters using Manifest

  • Updated

General

There are two methods available for creating dynamic parameters:

  • Within the Flight Control Template Editor UI after creating a template.
  • Using a Manifest.json file during local development, prior to template creation.

The Manifest.json option offers an alternative way to create dynamic parameters during the development stage of a custom code template. Upon upload of your ad file package, dynamic parameters will automatically be created based on the settings defined in your manifest.

This article provides an example manifest and explains the possible node and value settings required when creating your own dynamic parameters. For more information, refer to the ‘Using ClinchSdk during design/development phase (sandbox - local environment)’ section of the ‘Creating Custom Coded HTML Ads using ClinchSdk’ article.

Prerequisite icon.png Prerequisites

Understanding of Custom Code and ClinchSdk is needed. Reference the articles below to learn about these topics.

  1. Custom Coded HTML Ads
  2. Creating Custom Coded HTML Ads
  3. ClinchSdk API reference

Template Settings

  • Feature Types: These features are controlled using Boolean values. The available feature types are as follows:

    FEATURE UI NAME  CODE EQUIVALENT
    Location location
    Content content
    Product product
    Weather weather

    Example:

    Features with Content.png

  • Fonts
    • Controls which fonts appear in the text editor and template info UI.
    • Fonts must be uploaded with your ad package and defined in the manifest if you expect this information to be displayed in the info panel of your template.

Example:

manifest_fonts example.png

  • Product Types:
    • Clinch provides a range of product types to choose from. The appropriate product type must be selected for the ad template.

    • The available product types and their corresponding code equivalents are listed below:

      PRODUCT TYPE UI NAME  CODE EQUIVALENT
      Ecommerce Ecommerce
      Flight Flight
      Hotel Hotel
      Package Package
      Car Rental Car_rental
      Car Car
      Activity Activity
      CPG CPG
      SPORTS  
      Sports Team SportsTeam
      Soccer Team SoccerSportsTeam
      American Football Team AmericanFootballSportsTeam
      Baseball Sports Event BaseballSportsEvent
      Soccer Sports Event SoccerSportsEvent
      Basketball Sports Event BasketballSportsEvent
      American Football Sports Event AmericanFootballSportsEvent
      Soccer Player SoccerPlayer
      Hockey Sports Event HockeySportsEvent

      Example:

manifest_product type example.png

Note: The minimum/maximum number of products is reduced to one (1) when using the Sports product type.

  • Dynamic Parameter Values Reference

    TYPE UI NAME CODE EQUIVALENT
    Text TEXT
    Image IMAGE
    Video VIDEO
    Color COLOR
    Link LINK
    Selector SELECTOR
    Widget WIDGET
    CATEGORY UI NAME CODE EQUIVALENT
    Background Background
    Brand Brand
    CTA button CTA_Button
    Creative images Creative_Images
    Full size promo slide Full_Size_Promo_Slide
    General General
    General promotions General_Promotions
    Interactive HTML Interactive_HTML
    Item info Item_Info
    Legal image 1
    Messages 1 Messages_1
    Messages 2 Messages_2
    Messages 3 Messages_3
    Other Other
    Price Price
    Tags Tags

Example:

manifest_dynamic parameter example.png

 

Important Notes

  • Future updates with a zip upload: New zip file uploads will overwrite the existing manifest.json file. To retain any edits made directly to the template in the UI, download the ad package from the template before making additional changes.
  • To download the ad package and updated manifest.json, follow these steps:
    • Hover over the template and click the "Edit" button.
    • Open the "Actions" menu and select "Export".
    • The zip file will contain the ad package(s) and updated manifest.json.

manifest_zip file.png