LiveChatMessages: transition

Ändert den Status einer YouTube-Livechatnachricht und initiiert alle Prozesse, die mit dem neuen Status verknüpft sind. Wenn Sie beispielsweise den Status einer Live-Umfrage in closed ändern, beendet YouTube die Umfrage für diese Nachricht. Bevor Sie diese Methode aufrufen, sollten Sie prüfen, ob der Wert der Eigenschaft status für die Live-Umfragenachricht active ist.

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

Anfrage

HTTP-Anfrage

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

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

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
id string
Der Parameter id gibt die eindeutige ID der Nachricht an, deren Status geändert wird.
status enum
Der Parameter status gibt den Status an, in den die Nachricht geändert wird. Wenn Sie den Status einer Nachricht in closed ändern möchten, muss der status für die Umfrage, an die die Nachricht gebunden ist, active sein.

Sie können den Status nur in closed ändern. Das bedeutet, dass die Umfrage geschlossen wird.
Optionale Parameter
part string
Der Parameter part gibt die Teile der liveChatMessage-Ressource an, die in der API-Antwort enthalten sein sollen. Unterstützte Werte sind id, snippet und authorDetails.

Legen Sie den Parameterwert auf snippet fest, um das endgültige Umfrageergebnis im Antworttext zu erhalten.

Anfragetext

Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.

Antwort

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

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetail Beschreibung
forbidden (403) forbidden Sie haben nicht die erforderlichen Berechtigungen, um den Status der angegebenen Nachricht zu ändern.
required (400) idRequired Der erforderliche Parameter id muss die Nachricht angeben, deren Status Sie ändern möchten.
required (400) statusRequired In der API-Anfrage muss ein Wert für den Parameter status angegeben werden.
notFound (404) liveChatMessagesNotFound Die durch den Parameter id angegebene Nachricht ist nicht vorhanden.
forbidden (403) modificationNotAllowed Der Status der angegebenen liveChatMessage-Ressource kann nicht geändert werden. Der Parameter id gibt möglicherweise eine Nachricht an, deren Status nicht geändert werden kann.

Testen!

Mit dem APIs Explorer können Sie diese API aufrufen und die API-Anfrage und -Antwort ansehen.