YouTube ライブチャット メッセージのステータスを移行し、新しいステータスに関連付けられたプロセスを開始します。たとえば、ライブ投票のステータスを closed に移行すると、YouTube はそのメッセージの投票を終了します。このメソッドを呼び出す前に、ライブ投票メッセージの status プロパティの値が active であることを確認する必要があります。
割り当てへの影響: このメソッドの呼び出しには 20 ユニットの割り当てコストがかかります。
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/youtube/v3/liveChat/messages/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 リクエストとレスポンスを確認します。