LiveChatModerators: list

チャットのモデレーターを一覧表示します。リクエストは、チャットのチャンネルの所有者によって承認される必要があります。

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

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

パラメータ
必須パラメータ
liveChatId string
liveChatId パラメータは、API がモデレーターを返す YouTube ライブチャットを指定します。ブロードキャストに関連付けられたチャット ID は、liveBroadcast リソースの snippet.liveChatId プロパティで返されます。
part string
part パラメータは、API レスポンスに含める liveChatModerator リソースのパーツを指定します。サポートされる値は id と snippet です。
オプション パラメータ
maxResults unsigned integer
maxResults パラメータは、結果セットで返されるアイテムの最大数を指定します。有効な値は 0～50 です。デフォルト値は 5 です。
pageToken string
pageToken パラメータは、返される結果セット内の特定のページを指定します。API レスポンスでは、nextPageToken プロパティと prevPageToken プロパティで、取得できる他のページを指定します。

リクエストの本文

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

Response

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

{
  "kind": "youtube#liveChatModeratorListResponse",
  "etag": etag,
  "prevPageToken": string,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatModerator Resource
  ]
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを指定します。値は youtube#liveChatModeratorListResponse になります。
etag etag
このリソースの Etag。
prevPageToken string
結果セット内の前のページを取得するために pageToken パラメータの値として使用できるトークン。
nextPageToken string
結果セット内の次のページを取得するために pageToken パラメータの値として使用できるトークン。
pageInfo object
pageInfo オブジェクトは、結果セットのページング情報をカプセル化します。
pageInfo.totalResults integer
結果セット内の結果の総数です。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数です。
items[] list
リクエスト条件に一致するモデレーターのリスト。

エラー

この API メソッドに固有のエラー メッセージは定義されていません。ただし、エラー メッセージのドキュメントに記載されている一般的な API エラーが返される可能性があります。

試してみよう:

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