Loading
Salesforce CMS 與數位體驗應用程式
增強型 CMS 工作區中內容的 JSON 檔案格式

增強型 CMS 工作區中內容的 JSON 檔案格式

瞭解匯出的內容詳細資料,然後以 JSON 格式定義內容詳細資料以供匯入。匯出與匯入流程在增強型 CMS 工作區中的運作方式與在 CMS 工作區中的運作方式不同。在增強型 CMS 工作區中,每個內容項目必須有自己的 content.json 檔案。或者,若要指定每個內容項目的內容索引鍵和資料夾位置,請針對每個 content.json 包含 _meta.json 檔案。

必要版本

提供版本:Lightning Experience
提供版本:EnterprisePerformanceUnlimitedDeveloper Edition

content.json 的 內容內容

content.json 檔案的格式取決於內容類型—新聞、影像、文件、音訊、視訊或自訂內容。每個項目都有不同的內容。增強型 CMS 工作區會將影像、文件、音訊和視訊內容類型視為媒體,且這些內容類型具有類似的內容內文內容。

所有 content.json 檔案都有這些欄位。您可忽略 JSON 中的選用欄位。

欄位名稱 類型 描述
contentBody contentBody

必要。內容內文包含定義內容記錄內文的屬性。內文內容因內容類型而有所不同。

contentKey 字串

由 Salesforce CMS 產生的唯一識別碼。匯入時此欄位為非必要,但是如果忽略或保留空白,匯入後會將新的內容索引鍵指派給內容。如果您包含已存在於 CMS 中的內容索引鍵,則匯入的內容會取代您工作區中的現有內容。

從 Salesforce CMS 匯出的內容會包含此識別碼。

title 字串 必要。內容記錄的標題。此節點是名稱欄位 (NAMEFIELD)。
type 字串

必要。內容類型:

  • 影像的 sfdc_cms__image
  • 文件的 sfcd_cms__document
  • 新聞的 sfcd_cms__news
  • 音訊的 sfdc_cms__audio
  • 影片的 sfdc_cms__video
  • 針對自訂內容類型,使用者定義的任何值。例如,blog

媒體內容內文屬性

sfdc_cms__imagesfdc_cms__documentsfdc_cms__audiosfdc_cms__video 類型具有以下內容內文 (contentBody) 內容。

欄位名稱 類型 描述
sfdc_cms:media source 必要。受管理內容媒體來源節點 (MediaSource)。定義來源的內容。
url 字串 選擇性。影像、文件、音訊或影片的 URL 位址。

source 欄位代表在 sfdc_cms__imagesfdc_cms__documentsfdc_cms__audiosfdc_cms__video 內容類型內的受管理內容媒體來源節點 (MediaSource)。「來源」欄位為必填。

欄位名稱 類型 描述
mimeType 字串 選擇性。媒體來源的 MIME 類型。
ref 字串 選擇性。參照內容的內容索引鍵 (contentKey)。
type 字串 必要。檔案或影像或文件檔案的 URL 位址。有效的 URL 基礎為 http://https://

以下是匯入影像內容記錄的 JSON 結構範例。Salesforce CMS 會在匯入後將內容索引鍵指派給新的內容。

{
  "type" : "sfdc_cms__image",
  "title" : "Trailhead",
  "contentBody" : {
    "sfdc_cms:media" : {
      "source" : {
        "type" : "file",
        "mimeType" : "image/png"
      }
    }
  }
}

以下是匯入文件內容記錄的 JSON 結構範例。Salesforce CMS 會在匯入後將內容索引鍵指派給新的內容。

{
  "type" : "sfdc_cms__document",
  "title" : "Unveiling the Mysteries of Stars_ Exploring the Heart of the Cosmopolitans",
  "contentBody" : {
    "sfdc_cms:media" : {
      "source" : {
        "mimeType" : "application/pdf",
        "ref" : "0sNX200000007r7MAA",
        "type" : "file",
      },
      "url" : ""
    }
  }
}

sfdc_cms__news 內容內文內容

sfdc_cms__news 類型具有以下內容內文 (contentBody) 內容。

欄位名稱 類型 描述
bannerImage bannerImage 選擇性。可在新聞項目中將圖形顯示為橫幅的受管理內容節點 (IMG)。
body 字串 必要。Rich Text 節點 (RTE)。
excerpt 字串 選擇性。用於新聞摘要。此節點是多行文字 (MTEXT)。

bannerImage 欄位代表 sfdc_cms__news 內容類型內的影像節點 (IMG)。

欄位名稱 類型 描述
altText 字串 選擇性。描述內容的存取設定文字。
ref 字串 選擇性。影像的內容索引鍵 (contentKey)。您必須先在增強型 CMS 工作區中匯入此參照的圖形,才能匯入新聞內容記錄。
type 字串 參考類型。針對影像,值為 imageReference
url 字串 來源圖形的路徑。

