YouTube Data API v3 . youtube . v3

Instance Methods

liveChat()

Returns the liveChat Resource.

close()

Close httplib2 connections.

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

Updates an existing resource.

Method Details

close()
Close httplib2 connections.
updateCommentThreads(body=None, part=None, x__xgafv=None)
Updates an existing resource.

Args:
  body: object, The request body.
    The object takes the form of:

{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
  "etag": "A String", # Etag of this resource.
  "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
  "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
  "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
    "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
      { # 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.
        },
      },
    ],
  },
  "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
    "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
    "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
    "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
    "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
      "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.
      },
    },
    "totalReplyCount": 42, # The total number of replies (not including the top level comment).
    "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
  },
}

  part: string, The *part* parameter specifies a comma-separated list of commentThread resource 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. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
  "etag": "A String", # Etag of this resource.
  "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
  "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
  "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
    "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
      { # 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.
        },
      },
    ],
  },
  "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
    "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
    "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
    "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
    "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
      "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.
      },
    },
    "totalReplyCount": 42, # The total number of replies (not including the top level comment).
    "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
  },
}