Reference Guide

Attribute

In diesem Abschnitt wird erläutert, wie Sie ein <div>-Element für eine Schaltfläche zum Abonnieren erstellen. In den folgenden Listen werden die erforderlichen und optionalen Attribute des Elements erläutert. Mit optionalen Attributen kannst du sowohl das Layout als auch das Design der Schaltfläche bestimmen und festlegen, ob die aktuelle Abonnentenzahl für den Kanal angezeigt werden soll.

Erforderliche Attribute

• class: Legen Sie den Wert auf g-ytsubscribe fest. Diese Klasse identifiziert das <div>-Element als Container für eine Schaltfläche zum Abonnieren und ermöglicht YouTube, die eingebettete Schaltfläche dynamisch zu skalieren, wie im nächsten Abschnitt beschrieben.

• Darüber hinaus musst du einen Wert für eines der folgenden zwei Attribute angeben:

  • data-channel: Der Name des Kanals, der mit der Schaltfläche verknüpft ist. Beispielwert: GoogleDevelopers.
  • data-channelid: Die mit der Schaltfläche verknüpfte Kanal-ID. Beispielwert: UC_x5XG1OV2P6uZZ5FSM9Ttw. Du kannst deine Kanal-ID in den YouTube-Kontoeinstellungen oder über die APIs Explorer am Ende dieses Dokuments abrufen. Weitere Informationen zur Verwendung von Kanal-IDs

Optionale Attribute

• data-layout: Das Format für die Schaltfläche. Die folgenden Attributwerte sind zulässig:

  • default: Hier wird ein Wiedergabesymbol und das Wort „Abonnieren“ in der Sprache des Nutzers angezeigt. Die Sprache wird entweder anhand der Spracheinstellung des Nutzers oder anhand des Standorts ausgewählt.
  • full: Neben der Standardschaltfläche werden der Avatar und der Titel des Kanals angezeigt.

• data-theme: Gibt das für die Schaltfläche zu verwendende Farbschema an. Gültige Werte sind default und dark. Das dark-Design ist für Anwendungen vorgesehen, in denen Schaltflächen über einem dunkleren Hintergrundelement platziert werden.

• data-count: Gibt an, ob auf der Schaltfläche die Anzahl der Abonnenten des Kanals angezeigt wird. Standardmäßig ist die Abonnentenzahl sichtbar. Gültige Werte sind default und hidden.

• data-onytevent – Hinweis: Dieses Attribut wurde eingestellt.

Ereignisse

Hinweis:Die Ereignisse subscribe und unsubscribe der Schaltfläche „Abonnieren“ sind veraltet. Ebenso wurde das Attribut data-ytonevent, das zuvor dem Widget-Element hinzugefügt werden konnte, um einen Listener für Ereignisbenachrichtigungen anzugeben, eingestellt.

Dynamische Erstellung

Alternativ zum Standard-Einbettungscode aus dem Konfigurationstool können Sie die Subscribe Button dynamisch rendern. So wird verhindert, dass das JavaScript der API das gesamte DOM durchläuft, um Schaltflächen zu finden. Dadurch kann die Rendering-Zeit für Schaltflächen verkürzt werden.

Im Rahmen der Google+ JavaScript API unterstützt die Subscribe Button die Standardmethoden go und render, mit denen Aboschaltflächen dynamisch gerendert werden können. Mit diesen Methoden können Sie beispielsweise eine Schaltfläche rendern, die nicht vorhanden ist, wenn das Ereignis DOM ready ausgelöst wird, z. B. auf einer Seite, die mit AJAX aktualisiert wird.

Methode	Beschreibung
gapi.ytsubscribe.go(   opt_container )	Diese Methode rendert alle Abo-Schaltflächen im angegebenen Container. Verwende diese Methode, wenn die Abo-Schaltflächen-Elemente, die du rendern möchtest, bereits vorhanden sind. Wenn Ihre Anwendung beispielsweise eine AJAX-Anfrage sendet, die das vollständige <div>-Element für ein Subscribe Button zurückgibt, rufen Sie die Methode go() auf, um die Schaltfläche zu rendern. opt_container Das HTML-Element, das die zu rendernden Aboschaltflächen enthält. Du kannst entweder die Element-ID oder das DOM-Element selbst angeben. Wenn dieser Parameter ausgelassen wird, werden sämtliche Abo-Schaltflächen auf der Seite gerendert.
gapi.ytsubscribe.render(   container,   parameters )	Rendert die Subscribe Button im angegebenen Container. Verwenden Sie diese Methode, wenn das Element, das das Subscribe Button enthalten soll, noch nicht vorhanden ist und erstellt werden muss. Container Gibt das leere HTML-Element an, in dem das Subscribe Button gerendert wird. Du kannst entweder die Element-ID oder das DOM-Element selbst angeben. Parameter Ein Objekt, das Attribute für Aboschaltflächen als key:value-Paare enthält, z. B. {"channel": "GoogleDevelopers", "layout": "full"}.

Schaltfläche mit gapi.ytsubscribe.go rendern

Das folgende Beispiel zeigt den Code, mit dem Sie die gapi.ytsubscribe.go-Methode aufrufen, um eine Schaltfläche dynamisch zu rendern, wenn auf den Link geklickt wird.

Hinweis:Das Konfigurationstool oben verwendet ebenfalls die go-Methode, um eine neue Schaltfläche zu rendern, wenn Sie die Schaltflächenoptionen oder den Code aktualisieren.

Schaltfläche mit gapi.ytsubscribe.render rendern

Das folgende Beispiel zeigt, wie die Methode gapi.ytsubscribe.render aufgerufen wird, um eine Schaltfläche dynamisch zu rendern, wenn auf den Link geklickt wird: