このページは 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 に指示します。たとえば、英語では currency は `$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` です。

リクエスト本文

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

レスポンス

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

{
  "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` リソースです。
`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 のリクエストとレスポンスを確認します。