このページは 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` です。つまり、画像は 88 x 88 ピクセルになります。有効な値は `16`～`720` です。

リクエスト本文

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

Response

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

{
  "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 回のみ実施できます。

エラー

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

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

試してみよう:

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