YouTube API-Dienste – Erforderliche Mindestfunktionen

Hinweis:Im Hilfeartikel Einhaltung der YouTube-Richtlinien für Entwickler findest du Informationen und Beispiele, mit denen du dafür sorgen kannst, dass deine API-Clients bestimmte Teile der Nutzungsbedingungen und Richtlinien für YouTube API-Dienste einhalten. Der Leitfaden gibt Aufschluss darüber, wie YouTube bestimmte Aspekte der API-Nutzungsbedingungen durchsetzt, ersetzt aber keine vorhandenen Dokumente.

In diesem Dokument werden Mindestanforderungen an die Funktionalität von API-Clients definiert, die bestimmte Funktionen von YouTube API-Diensten implementieren oder Zugriff darauf gewähren („API-Clients“).

Mit diesen Anforderungen und Richtlinien soll sichergestellt werden, dass API-Clients eine einheitliche Nutzererfahrung bieten, die die Interessen von YouTube-Nutzern, Rechteinhabern und Werbetreibenden schützt. Diese Regeln sind ein wesentlicher Bestandteil der Nutzungsbedingungen für die YouTube API und müssen bei der Entwicklung und Implementierung von API-Clients eingehalten werden.

Die Anforderungen in diesem Dokument können sich ändern, damit wir die Nutzerfreundlichkeit der bestehenden YouTube-Funktionen weiter verbessern können. Sie ändern sich auch aufgrund neuer und aktualisierter YouTube-Funktionen. Gelegentlich müssen Sie Ihre API-Clients aufgrund solcher Änderungen aktualisieren, um neuen Anforderungen gerecht zu werden. Alle Änderungen werden im Änderungsverlauf der Nutzungsbedingungen dokumentiert. Sehen Sie sich dieses Dokument daher regelmäßig an oder abonnieren Sie den RSS-Feed, um schnell über Änderungen informiert zu werden, die sich auf Ihre API-Clients auswirken können.

Zusätzlich zu den Anforderungen in diesem Dokument empfehlen wir dir dringend, die Best Practices zu befolgen, die in den Richtlinien für YouTube API-Dienste und an anderer Stelle in der Dokumentation der YouTube API-Dienste beschrieben werden. Auch wenn dies nicht unbedingt erforderlich ist, helfen diese Praktiken deinen API-Clients, sich schneller von Fehlern zu erholen und die Kontingentnutzung zu optimieren, wenn sie YouTube API-Dienste verwenden, für die ein Kontingent zugewiesen wird. Gleichzeitig tragen diese Praktiken dazu bei, die Stabilität des YouTube-Systems zu gewährleisten und vor allem Nutzern deiner API-Clients und YouTube-Anwendungen die bestmögliche Nutzererfahrung zu bieten.

Eingebetteter YouTube-Player und Videowiedergabe

Die Anforderungen in diesem Abschnitt beziehen sich speziell auf eingebettete YouTube-Player. Die Richtlinien für YouTube API-Dienste enthalten auch mehrere Richtlinien, die für API-Clients relevant sind, die audiovisuelle Inhalte von YouTube wiedergeben.

Größe des eingebetteten YouTube-Players

Eingebettete Player müssen einen Darstellungsbereich mit mindestens 200 x 200 Pixel haben. Wenn die Steuerung angezeigt wird, muss der Player groß genug sein, um die Steuerelemente vollständig anzuzeigen, ohne dass der Darstellungsbereich dabei die genannte Mindestgröße unterschreitet. Für 16:9-Player empfehlen wir eine Breite von mindestens 480 Pixel und eine Höhe von mindestens 270 Pixel.

Automatische und scriptbasierte Wiedergabe

In diesem Abschnitt geht es um automatische Wiedergaben. Sie gilt für eingebettete YouTube-Player, die entweder den Player-Parameter autoplay verwenden oder die automatische Wiedergabe programmatisch über den YouTube IFrame Player API-Dienst oder einen anderen YouTube API-Dienst initiieren.

  • Eingebettete Player, die ein Video automatisch wiedergeben, sollten die Wiedergabe sofort starten, wenn die Seite geladen ist oder sobald der eingebettete Player vollständig sichtbar ist. Ein API-Client darf jedoch erst dann eine automatische Wiedergabe starten, wenn der Player sichtbar ist und mehr als die Hälfte des Players auf der Seite oder dem Bildschirm zu sehen ist.

  • Auf einer Seite oder einem Bildschirm darf sich nur ein YouTube-Player befinden, der Inhalte automatisch gleichzeitig wiedergibt.

  • YouTube-Vorschaubilder, die eine Wiedergabe auslösen, müssen mindestens 120 Pixel breit und 70 Pixel hoch sein.

