ドキュメントDynamic Media 画像制作システム API

createMetadataField createmetadatafield

Last update: Fri Sep 01 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • Developer
  • Admin

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

構文

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

  • IpsAdmin

パラメーター section-f8260bc8dd0a4570bc7f714f81ab975f

入力 (createMetadataFieldParam)

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

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

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

defaultValue
xsd:string
いいえ

作成するメタデータフィールドのデフォルト値 ( 例： Scene7) をクリックします。

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

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