createAssetSet

Erstellt einen generischen Asset-Satz mit einer Definitionszeichenfolge für Rohsätze, der auf einem Image-Server veröffentlicht werden soll.

Syntax

Autorisierte Benutzertypen

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

Parameter

Eingabe (createAssetSet)

Name Typ Erforderlich Beschreibung
companyHandle xsd:string Ja Das Handle für das Unternehmen, das den Asset-Satz enthält.
folderHandle xsd:string Ja Der Handle für den Ordner, in dem der neue Asset-Satz erstellt wird.
name xsd:string Ja Asset-Name.
subType xsd:string Ja Eine eindeutige Kennung, die vom Client für den Asset-Set-Typ erstellt wurde.
setDefinition xsd:string Nein Die Parameter in der Definitionszeichenfolge des Sets.

Diese Parameter müssen in das Format aufgelöst werden, das vom Ziel-Viewer angegeben wird.

thumbAssetHandle xsd:string Nein Handle des Assets, das als Miniaturansicht für das neue Bildset dient. Wenn kein Wert angegeben ist, versucht IPS, das erste Bild-Asset zu verwenden, auf das vom Set verwiesen wird.

Ersatzfunktionen für setDefinition

Sie können Ersatzfunktionen inline angeben, die während der Katalogsuche oder -veröffentlichung aufgelöst werden. Ersatzzeichenfolgen haben das Format ${<substitution_func>}. Die verfügbaren Funktionen sind nachfolgend beschrieben.

HINWEIS

Die Handle-Literale in Parameterlisten müssen von Klammern umgeben sein ([]). Sämtlicher Text, der sich außerhalb einer Ersatzzeichenfolge befindet, wird während der Auflösung wörtlich in die Ausgabezeichenfolge kopiert.

Substitutionsfunktion Rückgabe
getFilePath([asset_handle>]) Der Dateipfad der Primärquelle des Assets.
getCatalogId([<asset_handle>]) Die Katalog-ID des Assets.
getMetaData([<asset_handle>], [<metadata_field_handle>]) Metadatenwerte für das Asset.
getThumbCatalogId([<asset_handle>]) Die Katalog-ID des Assets (nur für bildbasierte Assets). Die Katalog-ID des zugehörigen Miniatur-Assets (für andere Assets). Wenn kein verknüpftes Miniatur-Asset verfügbar ist, gibt die Funktion eine leere Zeichenfolge zurück.

Beispiel für Media setDefinition String

${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])}

Beim Katalogabruf oder zur Veröffentlichungszeit wird dieser Prozess in eine Zeichenfolge ähnlich der folgenden aufgelöst:

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

Ausgabe (createAssetSet)

Name Typ Erforderlich Beschreibung
assetHandle xsd:string Ja Das Handle für den Asset-Satz.

Beispiele

Anforderung

<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>

Antwort

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

Auf dieser Seite