以下是使用影像內容索引鍵參照影像之新聞項目的JSON結構範例。

{
  "type" : "sfdc_cms__news",
  "title" : "Astronomers Unveil New Stellar Marvel: The Lumina Nova",
  "contentBody" : {
    "bannerImage" : {
      "altText" : "Blue sky with many stars.",
            "source" : {
        "ref" : {
          "contentKey" : "MCDB6GUACSNNGTZAEAI5PGSHA7UY"
        },
        "type" : "imageReference"
      },
      "url" : "/cms/media/MCDB6GUACSNNGTZAEAI5PGSHA7UY"
    },
    "body" : "<div><em>By Xena Bobina, Contributing Writer</em></div><div><br /></div><div>In a groundbreaking discovery that promises to reshape our understanding of the cosmos, astronomers have announced the identification of a previously unknown star, dubbed Lumina Nova.</div><div>Located in the distant reaches of the Milky Way galaxy, Lumina Nova shines with a brilliance unmatched by any other stellar object in its vicinity. Its luminosity far surpasses that of our own Sun, captivating scientists with its dazzling display.</div><div>Dr. Jonathan Reyes, lead astronomer on the research team, described the moment of discovery as nothing short of extraordinary. ,
    "excerpt" : "It's a thrilling opportunity to deepen our understanding of the universe."
  }
}

自訂內容內文屬性

您的內容需要名稱,但其餘的內容類型屬性由您決定。您可根據想匯入的內容類型設定任何節點。以下為一些範例屬性。

備註
備註 針對自訂內容類型,所有選用欄位都可定義為必要。
範例欄位名稱 類型 描述
dateNode 字串 選擇性。日期節點 (DATE)。有效格式為 yyyy-MM-dd。
dateTimeNode dateTimeNode 選擇性。日期時間節點 (DATETIME)。定義內容的日期、時間和時區內文。
nameNode 字串 必要。名稱欄位節點 (NAMEFIELD) 是自由文字欄位。
urlNode 字串 選擇性。內容的 URL 位址。

dateTimeNode 欄位代表自訂內容類型內的受管理內容日期和時間節點 (DateTime)。

欄位名稱 類型 描述
dateTimeValue 字串 選擇性。有效格式為 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 格式的 UTC 日期時間) 日期的有效格式為 YYYY-MM-DD。日期的有效格式為 YYYY-MM-DD。時間的有效格式為 24 小時制。
timeZone 字串 選擇性。有效格式為國家/城市。

以下為 JSON 結構範例,用於匯入自訂內容項目。Salesforce CMS 會在匯入後指派內容索引鍵。

{
    "content": [{
        "type": "customContentType",
        "body": {
            "nameNode": "CustomContentImportTest",
            "urlNode": "http://www.exampletube.com/myVideo",
            "dateNode": "1994-07-01",
            "dateTimeNode": {
                "dateTimeValue": "2008-09-15T15:53:00.000Z",
                "timeZone": "America/Los_Angeles"
            }
        }
    }]
}

_meta.json 的 內容內容

_meta.json 檔案是選擇性的,視內容為現有或新內容而定。如果 .zip 封存中未包含 _meta.json 檔案以供匯入,則會將新內容索引鍵指派給在 content.json 檔案中定義的內容,並放入工作區根資料夾。

欄位名稱 類型 描述
contentKey 字串 選擇性。內容項目的內容索引鍵。
path 字串 選擇性。匯入時不需要此欄位,但如果忽略或保留空白,內容會匯入至工作區的根層級。在資料夾中匯入內容時,請使用此欄位指定資料夾內內容項目的位置。
taxonomyTerms array 選擇性。此欄位包含作為標記套用至內容項目的分類詞彙開發人員名稱。若要匯入含分類字詞的內容,請確定您的組織具有包含這些字詞的內容分類,且您已啟用「檢視內容分類」權限。

以下是 JSON 結構的範例,用於匯入具有分類標記的內容項目,並指定要將內容匯入哪個增強型 CMS 工作區資料夾。

{
  "contentKey" : "MCLYY5A5UXOBH6RHTICCNTAKEXR4",
  "path" : "",
  "taxonomyTerms" : ["Term 1", "Term 2"]
}
備註
備註 JSON 檔案有時會以稱為位元組順序標記的隱藏字元開頭。並非所有文字編輯器皆顯示此字元,且可能導致匯入失敗並顯示檔案讀取錯誤。若要修正此問題,請使用文字編輯器儲存檔案,讓您選擇 UTF-8 編碼。
 
正在載入
Salesforce Help | Article