FTP-Batch-Bereitstellung: Referenz für das XML-Manifest

Dieses Dokument für die FTP-Batch-Bereitstellung dient als Referenz für das XML-Manifest, das für die Verwendung des FTP-Batch-Bereitstellungssystems von Video Cloud erstellt werden muss. Dieses Dokument enthält ausführliche Informationen und Codebeispiele von den erforderlichen XML-Elementen und Attributen, die Ihre XML-Manifestdatei enthalten muss. Ebenfalls enthalten sind die technischen Informationen zur Ausführung verschiedener Aktionen mit der XML-Manifestdatei wie das Hochladen von Objekten, Erstellen oder Aktualisieren von Videos, Neucodieren von Videos und viele andere Optionen.

Dieser Themenbereich umfasst die folgenden Abschnitte:

• Welchen Nutzen bringt die FTP-Batch-Bereitstellung?
• Voraussetzungen
  
• Überprüfen der XML-Manifestdatei
• XML-Manifestdokumentstruktur
  • Identifizieren des XML-Dokuments
  • Starttag für die XML-Manifestdatei
  • Adresse für die Benachrichtigungs-E-Mail oder den HTTP-Rückruf
  • Allgemeine Aktionen, die mit der FTP-Batch-Bereitstellungs-XML-Manifestdatei ausgeführt werden
    • Identifizieren der Objekte für den Upload
    • Erstellen oder Aktualisieren von Videos mit dem Titelelement
    • Erneute Codierung vorhandener Videos
    • Erstellen oder Aktualisieren von Wiedergabelisten mit dem Aufstellungselement
    • Erstellen von Cue-Points
    • Löschen von Objekten, Videos, Wiedergabelisten oder Cue-Points
  • Endtag für die XML-Manifestdatei 

Welchen Nutzen bringt die FTP-Batch-Bereitstellung?

Mithilfe der Batch-Bereitstellung können Sie mehrere Videos und Wiedergabelisten gleichzeitig hochladen und bereitstellen, indem Sie eine XML-Manifestdatei und den FTP-Server von Video Cloud verwenden. Publisher verwenden oftmals die FTP-Batch-Bereitstellung zum Integrieren ihres Content-Management-Systems (CMS) in die Videoveröffentlichung mittels Video Cloud oder für die Erstaufnahme von Videos in die Video Cloud-Veröffentlichungsdienste.

Voraussetzungen

Bevor Sie fortfahren, sollten Sie sich mit den folgenden Voraussetzungen vertraut machen:

• Die FTP-Batch-Bereitstellung steht nur Kunden von Video Cloud Pro und Enterprise zur Verfügung. Wenn Sie Ihr Video Cloud-Konto heraufstufen möchten, nehmen Sie Kontakt mit Brightcove auf, um weitere Informationen zu erhalten.
• Wenn Sie sich über XML informieren möchten, finden Sie unter Verwenden der FTP-Batch-Bereitstellung grundlegende Ressourcen. Sie können sich auch die folgende Demo ansehen:
  Videoanleitung: Einführung in XML
• Einführende und detaillierte Informationen zu den Verfahren finden Sie unter Verwenden der FTP-Batch-Bereitstellung. Eine Liste mit Links zu verwandten Dokumenten befindet sich oben rechts in diesem Dokument. 
• Beispiel: FTP-Batch-Bereitstellung-XML-Manifestdatei. Laden Sie dieses einfache Beispiel herunter, und informieren Sie sich, wie Sie Video mit der XML-Manifestdatei hochladen. Öffnen Sie diese Datei, und sehen Sie sich die Datei an, während Sie diesen Artikel lesen. Zur Verwendung dieser Datei müssen Sie die Datei so ändern, dass sie mit Ihren Konto- und Umgebungseinstellungen funktioniert.

Überprüfen der XML-Manifestdatei

Sie können Ihre XML-Manifestdatei mit der FTP-Batch-Bereitstellung-Dokumenttypdefinition (DTD) vergleichen. Laden Sie die FTP-Batch-Bereitstellung-Dokumenttypdefinition (DTD) herunter. 

Stellen Sie vor dem Überprüfen Ihrer XML-Manifestdatei unbedingt sicher, dass sie keine ungültigen oder unzulässigen Zeichen enthält, die andernfalls in Escape-Zeichen einzufassen wären. Andernfalls können diese Zeichen zu Fehlern beim Uploadvorgang und zu nicht verfügbaren Objekten führen. Ein Dienstprogramm, das die XML auf Gültigkeit prüft, sollte diese Fehler feststellen können. Nachfolgend wird gezeigt, wie ungültige Zeichen in XML in Ihrem XML-Manifest richtig dargestellt werden sollten:

• & sollte dargestellt werden als &
• < und > sollten dargestellt werden als &lt; und &gt;
• ' und " sollten dargestellt werden als &#39; und &quot;

