Einem Livechat eine Nachricht oder eine Umfrage hinzufügen
Gängige Anwendungsfälle
Anfrage
HTTP-Anfrage
POST https://www.googleapis.com/youtube/v3/liveChat/messages
Autorisierung
Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).
Umfang |
---|
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 dient zwei Zwecken. Es identifiziert die Eigenschaften, die von der Schreiboperation festgelegt werden, sowie die Eigenschaften, die die API-Antwort enthalten wird. Legen Sie den Parameterwert auf snippet fest. |
Anfragetext
Geben Sie im Anfragetext eine liveChatMessage-Ressource an. Für diese Ressource müssen Sie Werte für diese Attribute angeben
snippet.liveChatId
snippet.type
: Wählen Sie eine der folgenden Optionen aus:textMessageEvent
oderpollEvent
.- Wenn der Typ
textMessageEvent
ist, schließen Siesnippet.textMessageDetails.messageText
ein. - Wenn der Typ
pollEvent
ist, schließen Siesnippet.pollDetails
mit den folgenden Werten ein:snippet.pollDetails.metadata.options.questionText
- Liste mit
snippet.pollDetails.metadata.options.optionText
. Sie müssen mindestens zwei und nicht mehr als fünf Einträge angeben. Die Elemente werden der Reihe nach in der Reihenfolge angezeigt, in der sie aufgeführt sind.
Antwort
Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine liveChatMessage-Ressource im Antworttext zurückgegeben.
Fehler
In der folgenden Tabelle sind Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.
Fehlertyp | Fehlerdetails | Beschreibung |
---|---|---|
forbidden (403) |
forbidden |
Sie haben nicht die erforderlichen Berechtigungen, um die angegebene Nachricht zu erstellen. |
forbidden (403) |
liveChatDisabled |
Der angegebene Livechat wurde vom Inhaber deaktiviert. Das bedeutet, dass dem Chat keine Nachrichten hinzugefügt werden können. |
forbidden (403) |
liveChatEnded |
Der angegebene Livechat ist nicht mehr live. |
invalidValue (400) |
messageTextInvalid |
Der Nachrichtentext (snippet.textMessageDetails.messageText ) ist ungültig. |
notFound (404) |
liveChatNotFound |
Der in der API-Anfrage angegebene Livechat ist nicht vorhanden. Dieser Fehler tritt auf, wenn der Chat vom Inhaber gelöscht wurde. |
required (400) |
liveChatIdRequired |
Die liveChatMessage-Ressource muss einen Wert für das Attribut snippet.liveChatId enthalten und angeben. |
required (400) |
messageTextRequired |
Die liveChatMessage-Ressource muss einen Wert für das Attribut snippet.textMessageDetails.messageText enthalten und angeben. |
required (400) |
typeRequired |
Die liveChatMessage-Ressource muss einen Wert für das Attribut snippet.type enthalten und angeben. Parameterwert auf text festlegen |
required (400) |
preconditionCheckFailed |
Eine angepinnte aktive Umfrage ist bereits vorhanden. |
rateLimitExceeded |
rateLimitExceeded |
Der Nutzer hat zu viele Chatnachrichten in einem bestimmten Zeitraum gepostet. |
Testen!
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.