docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/youtube_v3.comments.html b/docs/dyn/youtube_v3.comments.html
index 353c227..50420fa 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, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, id=None, textFormat=None, parentId=None, pageToken=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>
@@ -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.
+ "etag": "A String", # Etag of this resource.
+ "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.
- "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.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"authorDisplayName": "A String", # The name of the user who posted the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "likeCount": 42, # The total number of likes this comment has received.
- "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.
+ "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.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
+ "videoId": "A String", # The ID of the video the comment refers to, 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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "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.
+ "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.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "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.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
},
- "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.
}
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.
+ "etag": "A String", # Etag of this resource.
+ "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.
- "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.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"authorDisplayName": "A String", # The name of the user who posted the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "likeCount": 42, # The total number of likes this comment has received.
- "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.
+ "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.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
+ "videoId": "A String", # The ID of the video the comment refers to, 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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "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.
+ "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.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "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.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
},
- "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, id=None, textFormat=None, parentId=None, pageToken=None, maxResults=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)
- 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.
- 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.
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.
+ 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.
+ maxResults: integer, The *maxResults* 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
@@ -209,43 +209,43 @@
An object of the form:
{
- "visitorId": "A String", # The visitorId identifies the visitor.
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
"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.
- "etag": "A String", # Etag of this resource.
+ "visitorId": "A String", # The visitorId identifies the visitor.
"kind": "youtube#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
- "tokenPagination": { # Stub token pagination template to suppress results.
- },
"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.
},
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
"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.
+ "etag": "A String", # Etag of this resource.
+ "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.
- "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.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"authorDisplayName": "A String", # The name of the user who posted the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "likeCount": 42, # The total number of likes this comment has received.
- "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.
+ "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.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
+ "videoId": "A String", # The ID of the video the comment refers to, 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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "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.
+ "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.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "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.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
},
- "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.
},
],
- "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "etag": "A String", # Etag of this resource.
}</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.
+ "etag": "A String", # Etag of this resource.
+ "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.
- "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.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"authorDisplayName": "A String", # The name of the user who posted the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "likeCount": 42, # The total number of likes this comment has received.
- "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.
+ "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.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
+ "videoId": "A String", # The ID of the video the comment refers to, 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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "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.
+ "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.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "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.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
},
- "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.
}
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.
+ "etag": "A String", # Etag of this resource.
+ "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.
- "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.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"authorDisplayName": "A String", # The name of the user who posted the comment.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "likeCount": 42, # The total number of likes this comment has received.
- "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.
+ "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.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"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.
+ "videoId": "A String", # The ID of the video the comment refers to, 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.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "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.
+ "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.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "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.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "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.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
},
- "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.
}</pre>
</div>