# YouTube Data API v3 . comments

## Instance Methods

Close httplib2 connections.

Deletes a resource.

Inserts a new resource into this collection.

Retrieves a list of resources, possibly filtered.

Retrieves the next page of results.

Expresses the caller's opinion that one or more comments should be flagged as spam.

Sets the moderation status of one or more comments.

Updates an existing resource.

### Method Details

`close()`

    Close httplib2 connections.

`delete(id, x__xgafv=None)`

    Deletes a resource.

    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 identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. (required) (repeated)
      body: object, The request body.
        The object takes the form of:

    { # A *comment* represents a single YouTube comment.
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
      "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
      "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
        "authorChannelId": { # The id of the author's YouTube channel, if any.
          "value": "A String",
        },
        "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
        "authorDisplayName": "A String", # The name of the user who posted the comment.
        "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
        "canRate": True or False, # Whether the current viewer can rate this comment.
        "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
        "likeCount": 42, # The total number of likes this comment has received.
        "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
        "parentId": "A String", # The unique id of the parent comment, only set for replies.
        "publishedAt": "A String", # The date and time when the comment was originally published.
        "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
        "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
        "updatedAt": "A String", # The date and time when the comment was last updated.
        "videoId": "A String", # The ID of the video the comment refers to, if any.
        "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
      },
    }

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

    Returns:
      An object of the form:

        { # A *comment* represents a single YouTube comment.
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
      "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
      "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
        "authorChannelId": { # The id of the author's YouTube channel, if any.
          "value": "A String",
        },
        "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
        "authorDisplayName": "A String", # The name of the user who posted the comment.
        "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
        "canRate": True or False, # Whether the current viewer can rate this comment.
        "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
        "likeCount": 42, # The total number of likes this comment has received.
        "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
        "parentId": "A String", # The unique id of the parent comment, only set for replies.
        "publishedAt": "A String", # The date and time when the comment was originally published.
        "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
        "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
        "updatedAt": "A String", # The date and time when the comment was last updated.
        "videoId": "A String", # The ID of the video the comment refers to, if any.
        "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
      },
    }

`list(part, id=None, maxResults=None, pageToken=None, parentId=None, textFormat=None, x__xgafv=None)`

    Retrieves a list of resources, possibly filtered.

    Args:
      part: string, The *part* parameter specifies a comma-separated list of one or more comment resource properties that the API response will include. (required) (repeated)
      id: string, Returns the comments with the given IDs for One Platform. (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.
      parentId: string, Returns replies to the specified comment. Note, currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.
      textFormat: string, The requested text format for the returned comments.
        Allowed values
          textFormatUnspecified -
          html - Returns the comments in HTML format. This is the default value.
          plainText - Returns the comments in plain text format.
      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 comments that match the request criteria.
        { # A *comment* represents a single YouTube comment.
          "etag": "A String", # Etag of this resource.
          "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
          "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
          "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
            "authorChannelId": { # The id of the author's YouTube channel, if any.
              "value": "A String",
            },
            "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
            "authorDisplayName": "A String", # The name of the user who posted the comment.
            "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
            "canRate": True or False, # Whether the current viewer can rate this comment.
            "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
            "likeCount": 42, # The total number of likes this comment has received.
            "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
            "parentId": "A String", # The unique id of the parent comment, only set for replies.
            "publishedAt": "A String", # The date and time when the comment was originally published.
            "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
            "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
            "updatedAt": "A String", # The date and time when the comment was last updated.
            "videoId": "A String", # The ID of the video the comment refers to, if any.
            "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
          },
        },
      ],
      "kind": "youtube#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
      "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.
      },
      "tokenPagination": { # Stub token pagination template to suppress results.
      },
      "visitorId": "A String", # The visitorId identifies the visitor.
    }

`list_next()`

    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.

`markAsSpam(id, x__xgafv=None)`

    Expresses the caller's opinion that one or more comments should be flagged as spam.

    Args:
      id: string, Flags the comments with the given IDs as spam in the caller's opinion. (required) (repeated)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

`setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)`

    Sets the moderation status of one or more comments.

    Args:
      id: string, Modifies the moderation status of the comments with the given IDs (required) (repeated)
      moderationStatus: string, Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: MODERATION_STATUS_PUBLISHED, MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED. (required)
        Allowed values
          published - The comment is available for public display.
          heldForReview - The comment is awaiting review by a moderator.
          likelySpam -
          rejected - The comment is unfit for display.
      banAuthor: boolean, If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

`update(part, body=None, x__xgafv=None)`

    Updates an existing resource.

    Args:
      part: string, The *part* parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. (required) (repeated)
      body: object, The request body.
        The object takes the form of:

    { # A *comment* represents a single YouTube comment.
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
      "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
      "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
        "authorChannelId": { # The id of the author's YouTube channel, if any.
          "value": "A String",
        },
        "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
        "authorDisplayName": "A String", # The name of the user who posted the comment.
        "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
        "canRate": True or False, # Whether the current viewer can rate this comment.
        "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
        "likeCount": 42, # The total number of likes this comment has received.
        "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
        "parentId": "A String", # The unique id of the parent comment, only set for replies.
        "publishedAt": "A String", # The date and time when the comment was originally published.
        "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
        "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
        "updatedAt": "A String", # The date and time when the comment was last updated.
        "videoId": "A String", # The ID of the video the comment refers to, if any.
        "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
      },
    }

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

    Returns:
      An object of the form:

        { # A *comment* represents a single YouTube comment.
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
      "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
      "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
        "authorChannelId": { # The id of the author's YouTube channel, if any.
          "value": "A String",
        },
        "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
        "authorDisplayName": "A String", # The name of the user who posted the comment.
        "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
        "canRate": True or False, # Whether the current viewer can rate this comment.
        "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
        "likeCount": 42, # The total number of likes this comment has received.
        "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
        "parentId": "A String", # The unique id of the parent comment, only set for replies.
        "publishedAt": "A String", # The date and time when the comment was originally published.
        "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
        "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
        "updatedAt": "A String", # The date and time when the comment was last updated.
        "videoId": "A String", # The ID of the video the comment refers to, if any.
        "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
      },
    }