createMetadataField

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

構文

許可されたユーザーの種類

  • IpsAdmin

パラメータ

入力(createMetadataFieldParam)

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

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

defaultValue xsd:string いいえ

作成するメタデータフィールドのデフォルト値(例: Scene 7)。

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

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

いいえ

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

trueに設定すると、 setAssetMetadata / batchSetAssetMetadataに無効な値が設定された場合に、フォルトがスローされます。

initialTagValue xsd:string いいえ 選択したタグが指す共有列挙値のセットを作成できます。

出力(createMetadataFieldReturn)

名前 種類 必須 説明
*fieldHandle* xsd:string はい 新しいメタデータフィールドへのハンドル。

このコードサンプルは、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>

このページ