Go to console

    ValueAddedModuleData

    • Value Added Modules require a header and a URI, along with optional fields like body, image, view constraints, and sort index for customization.

    • The module displays a header, body (optional), and image (optional), and directs users to a specified URI upon clicking.

    • View constraints, such as a display interval, can be set to control when the module is shown to users.

    • Modules can be sorted using the sortIndex field, with lower values appearing before higher ones.

    Data for Value Added module. Required fields are header and uri.

    JSON representation 
     { 
 "header" 
 : 
 { 
 object (  LocalizedString 
 
) 
 } 
 , 
 "body" 
 : 
 { 
 object (  LocalizedString 
 
) 
 } 
 , 
 "image" 
 : 
 { 
 object (  Image 
 
) 
 } 
 , 
 "uri" 
 : 
 string 
 , 
 "viewConstraints" 
 : 
 { 
 object (  ModuleViewConstraints 
 
) 
 } 
 , 
 "sortIndex" 
 : 
 integer 
 }
    Fields
    header

    object ( LocalizedString )

    Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
    body

    object ( LocalizedString )

    Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
    image

    object ( Image )

    Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
    uri

    string

    URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking .
    viewConstraints

    object ( ModuleViewConstraints )

    Constraints that all must be met for the module to be shown.
    sortIndex

    integer

    The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.

    ModuleViewConstraints

    Constraints that all must be met for the module to be shown.

    JSON representation 
     { 
 "displayInterval" 
 : 
 { 
 object (  TimeInterval 
 
) 
 } 
 }
    Fields
    displayInterval

    object ( TimeInterval )

    The period of time that the module will be displayed to users. Can define both a startTime and endTime . The module is displayed immediately after insertion unless a startTime is set. The module is displayed indefinitely if endTime is not set.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: