createAssetSet

Image Serverに公開する未加工のセット定義文字列を持つ汎用アセットセットを作成します。

構文

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

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

パラメータ

入力(createAssetSet)

名前 種類 必須 説明
companyHandle xsd:string はい アセットセットを含む会社のハンドル。
folderHandle xsd:string はい 新しいアセットセットが作成されるフォルダーへのハンドル。
name xsd:string はい アセット名。
subType xsd:string はい アセットセットタイプに対してクライアントが作成した一意の識別子。
setDefinition xsd:string いいえ セット定義文字列のパラメーター。

これらは、対象のビューアで指定された形式に解決する必要があります。

thumbAssetHandle xsd:string いいえ 新しい画像セットのサムネールとして機能するアセットのハンドル。 指定しなかった場合、IPSはセットが参照する最初の画像アセットを使用しようとします。

setDefinitionの代替関数

カタログの参照またはパブリッシュ時に解決される行で置換関数を指定できます。 置換文字列の形式は${<substitution_func>}です。 使用可能な関数を以下に列挙します。

メモ

パラメーターリストのハンドルリテラルは、角括弧([])で囲む必要があります。 置換文字列の外にあるすべてのテキストは、解決時に出力文字列に字句でコピーされます。

置換関数 戻り値
getFilePath([asset_handle>]) アセットのプライマリソースファイルパス。
getCatalogId([<asset_handle>]) アセットのカタログID。
getMetaData([<asset_handle>], [<metadata_field_handle>]) アセットのメタデータ値。
getThumbCatalogId([<asset_handle>]) アセットのカタログID(画像ベースのアセットのみ)。関連付けられたサムアセットのカタログID(他のアセットの場合)。 関連するサムアセットがない場合、この関数は空の文字列を返します。

メディアsetDefinition文字列のサンプル

${getCatalogId([a|1664|22|1664])};${getCatalogId([a|1664|22|1664])};1,${getFilePath([a|103 
6|19|144])};${getCatalogId([a|452|1|433])};2;${getMetadata([a|1036|19|144], [m|1|ASSET|SharedDateField])} 

カタログ参照または公開時に、次のような文字列に解決されます。

jcompany/myRenderSet;jcompany/myRenderSet;1,jcompany/Videos/Somebodys_N08275_flv.flv;jcomp any/myimg-1;2;20090703 10:05:53

出力(createAssetSet)

名前 種類 必須 説明
*assetHandle* xsd:string はい アセットセットのハンドル。

リクエスト

<createAssetSetParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31"> 
   <companyHandle>c|1</companyHandle> 
   <folderHandle>f|jcompany/AssetSets/</folderHandle> 
   <name>testAssetSet</name> 
   <subType>MediaSet</subType> 
</createAssetSetParam>

応答

<createAssetSetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31"> 
   <assetHandle>a|1801|44|1801</assetHandle> 
</createAssetSetReturn>

このページ