| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.comments.html">comments</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a resource.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts a new resource into this collection.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(part, textFormat=None, parentId=None, pageToken=None, id=None, maxResults=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a list of resources, possibly filtered.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#markAsSpam">markAsSpam(id, x__xgafv=None)</a></code></p> |
| <p class="firstline">Expresses the caller's opinion that one or more comments should be flagged</p> |
| <p class="toc_element"> |
| <code><a href="#setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the moderation status of one or more comments.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(id, x__xgafv=None)</code> |
| <pre>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 |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code> |
| <pre>Inserts a new resource into this collection. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter identifies the properties |
| that the API response will include. Set the parameter value to |
| <code>snippet</code>. The <code>snippet</code> part has a quota cost of 2 |
| units. (required) (repeated) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A <code><strong>comment</strong></code> 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. |
| "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment. |
| "canRate": True or False, # Whether the current viewer can rate this comment. |
| "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were |
| # requested through the id filter. |
| "authorChannelId": { # The id of the author's YouTube channel, if any. |
| "value": "A String", |
| }, |
| "authorDisplayName": "A String", # The name of the user who posted the comment. |
| "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. |
| "likeCount": 42, # The total number of likes this comment has received. |
| "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. |
| "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the 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. |
| "updatedAt": "A String", # The date and time when was last updated . The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "publishedAt": "A String", # The date and time when the comment was orignally published. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| "videoId": "A String", # The ID of the video the comment refers to, if any. |
| "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. |
| }, |
| "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#comment"</code>. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>comment</strong></code> 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. |
| "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment. |
| "canRate": True or False, # Whether the current viewer can rate this comment. |
| "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were |
| # requested through the id filter. |
| "authorChannelId": { # The id of the author's YouTube channel, if any. |
| "value": "A String", |
| }, |
| "authorDisplayName": "A String", # The name of the user who posted the comment. |
| "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. |
| "likeCount": 42, # The total number of likes this comment has received. |
| "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. |
| "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the 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. |
| "updatedAt": "A String", # The date and time when was last updated . The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "publishedAt": "A String", # The date and time when the comment was orignally published. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| "videoId": "A String", # The ID of the video the comment refers to, if any. |
| "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. |
| }, |
| "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#comment"</code>. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(part, textFormat=None, parentId=None, pageToken=None, id=None, maxResults=None, x__xgafv=None)</code> |
| <pre>Retrieves a list of resources, possibly filtered. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>comment</code> resource |
| properties that the API response will include. (required) (repeated) |
| textFormat: string, The requested text format for the returned comments. |
| 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. |
| pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| page in the result set that should be returned. In an API response, the |
| <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| identify other pages that could be retrieved. |
| id: string, Returns the comments with the given IDs for One Platform. (repeated) |
| maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| maximum number of items that should be returned in the result set. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| "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 <code><strong>comment</strong></code> 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. |
| "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment. |
| "canRate": True or False, # Whether the current viewer can rate this comment. |
| "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were |
| # requested through the id filter. |
| "authorChannelId": { # The id of the author's YouTube channel, if any. |
| "value": "A String", |
| }, |
| "authorDisplayName": "A String", # The name of the user who posted the comment. |
| "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. |
| "likeCount": 42, # The total number of likes this comment has received. |
| "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. |
| "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the 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. |
| "updatedAt": "A String", # The date and time when was last updated . The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "publishedAt": "A String", # The date and time when the comment was orignally published. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| "videoId": "A String", # The ID of the video the comment refers to, if any. |
| "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. |
| }, |
| "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#comment"</code>. |
| }, |
| ], |
| "kind": "youtube#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#commentListResponse"</code>. |
| "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the next page in the result set. |
| "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information. |
| # available and number of resources returned in a single page. |
| "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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="markAsSpam">markAsSpam(id, x__xgafv=None)</code> |
| <pre>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 |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)</code> |
| <pre>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) |
| 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 |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(part, body=None, x__xgafv=None)</code> |
| <pre>Updates an existing resource. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter identifies the properties |
| that the API response will include. You must at least include the |
| <code>snippet</code> 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 <code><strong>comment</strong></code> 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. |
| "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment. |
| "canRate": True or False, # Whether the current viewer can rate this comment. |
| "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were |
| # requested through the id filter. |
| "authorChannelId": { # The id of the author's YouTube channel, if any. |
| "value": "A String", |
| }, |
| "authorDisplayName": "A String", # The name of the user who posted the comment. |
| "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. |
| "likeCount": 42, # The total number of likes this comment has received. |
| "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. |
| "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the 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. |
| "updatedAt": "A String", # The date and time when was last updated . The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "publishedAt": "A String", # The date and time when the comment was orignally published. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| "videoId": "A String", # The ID of the video the comment refers to, if any. |
| "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. |
| }, |
| "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#comment"</code>. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>comment</strong></code> 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. |
| "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment. |
| "canRate": True or False, # Whether the current viewer can rate this comment. |
| "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were |
| # requested through the id filter. |
| "authorChannelId": { # The id of the author's YouTube channel, if any. |
| "value": "A String", |
| }, |
| "authorDisplayName": "A String", # The name of the user who posted the comment. |
| "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. |
| "likeCount": 42, # The total number of likes this comment has received. |
| "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. |
| "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the 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. |
| "updatedAt": "A String", # The date and time when was last updated . The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "publishedAt": "A String", # The date and time when the comment was orignally published. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| "videoId": "A String", # The ID of the video the comment refers to, if any. |
| "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. |
| }, |
| "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#comment"</code>. |
| }</pre> |
| </div> |
| |
| </body></html> |
