chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/youtube_v3.comments.html b/docs/dyn/youtube_v3.comments.html
index 2a473cc..b5f6f1e 100644
--- a/docs/dyn/youtube_v3.comments.html
+++ b/docs/dyn/youtube_v3.comments.html
@@ -84,7 +84,7 @@
<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, parentId=None, textFormat=None, maxResults=None, pageToken=None, id=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, maxResults=None, id=None, parentId=None, pageToken=None, textFormat=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>
@@ -127,28 +127,28 @@
The object takes the form of:
{ # A *comment* represents a single YouTube comment.
- "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".
- "etag": "A String", # Etag of this resource.
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
- "canRate": True or False, # Whether the current viewer can rate this comment.
"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
"parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"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.
+ "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.
+ "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.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
},
+ "etag": "A String", # Etag of this resource.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
}
x__xgafv: string, V1 error format.
@@ -160,46 +160,46 @@
An object of the form:
{ # A *comment* represents a single YouTube comment.
- "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".
- "etag": "A String", # Etag of this resource.
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
- "canRate": True or False, # Whether the current viewer can rate this comment.
"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
"parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"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.
+ "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.
+ "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.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
},
+ "etag": "A String", # Etag of this resource.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part, parentId=None, textFormat=None, maxResults=None, pageToken=None, id=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, maxResults=None, id=None, parentId=None, pageToken=None, textFormat=None, x__xgafv=None)</code>
<pre>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)
+ maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
+ id: string, Returns the comments with the given IDs for One Platform. (repeated)
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 *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.
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.
- 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.
- id: string, Returns the comments with the given IDs for One Platform. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -209,42 +209,42 @@
An object of the form:
{
- "tokenPagination": { # Stub token pagination template to suppress results.
- },
+ "kind": "youtube#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
"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.
"totalResults": 42, # The total number of results in the result set.
"resultsPerPage": 42, # The number of results included in the API response.
},
+ "etag": "A String", # Etag of this resource.
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
"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.
"items": [ # A list of comments that match the request criteria.
{ # A *comment* represents a single YouTube comment.
- "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".
- "etag": "A String", # Etag of this resource.
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
- "canRate": True or False, # Whether the current viewer can rate this comment.
"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
"parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"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.
+ "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.
+ "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.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
},
+ "etag": "A String", # Etag of this resource.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
},
],
- "kind": "youtube#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
- "etag": "A String", # Etag of this resource.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
"visitorId": "A String", # The visitorId identifies the visitor.
}</pre>
</div>
@@ -306,28 +306,28 @@
The object takes the form of:
{ # A *comment* represents a single YouTube comment.
- "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".
- "etag": "A String", # Etag of this resource.
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
- "canRate": True or False, # Whether the current viewer can rate this comment.
"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
"parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"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.
+ "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.
+ "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.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
},
+ "etag": "A String", # Etag of this resource.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
}
x__xgafv: string, V1 error format.
@@ -339,28 +339,28 @@
An object of the form:
{ # A *comment* represents a single YouTube comment.
- "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".
- "etag": "A String", # Etag of this resource.
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
- "canRate": True or False, # Whether the current viewer can rate this comment.
"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
"parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"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.
+ "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.
+ "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.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
},
+ "etag": "A String", # Etag of this resource.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
}</pre>
</div>