LiveChatMessages: insert

Fügt einem Live-Chat eine Nachricht oder eine Umfrage hinzu.

Auswirkungen auf das Kontingent: Ein Aufruf dieser Methode hat Kontingentkosten von 20 Einheiten.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

POST https://www.googleapis.com/youtube/v3/liveChat/messages

Autorisierung

Für diese Anfrage ist eine Autorisierung mit mindestens einem der folgenden Bereiche erforderlich. Weitere Informationen zur Authentifizierung und Autorisierung findest du unter OAuth 2.0-Authentifizierung implementieren.

Bereich
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
part string
Der Parameter part hat zwei Funktionen. Er gibt die Eigenschaften an, die durch den Schreibvorgang festgelegt werden, sowie die Eigenschaften, die in der API-Antwort enthalten sein sollen. Setze den Parameterwert auf snippet.

Anfragetext

Gib im Anfragetext eine liveChatMessage-Ressource an. Für diese Ressource musst du Werte für die folgenden Eigenschaften angeben:

  • snippet.liveChatId
  • snippet.type : Wähle eine der folgenden Optionen aus: textMessageEvent oder pollEvent.
  • Wenn der Typ textMessageEvent ist, füge snippet.textMessageDetails.messageText ein.
  • Wenn der Typ pollEvent ist, füge das Objekt snippet.pollDetails mit der folgenden Struktur ein:
    • snippet.pollDetails.metadata.questionText (String): Die Hauptfrage für die Umfrage.
    • snippet.pollDetails.metadata.options (Array): Eine Liste von Options-Objekten.
    • Anforderungen: Du musst mindestens zwei und maximal vier Elemente einfügen.
    • Reihenfolge: Die Elemente werden in der Reihenfolge angezeigt, in der sie aufgeführt sind.
    • Jedes Objekt im Array muss Folgendes enthalten:
      • optionText (String): Der Text, der für diese bestimmte Umfrageoption angezeigt wird.

Antwort

Bei Erfolg gibt diese Methode eine liveChatMessage-Ressource im Antworttext zurück.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die von der API als Antwort auf einen Aufruf dieser Methode zurückgegeben werden können. Weitere Informationen findest du unter YouTube Live Streaming API – Fehler.

Fehlertyp Fehlerdetail Beschreibung
forbidden (403) forbidden Du hast nicht die erforderlichen Berechtigungen, um die angegebene Nachricht zu erstellen.
forbidden (403) liveChatDisabled Der angegebene Live-Chat wurde vom Inhaber deaktiviert. Daher können keine Nachrichten hinzugefügt werden.
forbidden (403) liveChatEnded Der angegebene Live-Chat ist nicht mehr aktiv.
invalidValue (400) messageTextInvalid Der Nachrichtentext (snippet.textMessageDetails.messageText) ist ungültig.
notFound (404) liveChatNotFound Der in der API-Anfrage angegebene Live-Chat ist nicht vorhanden. Dieser Fehler tritt auf, wenn der Chat vom Inhaber gelöscht wurde.
required (400) liveChatIdRequired Die liveChatMessage-Ressource muss die Eigenschaft snippet.liveChatId enthalten und einen Wert dafür angeben.
required (400) messageTextRequired Die liveChatMessage-Ressource muss die Eigenschaft snippet.textMessageDetails.messageText enthalten und einen Wert dafür angeben.
required (400) typeRequired Die liveChatMessage-Ressource muss die Eigenschaft snippet.type enthalten und einen Wert dafür angeben. Setze den Parameterwert auf text.
required (400) preconditionCheckFailed Es ist bereits eine angepinnte aktive Umfrage vorhanden.
rateLimitExceeded rateLimitExceeded Der Nutzer hat innerhalb eines bestimmten Zeitraums zu viele Chatnachrichten gepostet.

Testen!

Mit dem APIs Explorer kannst du diese API aufrufen und die API-Anfrage und -Antwort ansehen.