ドキュメント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）

パラメーター名
種類
必須
説明
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
はい
新しいメタデータフィールドへのハンドル。

例 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