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 プロパティを使用して他のページを取得できます。

リクエスト本文

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

レスポンス

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

{
  "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 メソッドに固有のエラー メッセージを定義しません。ただし、このメソッドでは、エラー メッセージのドキュメントに記載されている一般的な API エラーが返される場合があります。

実習

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