LiveChatMessages: list

特定のチャットのチャット メッセージの一覧を取得します。

チャット メッセージを取得する最初のリクエストを行うと、API はチャット履歴の長さに応じて、チャット履歴の一部またはすべてを返します。レスポンス内のメッセージは、古い順に並べ替えられます。
  • レスポンスの nextPageToken は、次のリクエストで API クライアントが取得する次の結果セットを識別するトークンを提供します。
  • pollingIntervalMillis プロパティは、API クライアントが追加の結果をリクエストするまで待機する時間を示します。
追加の結果をリクエストするときは、pageToken パラメータを nextPageToken 値に設定します。API サーバーは、追加のチャット メッセージがある場合はそれを返します。この結果セット内では、メッセージは古いものから新しいものの順に並べ替えられます。

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

次の表に、このクエリがサポートするパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
liveChatId string
liveChatId パラメータは、メッセージが返されるチャットの ID を指定します。ブロードキャストに関連付けられたライブチャット ID は、liveBroadcast リソースの snippet.liveChatId プロパティで返されます。
part string
part パラメータは、API レスポンスに含める liveChatMessage リソースの部分を指定します。サポートされている値は id、snippet、authorDetails です。
オプション パラメータ
hl string
hl パラメータは、YouTube ウェブサイトがサポートする特定のアプリ言語のローカライズされた通貨表示文字列を取得するよう API に指示します。たとえば、英語では通貨は $1.50 と表示されますが、フランス語では 1,50$ と表示されます。

パラメータ値は、i18nLanguages.list メソッドから返されるリストに含まれる言語コードである必要があります。
maxResults unsigned integer
maxResults パラメータは、結果セットで返されるメッセージの最大数を指定します。設定可能な値は 200～2000 です。デフォルト値は 500 です。
pageToken string
pageToken パラメータは、返される結果セット内の特定のページを識別します。API レスポンスでは、nextPageToken プロパティは取得可能な他のページを識別します。
profileImageSize unsigned integer
profileImageSize パラメータは、結果セットで返されるユーザー プロフィール写真のサイズを指定します。画像は正方形です。デフォルト値は 88 です。つまり、画像は 88 ピクセル × 88 ピクセルになります。有効な値は 16～720 です。

リクエストの本文

このメソッドを呼び出すときにリクエスト本文を指定しないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage Resource
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#liveChatMessageListResponse になります。
etag etag
このリソースの Etag。
nextPageToken string
結果セットの次のページを取得するために pageToken パラメータの値として使用できるトークン。
pollingIntervalMillis unsigned integer
クライアントが新しいライブチャット メッセージを再度ポーリングするまで待機する時間（ミリ秒単位）。
offlineAt datetime
基盤となるライブ配信がオフラインになった日時。このプロパティは、ストリームがすでにオフラインの場合にのみ存在します。値は ISO 8601（YYYY-MM-DDThh:mm:ss.sZ）形式で指定します。
pageInfo object
pageInfo オブジェクトは、結果セットのページング情報をカプセル化します。
pageInfo.totalResults integer
結果セット内の結果の総数。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数。
items[] list
メッセージのリスト。リスト内の各項目は liveChatMessage リソースです。
activePollItem object
メッセージ内のアンケート データ。各投票は、アクティブな投票を表すタイプ pollEvent の liveChatMessage リソースです。1 つのチャットに設定できるアンケートは 1 つのみです。

エラー

次の表に、このメソッドの呼び出しに対するレスポンスとして API が返す可能性のあるエラー メッセージを示します。詳しくは、エラー メッセージのドキュメントをご覧ください。

エラーのタイプ エラーの詳細 説明
forbidden (403) forbidden 指定されたライブチャットのメッセージを取得するために必要な権限がありません。
forbidden (403) liveChatDisabled 指定されたブロードキャストでチャットが有効になっていません。
forbidden (403) liveChatEnded 指定されたチャットはすでに終了しています。
notFound (404) liveChatNotFound 取得しようとしているチャットが見つかりません。リクエストの liveChatId パラメータの値を確認して、正しいことを確認します。
rateLimitExceeded rateLimitExceeded リクエストが、前のリクエストの直後に送信されました。このエラーは、メッセージを取得する API リクエストが YouTube の更新頻度よりも頻繁に送信され、帯域幅が無駄になっている場合に発生します。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。