このページは Cloud Translation API によって翻訳されました。

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` です。つまり、画像は 88x88 ピクセルです。有効な値は `16`～`720` です。

リクエスト本文

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

レスポンス

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

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    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` リソースです。

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラーメッセージを示します。詳細については、エラーメッセージのドキュメントを参照してください。

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

実習

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