Diese Einschränkungen gelten für die Werte von XML-Attributen im Manifest; im Text von XML-Elementen, die CDATA gestatten, können diese Zeichen direkt dargestellt werden. Vergleichen Sie z. B., wie der Begriff „Réné & moi“ im <title name >-Attribut und in CDATA innerhalb des <short-description>-Elements dargestellt wird:

<title name="R&#233;n&#233; &amp; Moi" refid="myVideo" active="TRUE" video-full-refid="asset2">
<short-description>
<![CDATA[
Réné et moi remarquons qu'il est tellement romantique,
de manière énigmatique, de se tenir debout sur la terrasse
à Chichen Itza et d'observer la montée de la lune gibbeuse!
]]>
</short-description>
</title>

XML-Manifestdokumentstruktur

Die folgenden Abschnitte beschreiben die Struktur der XML-Manifestdatei, und zwar die erforderliche Syntax und optionale Aktionen, die Sie mit der Datei und dem FTP-Batch-Bereitstellungssystem ausführen können.

Identifizieren des XML-Dokuments

Erforderlich. Dieses Starttag bezeichnet den XML-Dokumenttyp und sieht immer folgendermaßen aus:

<?xml version="1.0" encoding="utf-8"?>

Starttag für die XML-Manifestdatei

Erforderlich. Das für Video Cloud spezifische Tag bezeichnet den Anfang des Upload-Manifests.

Beispiel

<publisher-upload-manifest publisher-id="101" preparer="3rd Street Video" report-success="true">

Das publisher-upload-manifest-Tag verwendet die folgenden Attribute:

Das publisher-upload-manifest-Tag kann mindestens eines der folgenden Tags enthalten. Die einzelnen Tags werden in diesem Dokument detailliert beschrieben:

Adresse für die Benachrichtigungs-E-Mail oder den HTTP-Rückruf

Optional. Das notify-Tag bezeichnet, an welche Adresse Brightcove die E-Mail-Benachrichtigung über einen erfolgreichen oder fehlgeschlagenen Vorgang sendet. Dieses Tag ist nicht erforderlich. Stellen Sie jedoch sicher, dass in Ihrer Organisation eine Benachrichtigung erfolgt, wenn Fehler auftreten. Sie erhalten Benachrichtigungen nur über Fehler, nicht über die erfolgreiche Ausführung, es sei denn Sie haben im publisher-upload-manifest-Tag das report-success="true"-Attribut festgelegt. Verwenden Sie zum Senden der Benachrichtigung an mehrere E-Mail-Adressen eine separate Instanz dieses Tags für jede E-Mail-Adresse. Die Benachrichtigungs-E-Mail hat den Absender donotreply@brightcove.com. Überprüfen Sie, dass E-Mails mit dieser Adresse nicht als Spam ausgefiltert werden.

Beispiel

<notify email="ihrname@example.com"/>
<notify email="meinname@example.com"/>

Das notify-Tag verwendet das folgende Attribut:

notify-Attribut

Neben der Möglichkeit, Benachrichtigungen per E-Mail zu erhalten, können Sie mit dem callback-Tag auch Upload-Benachrichtigungen an eine Webseite senden. Die Benachrichtigung wird unter der im entity-url-Attribut des callback-Tags angegebenen URL veröffentlicht. Die Bereitstellung enthält Folgendes:

referenceId=<die im Manifest angegebene Referenz-ID> 
id=<die ID des Titels, der Wiedergabeliste oder des Objekts in der Datenbank> 
entity=<VIDEO, LINEUP oder ASSET> 
action=<CREATE, DELETE oder UPDATE> 
status=<FAILED,SUCCESS> 
error=<eine Fehlermeldung>

Der Status ist immer im Rückruf-Post enthalten. Beim Status FAILED können die anderen Informationen im Rückruf-Post enthalten sein, abhängig davon, ob die Informationen zum Fehlerzeitpunkt verfügbar sind. Dieses Beispiel zeigt, wie Sie die HTTP-Rückruffunktion im FTP-Batch-Bereitstellungssystem einsetzen können, indem Sie mithilfe von PHP eine Protokolldatei mit den Daten erstellen, die von der FTP-Batch-Bereitstellung generiert wurden.

Beispiel

<callback entity-url="http://example.com/batch-callback.php"/>

callback-Attribut

Allgemeine Aktionen, die mit der FTP-Batch-Bereitstellungs-XML-Manifestdatei ausgeführt werden

In den folgenden Abschnitten werden die verschiedenen Aktionen beschrieben, die Sie mit der FTP-Batch-Bereitstellungs-XML-Manifestdatei ausführen können. Sie können in einer einzelnen XML-Manifestdatei abhängig von den Contentanforderungen mehrere Aktionen oder auch nur eine Aktion ausführen.

Identifizieren der Objekte für den Upload

Optional. Das asset-Tag beschreibt eine Datei, die mit der XML-Manifest-Datei hochgeladen wird. Nehmen Sie für jede hochzuladende Datei ein separates asset-Tag auf.

Beispiel