YouTube-Player-Attribute

Attribute und Parameter des YouTube-Players, einschließlich des Erscheinungsbildes des YouTube-Brandings im Player, sind in der YouTube API-Dokumentation und den Spezifikationen (https://developers.google.com/youtube) angegeben. Du darfst keine Änderungen am YouTube-Player vornehmen, die nicht ausdrücklich in der API-Dokumentation beschrieben sind.

Overlays und Frames

Overlays, Frames oder andere visuelle Elemente dürfen nicht vor einem Teil eines eingebetteten YouTube-Players eingeblendet werden, einschließlich der Playersteuerung. Ebenso dürfen keine Overlays, Frames oder anderen visuellen Elemente verwendet werden, um Teile eines eingebetteten Players zu verdecken, einschließlich der Playersteuerung.

Mouseovers

Sie dürfen keine Mouseover- oder Touch-Ereignisse in einem YouTube-Player verwenden, um im Namen des Nutzers Aktionen auszuführen, z. B. ein Fenster zu öffnen oder einen Kanal zu abonnieren.

Hochladen von Videos

Wenn API-Clients Nutzern das Hochladen von Inhalten auf mehrere Plattformen ermöglichen, sollten Nutzer die Plattformen, auf die sie ihre Videos hochladen möchten, auswählen und die Auswahl wieder aufheben können.

Datenanforderungen

API-Clients, die Nutzern das Hochladen von Videos auf YouTube ermöglichen, müssen es Nutzern ermöglichen, die Werte in der folgenden Liste festzulegen. Alle nicht aufgeführten Properties sind optional.

  Name Beschreibung
Ressourceneigenschaften
snippet.title Erforderlich. Der Titel des Videos. YouTube gibt einen Fehler zurück, wenn der Wert mehr als 100 Zeichen hat. YouTube unterstützt alle gültigen UTF-8-Zeichen mit Ausnahme von < und >.

snippet.description Erforderlich. In der Videobeschreibung. YouTube gibt einen Fehler zurück, wenn der Wert 5.000 Byte überschreitet. YouTube unterstützt alle gültigen UTF-8-Zeichen mit Ausnahme von < und >.
status.privacyStatus Erforderlich. Die Datenschutzeinstellung des Videos. Nutzer müssen auswählen können, ob das hochgeladene Video öffentlich, privat oder nicht gelistet sein soll.
Anfrageparameter
onBehalfOfContentOwnerChannel Bedingt erforderlich Wenn die Autorisierungs-Anmeldedaten der Anfrage einen Rechteinhaber identifizieren und der Parameter onBehalfOfContentOwner festgelegt ist, muss der API-Nutzer auch den YouTube-Kanal angeben können, auf den das Video hochgeladen wird.

Kommentare anzeigen

  Name Beschreibung
Ressourceneigenschaften
snippet.textDisplay Erforderlich. Der Text des Kommentars. Der API-Client muss entweder (a) den vollständigen Text eines Kommentars oder einer Kommentarantwort anzeigen oder (b) den Text abschneiden und den Zuschauern eine Möglichkeit bieten, über die gekürzte Version auf den vollständigen Text zuzugreifen.

Diese Anforderung gilt für alle Kommentare und Kommentarantworten, unabhängig davon, mit welcher Art von Ressource die Kommentare verknüpft sind (Videos, Kanäle usw.).

Der Wert des Attributs snippet.topLevelComment der Ressource commentThread ist eine comment-Ressource und das Attribut replies.comments[] ist eine Liste von comment-Ressourcen. Daher gilt diese Anforderung auch für die Properties snippet.topLevelComment.snippet.textDisplay und replies.comments[].snippet.textDisplay.
snippet.title
(channel)
Erforderlich (Vorschlag). Der Titel des Kanals.
  • Wenn sich der Kommentar auf einen Kanal bezieht, muss der API-Client den Namen des Kanals anzeigen.
  • Wenn sich der Kommentar auf ein Video bezieht, muss der API-Client den Namen des Kanals anzeigen, auf dem das Video hochgeladen wurde.
snippet.title
(video)
Bedingt erforderlich (Vorschlag) Der Titel des Videos. Dieser Wert muss angezeigt werden, wenn sich der Kommentar auf ein Video bezieht.
snippet.moderationStatus Bedingt erforderlich Wenn der Parameterwert moderationStatus in der API-Anfrage heldForReview oder likelySpam ist, muss der Status anhand des Property-Werts, einer ähnlichen Formulierung (z.B. „Dieser Kommentar wird zur Überprüfung zurückgehalten“), einer Überschrift (z.B. „Zur Überprüfung zurückgehalten“) oder einer anderen eindeutigen Formulierung klar angegeben werden. Mit der Methode commentThreads.list können Kommentare basierend auf ihrem Moderationsstatus abgerufen werden.

Kommentare hinzufügen

  Name Beschreibung
Ressourceneigenschaften
snippet.title
(channel)
Erforderlich. Der Titel des Kanals.
  • Wenn der Nutzer einen Kommentar zu einem Kanal hinzufügt, muss der API-Client den Namen des Kanals anzeigen.
  • Wenn der Nutzer einen Kommentar zu einem Video hinzufügt, muss der API-Client den Namen des Kanals anzeigen, auf dem das Video hochgeladen wurde.
snippet.title
(video)
Erforderlich. Wenn der Nutzer einen Kommentar zu einem Video hinzufügt, muss der API-Client den Titel des Videos anzeigen.
Weitere Anforderungen
Comment author's channel name Erforderlich. Der API-Client muss das YouTube-Nutzerkonto eindeutig identifizieren, dem der Kommentar zugeordnet werden soll. Wenn die Autorisierungs-Anmeldedaten der Anfrage einen Rechteinhaber identifizieren und der Parameter onBehalfOfContentOwner festgelegt ist, muss der API-Nutzer auch den YouTube-Kanal angeben können, dem der Kommentar zugeordnet werden soll.

Antworten auf Kommentare hinzufügen

  Name Beschreibung
Ressourceneigenschaften
snippet.textDisplay Erforderlich. Der Text des Kommentars. Der API-Client muss den Text des Kommentars, auf den der Nutzer antwortet, gemäß den Regeln anzeigen, die im Abschnitt Kommentare anzeigen dieses Dokuments definiert sind.
snippet.title
(channel)
Erforderlich. Der Titel des Kanals.
  • Wenn der Nutzer auf einen Kommentar zu einem Kanal antwortet, muss der API-Client den Namen des Kanals anzeigen.
  • Wenn der Nutzer auf einen Kommentar zu einem Video antwortet, muss der API-Client den Namen des Kanals anzeigen, auf dem das Video hochgeladen wurde.
snippet.title
(video)
Erforderlich. Wenn der Nutzer auf einen Kommentar zu einem Video antwortet, muss der API-Client den Titel des Videos anzeigen.
Weitere Anforderungen
Comment author's channel name Erforderlich. Der API-Client muss das YouTube-Nutzerkonto eindeutig identifizieren, dem die Antwort auf den Kommentar zugeordnet werden soll. Wenn die Autorisierungs-Anmeldedaten der Anfrage einen Rechteinhaber identifizieren und der Parameter onBehalfOfContentOwner festgelegt ist, muss der API-Nutzer auch den YouTube-Kanal angeben können, dem die Antwort auf den Kommentar zugeordnet werden soll.

Kommentarantworten bearbeiten oder löschen

  Name Beschreibung
Ressourceneigenschaften
snippet.textDisplay Erforderlich. Der Text des Kommentars. Der API-Client muss den Text des Kommentars, den der Nutzer bearbeiten oder löschen möchte, gemäß den Regeln anzeigen, die im Abschnitt Kommentare anzeigen dieses Dokuments definiert sind.
snippet.title
(channel)
Erforderlich. Der Titel des Kanals.
  • Wenn der Nutzer einen Kommentar zu einem Kanal bearbeitet oder löscht, muss der API-Client den Namen des Kanals anzeigen.
  • Wenn der Nutzer einen Kommentar zu einem Video bearbeitet oder löscht, muss der API-Client den Namen des Kanals anzeigen, auf dem das Video hochgeladen wurde.
snippet.title
(video)
Erforderlich. Wenn der Nutzer einen Kommentar zu einem Video bearbeitest oder löscht, muss der API-Client den Titel des Videos anzeigen.
Weitere Anforderungen
Comment author's channel name Erforderlich. Der API-Client muss das YouTube-Nutzerkonto, dem der Kommentar zugeordnet ist, eindeutig identifizieren.

Nutzer für den Livechat sperren oder eine Sperrung aufheben

  Name Beschreibung
Ressourceneigenschaften
snippet.title
(channel)
Erforderlich. Der Name des YouTube-Kanals, der gesperrt oder entsperrt wird. Außerdem muss der Name mit dem Kanal verknüpft sein oder die Kanal-URL muss angezeigt werden.
Weitere Anforderungen
Kanalname des Kommentarautors Erforderlich. Der API-Client muss das YouTube-Nutzerkonto eindeutig identifizieren, mit dem die Sperrung hinzugefügt oder entfernt wird.