YouTube チャット メッセージのステータスを移行し、新しいステータスに関連するすべてのプロセスを開始します。たとえば、ライブ アンケートのステータスを closed に移行すると、YouTube はそのメッセージのアンケートを終了します。このメソッドを呼び出す前に、ライブ アンケート メッセージの status プロパティの値が active であることを確認する必要があります。
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition
承認
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。
| スコープ |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
パラメータ
次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
| パラメータ | ||
|---|---|---|
| 必須パラメータ | ||
id |
stringid パラメータは、別のステータスに移行するメッセージの一意の ID を指定します。 |
|
status |
enumstatus パラメータは、メッセージの変更後の状態を識別します。メッセージを closed 状態に移行するには、メッセージがバインドされているポーリングの status を active にする必要があります。
移行できるのは closed のみです。つまり、アンケートは締め切られます。
|
|
| オプション パラメータ | ||
part |
stringpart パラメータは、API レスポンスに含める liveChatMessage リソースのパーツを指定します。サポートされている値は id、snippet、authorDetails です。
レスポンス本文で最終的なアンケート結果を取得するには、パラメータ値を snippet に設定します。
|
|
リクエスト本文
このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。
レスポンス
成功すると、このメソッドはレスポンスの本文で liveChatMessages リソースを返します。
エラー
次の表に、このメソッドの呼び出しへのレスポンスとして API から返されるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
| エラーのタイプ | エラーの詳細 | 説明 |
|---|---|---|
forbidden (403) |
forbidden |
指定したメッセージのステータスの移行に必要な権限がありません。 |
required (400) |
idRequired |
必須の id パラメータでは、ステータスを遷移させるメッセージを指定する必要があります。 |
required (400) |
statusRequired |
API リクエストでは、status パラメータの値を指定する必要があります。 |
notFound (404) |
liveChatMessagesNotFound |
id パラメータで指定されたメッセージが存在しません。 |
forbidden (403) |
modificationNotAllowed |
指定された liveChatMessage リソースのステータスは移行できません。id パラメータで、ステータスを移行できないメッセージを識別できます。 |
試してみよう:
APIs Explorer を使用して API を呼び出し、API のリクエストとレスポンスを確認します。