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

createMetadataField

最終更新日： 2024年7月22日

トピック：

作成対象：

開発者
管理者

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

構文

許可されているユーザータイプ

IpsAdmin

パラメーター

入力（createMetadataFieldParam）

パラメーター名	種類	必須	説明
companyName	xsd:string	はい	メタデータフィールドが属する会社の名前。
assetType	xsd:string	はい	アセットタイプ。
の名前	xsd:string	はい	作成するメタデータフィールドの名前。
fieldType	xsd:string	はい	メタデータフィールドタイプ。メタデータフィールドのタイプ定数は、使用可能なタイプを定義します。
defaultValue	xsd:string	いいえ	作成するメタデータフィールドのデフォルト値（例： Scene7）。デフォルト値はタグフィールドタイプではサポートされていないので、省略する必要があります。タグフィールドタイプに空でないデフォルトが指定されている場合は、エラーが返されます。
isHidden	xsd:boolean	いいえ	IPS システム固有のメタデータを表示または非表示にします。
isEnforced	xsd: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>

recommendation-more-help