YouTube Data API v3 . liveChatModerators

Instance Methods

close()

Close httplib2 connections.

delete(id, x__xgafv=None)

Deletes a chat moderator.

insert(part, body=None, x__xgafv=None)

Inserts a new resource into this collection.

list(liveChatId, part, maxResults=None, pageToken=None, x__xgafv=None)

Retrieves a list of resources, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
delete(id, x__xgafv=None)
Deletes a chat moderator.

Args:
  id: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
insert(part, body=None, x__xgafv=None)
Inserts a new resource into this collection.

Args:
  part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet. (required) (repeated)
  body: object, The request body.
    The object takes the form of:

{ # A *liveChatModerator* resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
  "etag": "A String", # Etag of this resource.
  "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
  "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
  "snippet": { # The snippet object contains basic details about the moderator.
    "liveChatId": "A String", # The ID of the live chat this moderator can act on.
    "moderatorDetails": { # Details about the moderator.
      "channelId": "A String", # The YouTube channel ID.
      "channelUrl": "A String", # The channel's URL.
      "displayName": "A String", # The channel's display name.
      "profileImageUrl": "A String", # The channels's avatar URL.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A *liveChatModerator* resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
  "etag": "A String", # Etag of this resource.
  "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
  "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
  "snippet": { # The snippet object contains basic details about the moderator.
    "liveChatId": "A String", # The ID of the live chat this moderator can act on.
    "moderatorDetails": { # Details about the moderator.
      "channelId": "A String", # The YouTube channel ID.
      "channelUrl": "A String", # The channel's URL.
      "displayName": "A String", # The channel's display name.
      "profileImageUrl": "A String", # The channels's avatar URL.
    },
  },
}
list(liveChatId, part, maxResults=None, pageToken=None, x__xgafv=None)
Retrieves a list of resources, possibly filtered.

Args:
  liveChatId: string, The id of the live chat for which moderators should be returned. (required)
  part: string, The *part* parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet. (required) (repeated)
  maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
  pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "etag": "A String", # Etag of this resource.
  "eventId": "A String", # Serialized EventId of the request which produced this response.
  "items": [ # A list of moderators that match the request criteria.
    { # A *liveChatModerator* resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
      "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
      "snippet": { # The snippet object contains basic details about the moderator.
        "liveChatId": "A String", # The ID of the live chat this moderator can act on.
        "moderatorDetails": { # Details about the moderator.
          "channelId": "A String", # The YouTube channel ID.
          "channelUrl": "A String", # The channel's URL.
          "displayName": "A String", # The channel's display name.
          "profileImageUrl": "A String", # The channels's avatar URL.
        },
      },
    },
  ],
  "kind": "youtube#liveChatModeratorListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse".
  "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
  "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
    "resultsPerPage": 42, # The number of results included in the API response.
    "totalResults": 42, # The total number of results in the result set.
  },
  "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
  "tokenPagination": { # Stub token pagination template to suppress results.
  },
  "visitorId": "A String", # The visitorId identifies the visitor.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.