Update docs for 1.4.2 release
diff --git a/docs/dyn/youtube_v3.comments.html b/docs/dyn/youtube_v3.comments.html
index 5d170c8..91e00ad 100644
--- a/docs/dyn/youtube_v3.comments.html
+++ b/docs/dyn/youtube_v3.comments.html
@@ -78,8 +78,8 @@
<code><a href="#delete">delete(id)</a></code></p>
<p class="firstline">Deletes a comment.</p>
<p class="toc_element">
- <code><a href="#insert">insert(part=None, body)</a></code></p>
-<p class="firstline">Creates a new comment.</p>
+ <code><a href="#insert">insert(part, body)</a></code></p>
+<p class="firstline">Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.</p>
<p class="toc_element">
<code><a href="#list">list(part, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None)</a></code></p>
<p class="firstline">Returns a list of comments that match the API request parameters.</p>
@@ -88,33 +88,29 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#markAsSpam">markAsSpam(id)</a></code></p>
-<p class="firstline">Expresses the caller's opinion that a comment is spam.</p>
+<p class="firstline">Expresses the caller's opinion that one or more comments should be flagged as spam.</p>
<p class="toc_element">
<code><a href="#setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None)</a></code></p>
-<p class="firstline">Sets the moderation status of one or more comments.</p>
+<p class="firstline">Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.</p>
<p class="toc_element">
- <code><a href="#update">update(part=None, body)</a></code></p>
-<p class="firstline">Modifies an existing comment.</p>
+ <code><a href="#update">update(part, body)</a></code></p>
+<p class="firstline">Modifies a comment.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(id)</code>
<pre>Deletes a comment.
Args:
- id: string, The id parameter specifies the comment ID for the resource that should be deleted. (required)
+ id: string, The id parameter specifies the comment ID for the resource that is being deleted. (required)
</pre>
</div>
<div class="method">
- <code class="details" id="insert">insert(part=None, body)</code>
- <pre>Creates a new comment.
-
-Note: to create a top level comment it is also necessary to create a comment thread. Both are accomplished through the commentThreads resource.
+ <code class="details" id="insert">insert(part, body)</code>
+ <pre>Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.
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 will include.
-
-The part names that you can include in the parameter value are id and snippet. However only snippet contains properties that can be set. (required)
+ 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)
body: object, The request body. (required)
The object takes the form of:
@@ -180,20 +176,20 @@
<pre>Returns a list of comments that match the API request parameters.
Args:
- part: string, The part parameter specifies the comment resource parts that the API response will include. Supported values are id and snippet. (required)
+ part: string, The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include. (required)
pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.
Note: This parameter is not supported for use in conjunction with the id parameter.
maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
Note: This parameter is not supported for use in conjunction with the id parameter.
- id: string, The id parameter specifies a comma-separated list of comment IDs for the resources that should be retrieved.
+ id: string, The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.
parentId: string, The parentId parameter specifies the ID of the comment for which replies should be retrieved.
-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, Set this parameter's value to html or plainText to instruct the API to return the comments left by users formatted as HTML or as plain text.
+Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.
+ textFormat: string, This parameter indicates whether the API should return comments formatted as HTML or as plain text.
Allowed values
- html - Returns the comments in HTML format.
+ html - Returns the comments in HTML format. This is the default value.
plainText - Returns the comments in plain text format.
Returns:
@@ -257,42 +253,38 @@
<div class="method">
<code class="details" id="markAsSpam">markAsSpam(id)</code>
- <pre>Expresses the caller's opinion that a comment is spam.
+ <pre>Expresses the caller's opinion that one or more comments should be flagged as spam.
Args:
- id: string, The id parameter specifies a comma-separated list of IDs of comments which should get flagged as spam. (required)
+ id: string, The id parameter specifies a comma-separated list of IDs of comments that the caller believes should be classified as spam. (required)
</pre>
</div>
<div class="method">
<code class="details" id="setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None)</code>
- <pre>Sets the moderation status of one or more comments.
+ <pre>Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.
Args:
- id: string, The id parameter specifies a comma-separated list of IDs of comments whose moderation status should be updated. (required)
- moderationStatus: string, Determines the new moderation status of the specified comments. (required)
+ id: string, The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status. (required)
+ moderationStatus: string, Identifies the new moderation status of the specified comments. (required)
Allowed values
heldForReview - Marks a comment as awaiting review by a moderator.
published - Clears a comment for public display.
- rejected - Rejects a comment as not fit for display.
+ rejected - Rejects a comment as being unfit for display. This action also effectively hides all replies to the rejected comment.
-Note: currently there is no way to list or otherwise discover a rejected comment. However it is possible to change its moderation status as long as its ID is still known.
+Note: The API does not currently provide a way to list or otherwise discover rejected comments. However, you can change the moderation status of a rejected comment if you still know its ID. If you were to change the moderation status of a rejected comment, the comment replies would subsequently be discoverable again as well.
+ banAuthor: boolean, The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author.
-Note: Currently, if you reject a comment you effectively also hide all its replies as there is no longer any way to discover them. This may change in the future.
- banAuthor: boolean, The banAuthor paramter, if set to true, adds the author of the comment to the ban list. This means all future comments of the author will autmomatically be rejected.
-
-Note: This parameter is only valid in combination with moderationStatus 'rejected'.
+Note: This parameter is only valid if the moderationStatus parameter is also set to rejected.
</pre>
</div>
<div class="method">
- <code class="details" id="update">update(part=None, body)</code>
- <pre>Modifies an existing comment.
+ <code class="details" id="update">update(part, body)</code>
+ <pre>Modifies a comment.
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 will include.
-
-The part names that you can include in the parameter value are id and snippet. However only snippet contains properties that can be updated. (required)
+ 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)
body: object, The request body. (required)
The object takes the form of: