ドキュメントAEMDynamic Media Image Production System API

createMetadataField createmetadatafield

最終更新日： 2025年8月14日

作成対象：

  • Developer
  • Admin

管理者は、コンテンツ管理システムと連携したり、テンプレートを操作したりするためのメタデータフィールドを作成できます。 作成されたメタデータフィールドの例には、キーワード、画像の作成者に関する情報、著作権者情報などがあります。

構文

承認済みユーザータイプ section-2f61d79f8cac4692bfa53b95035ddd89

  • IpsAdmin

パラメーター section-f8260bc8dd0a4570bc7f714f81ab975f

入力（createMetadataFieldParam）

パラメーター名
種類
必須
説明
companyName
xsd:string
はい
メタデータフィールドが属する会社の名前。
assetType
xsd:string
はい
アセットタイプ：
名
xsd:string
はい
作成するメタデータフィールドの名前。
fieldType
xsd:string
はい

メタデータフィールドタイプ：

メタデータフィールドタイプ定数は、使用可能なタイプを定義します。

defaultValue
xsd:string
いいえ

作成するメタデータフィールドのデフォルト値（例： Scene 7）。

タグフィールドタイプではデフォルト値はサポートされていないので、省略する必要があります。 タグフィールドタイプに空でないデフォルトが指定されている場合、障害が返されます。

は非表示
xsd:boolean
いいえ
IPS システム固有のメタデータを非表示または公開します。
は強制
xsd:boolean
いいえ

値が設定されたときにメタデータフィールドが適用（検証）されるかどうかを示すブール値フラグ。

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
dynamic-media-developer-resources-help-aem-ips-api