CData Python Connector for Salesforce Marketing Cloud

Build 25.0.9454

GetChannelViewHtml

Returns the compiled HTML for a specified channel view within Salesforce Marketing Cloud. This output represents the final rendered content of an asset, allowing developers to preview or validate HTML rendering for a channel or campaign.

Input

Name Type Required Description
AssetId Integer True Specifies the unique identifier (Id) of the asset whose view content is to be retrieved. This value identifies the source asset in Content Builder and determines which file or message content is compiled.
ViewName String True Specifies the name of the asset view to retrieve. Common view types include 'HTML', 'Text', and 'Preview'. This value determines which version of the asset content is returned by the stored procedure.
Thumbnail Boolean False A Boolean field that is set to a value of 'true' to return a base64-encoded thumbnail image of the compiled content. It is set to a value of 'false' to return the complete HTML view instead of a thumbnail representation.
IncludeHeaderFooter Boolean False A Boolean field that is set to a value of 'true' to include the message header and footer in the returned content when the asset contains HTML or text views. It is set to a value of 'false' to exclude header and footer content from the output.
IncludeDesignContent Boolean False A Boolean field that is set to a value of 'true' to include additional design content, such as layout elements and design-time components, in the returned thumbnail image. It is set to a value of 'false' to return only the rendered message body.
DownloadPath String False Specifies the full file path where the compiled HTML output is saved. This parameter determines the local or network storage location for the rendered asset view.
Encoding String False Specifies the encoding type of the FileData input that is used when saving the compiled HTML file. The encoding ensures correct character rendering and compatibility with the chosen file format.

The allowed values are NONE, BASE64.

The default value is BASE64.

Result Set Columns

Name Type Description
Success Boolean A Boolean field that returns a value of 'true' when the download or view retrieval operation completes successfully. It returns a value of 'false' when the operation fails due to an invalid path, permissions issue, or compilation error.
Compiled String Returns the fully rendered representation of the specified asset view. Depending on parameters, this output can contain the complete HTML markup or the Base64-encoded thumbnail image that represents the rendered asset.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454