LiveChatMessages: list

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

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

割り当てへの影響: このメソッドの呼び出しの割り当てコストは 5 ユニットです。

一般的なユースケース

リクエスト

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 です。

継続トークンなしで行われた最初のリクエストには、最新のメッセージのみが含まれます。指定されている場合は、maxResults より小さくなることがあります。

API は、継続トークンなしで行われた最初のリクエストで返されたメッセージよりも古いメッセージを取得しません。
pageToken string
pageToken パラメータは、返される結果セット内の特定のページを識別します。API レスポンスでは、nextPageToken プロパティは取得できる他のページを識別します。
profileImageSize unsigned integer
profileImageSize パラメータは、結果セットで返される ユーザー プロフィール写真 のサイズを指定します。画像は正方形です。デフォルト値は 88 です。つまり、画像は 88 ピクセル x 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 リクエストとレスポンスを確認します。