<asset filename="MyVideo.flv"
       refid="asset1"
       size="188812"
       hash-code="a4ade1e2b09d517ff7360f91527639b3"
       display-name="Mein Video (FLV)"
       type="VIDEO_FULL"/>

Das asset-Tag verwendet die folgenden Attribute:

Objektattribute

Verwenden Sie bei Remoteobjekten das remote-asset-Tag anstelle des asset-Tags, um Ihre Objekte zu bezeichnen. Informationen zur Verwendung von Remoteobjekten und der Attribute des remote-asset-Tags finden Sie unter Erstellen von Videos mit Remote-Videodateien.

Erstellen oder Aktualisieren von Videos mit dem Titelelement

Optional. Das title-Tag beschreibt die zu erstellenden oder hochzuladenden Videos. Verwenden Sie in Ihrem XML-Manifest für alle Videos im Upload separate title-Tags.

Beispiel

<title name="Mein Titel"
       refid="title1"
       active="TRUE"
       start-date="01/01/2007 12:00 AM"
       end-date="01/01/2007 12:00 AM"
       video-full-refid="asset2"
       thumbnail-refid="asset4"
       video-still-refid="asset5"
       flash-prebumper-refid="asset6"
       shared="true"
       economic-type="AD"
       ad-keys=";key=value;key=value" >
    <short-description>Meine Kurzbeschreibung.</short-description>
    <long-description>Meine lange Beschreibung.</long-description>
    <related-link-url>http://Ihre-Firma.com/</related-link-url>
    <related-link-text>Erfahren Sie mehr über uns!</related-link-text>
    <tag>funny</tag>
    <tag>entertaining</tag>
    <logo-overlay
         asset-refid="12345" 
         click-thru="http://www.example.com" 
         tooltip="Weiter zu Beispiel" alignment="bottom right" />
</title>

Titel-Tags enthalten verschiedene Attribute und untergeordnete Tags, die den Feldern, die im Dialogfeld „Video bearbeiten“ des Medienmoduls vorhanden sind, stark ähneln. Indem Sie das Video in Video Cloud Studio bearbeiten, können Sie ein Video so einrichten, dass eine Anzeigenanforderung erfolgt. Sie können hierzu jedoch nicht die FTP-Batch-Bereitstellung verwenden.

Titelattribute

Untergeordnete Elemente der Titel-Tags

Ein title-Tag kann die folgenden untergeordneten Tags enthalten.

Logo-Overlay-Attribute

Optional. Verwenden Sie die XML-Manifestdatei, um mit dem logo-overlay-Tag ein Bild festzulegen, das zum Branding und Generieren von Zugriffen auf einen bestimmten Ort über das Videofenster gelegt wird. Lesen Sie weitere Informationen zu Logo-Overlays. Das logo-overlay-Tag verwendet die folgenden Attribute:

Erneute Codierung vorhandener Videos

Optional. Sie können die XML-Manifestdatei verwenden, um Video Cloud zur erneuten Codierung der Videodateien für ein Video anzuweisen, während alle Metadaten des Videos beibehalten werden. Wenn Sie die vorhandene Quelldatei in Ihrer Video Cloud-Medienbibliothek als Quelle für das Neucodieren verwenden möchten, verwenden Sie das reencode-from-existing-source-Element als untergeordnetes Element des übergeordneten publisher-upload-manifest-Elements. Wenn Sie zusammen mit dem XML-Manifest eine neue Quelldatei (möglicherweise in höherer Qualität) bereitstellen, verwenden Sie das reencode-from-new-source-Element. Lesen Sie die ausführlichen Informationen über das erneute Codieren vorhandener Videos.

Die reencode-from-existing-source-Attribute

<manual-lineup
    name="Meine manuelle Aufstellung"
    refid="lineup1"
    thumbnail-refid="asset4"> <title-refid>title1</title-refid>
  <title-refid>title3</title-refid>
  <title-refid>title137</title-refid>
</manual-lineup>

<automatic-lineup name="Meine automatische Aufstellung"
    refid="lineup2"
    type="NEWEST_TO_OLDEST"
    tag-filter="AND"
    title-limit="50"
    thumbnail-refid="asset4">
  <title-tag>sporty</title-tag>
</automatic-lineup>

<cuepoint name="MCue" type="CODE" time="500000" video-refid="video001" />
<cuepoint name="Zweiter Cue" type="AD" time="50000" video-refid="video001" />
<cuepoint name="Dritter Cue" type="AD" time="120000" video-refid="video001">
  <metadata>Interessante Informationen zu diesem Cue-Point.</metadata>
</cuepoint>
<cuepoint name="Vierter Cue" type="AD" time="270000" video-refid="video055">
  <metadata>
    <![CDATA[
 Dies ist ein mehrzeiliger Satz Metadaten
    ]]>
  </metadata>
</cuepoint>

<delete-asset refid="RandomAssetsRefID"/>
<delete-title refid="RandomTitlesRefID"/>
<delete-lineup refid="RandomLineupsRefID"/>
<delete-cuepoint video-refid="video0001" id="0123456789"/>

</publisher-upload-manifest>