文件Dynamic Media Image Production System API

createMetadataField createmetadatafield

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：

建立對象：

  • 開發人員
  • 管理員

可讓管理員建立中繼資料欄位，以協調內容管理系統或範本操作。 建立的中繼資料欄位範例包括關鍵字、影像作者的相關資訊或版權持有人資訊。

語法

授權的使用者型別 section-2f61d79f8cac4692bfa53b95035ddd89

  • IpsAdmin

參數 section-f8260bc8dd0a4570bc7f714f81ab975f

輸入(createMetadataFieldParam)

引數名稱
類型
必要
說明
公司名稱
xsd：string
是
中繼資料欄位所屬的公司名稱。
資產型別
xsd：string
是
資產型別。
名稱
xsd：string
是
您正在建立的中繼資料欄位名稱。
fieldType
xsd：string
是

中繼資料欄位型別。

中繼資料欄位型別常數會定義可用的型別。

defaultValue
xsd：string
否

要建立的中繼資料欄位的預設值（例如， Scene 7）。

標籤欄位型別不支援預設值，必須省略。 如果為標籤欄位型別指定了非空白的預設值，則會傳回錯誤。

isHidden
xsd：布林值
否
隱藏或公開IPS系統特定的中繼資料。
已強制
xsd：布林值
否

布林值標幟，指出在設定值時，是否強制執行（驗證）中繼資料欄位。

若設為true，則若在 setAssetMetadata / batchSetAssetMetadata中設定了不合法的值，則會擲回錯誤。

initialTagValue
xsd：string
否
它可讓您建立一組所選標籤可指向的共用特定值。

輸出(createMetadataFieldReturn)

名稱
類型
必要
說明
fieldHandle
xsd:string
是
新中繼資料欄位的控制代碼。

範例 section-ba66be30f36b4aeba1bc721b0b92fdfc

這個程式碼範例會建立名為createMetadataField的字串型別中繼資料欄位。 回應會將控制代碼傳回至新的中繼資料欄位。

要求

<createMetadataFieldParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
   <assetType>Image</assetType>
   <name>createMetadataField</name>
   <fieldType>String</fieldType>
   <initialTagValue>Fall</initialTagValue>
   <defaultValue>Default</defaultValue>
</createMetadataFieldParam>

回應

<createMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <fieldHandle>m|21|IMAGE|createMetadataField</fieldHandle>
</createMetadataFieldReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681