Vai al contenuto principale
English
Help Desk

Data structures > Communications and contents

Aggiornato

Communications

MNNewsletter

Field Type
idNewsletter String
idEditor String
idCampaign String
name String
creationDate Date
expectedDeliveryTs Date
sent Boolean
emailChannelEnabled Boolean
smsChannelEnabled Boolean
faxChannelEnabled Boolean
tags List of FieldValue
defaultTarget List of String representing idgroups of representing the default target of the communication

MNNewsletterDetails

Field Type  
idNewsletter String  
idEditor String  
idCampaign String  
name String  
creationDate Date  
sent Boolean  
values List of FieldValue Available values
  • subject: subject of the email
  • fromname: display name of the from header of the email
  • fromemail: email address of the from header of the email
  • smsbody: body of the SMS text
  • smsfrom: sender name of the SMS text
  • year (advanced usage)
  • number (advanced usage)
  • absplittype (advanced usage)
  • layout: contains the code of the communication
  • lastmodificationdate
  • firstlaunchdate: date of the first launch
  • customheader_1.....X: custom email headers
  • overridetextversion: text fixed version (if not calculated automatically from html version)
  • idplanneddelivery: id of the MNPlannedDelivery which the communication is bound to
  • enableemail: value=true if the email channel is enabled
  • enablesms: value=true if the sms channel is enabled
  • subjectmode: "simple": single subject; "bylanguage": based on contact field "LINGUA" value; "conditional": based on a custom condition
  • subject_[lang_id]: Evalutated for subjectmode="bylanguage". For example if a communication specify a subject only for italian contacts this subject will be returned in a "subject_ITA" option.
  • conditionsids: Evalutated for subjectmode="conditional". List of comma separated strings containing the names of each subject cases. For example: "Condition 1,cond2"
  • condition_[cond_id]: Evalutated for subjectmode="conditional". Each of this option contains a single condition. For example "condition_Condition 1"
  • subject_[cond_id]: Evalutated for subjectmode="conditional". Each of this option contains a single subject. For example "subject_Condition 1"
  • smsencoding: encoding of the SMS body (string)
  • enablelongsms: enable long SMS (boolean)
  • maxsmsparts: number of message parts
  • enablesmslinkstracking: enable link tracking (boolean)

FillNewsletterData

Field Type  
data List of ContentData  

MNPlannedDelivery

Field Type  
idPlannedDelivery String  
idNewsletter String  
idGroup String  
name String  
targetSize int  
referenceDate date  
targetActions List of PlannedDeliveryTargetAction  
details List of FieldValue Available values:  
cost_model (type of cost mode, can be CP_CLICKED, CP_OPENED, CP_CONVERTED, CP_SENT)  
cost_model_parameter (parameter for the cost model, formatted using current user localization settings)  
mediacenter_name (name of the media center/agency)  
mediacenter_reportsemail (emails of the media center/agency)  
customer_name (name of the customer)  
customer_reportsemail (emails of the customer)  

PlannedDeliveryTargetAction

Field Type  
description String  
idDatabase String  
contactsCount int  
actionType String, can be contactsadded, contactsremoved or other  

ContentData

Field Type  
values List of FieldValue  

Contents

Content

Field Type Description
name String Name of the content.
designerType String Set it to "giotto".
magnewsType String Name of the content type that defines the structure of the content.
Built-in types: "html", "article", "link", "content".
contentType String Standard MIME type.
binaryPayload Byte[] Used to contain binary content data, e.g. images.
binaryPayloadEncoding String Encoding of data in field binaryPayload (default UTF-8)
text String Used to contain textual content data, e.g. HTML code.
baseUrl String If the object Content contains HTML text, this will be analysed and in MagNews are loaded all the related resources, URLs are considered related to this field.
tags List of FieldValue List of tags for the content with:
FieldValue.key=id of existing Tag
FieldValue.value=1
values List of FieldValue  
idnewsletter String Id of the communication where to insert the content.
idcampaign String Id of the journey where to insert the content.
idwebsite String Id of the website where to insert the content.
idparent String Id of the parent content where to insert the content.

Media

Media

Field Type  
binaryPayload Byte[]  
contentType String  
description String  
height int  
idcampaign String  
idcontent String  
idmedia String  
idnewsletter String  
idwebsite String  
name String name of file to upload
title String title of the media
width int  

Tags

MNContentTag

Field Type
idTag String
name Boolean
type String
values List of FieldValue