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.search.html b/docs/dyn/youtube_v3.search.html
index 4b55d3d..b180f40 100644
--- a/docs/dyn/youtube_v3.search.html
+++ b/docs/dyn/youtube_v3.search.html
@@ -78,7 +78,7 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#list">list(part, eventType=None, videoDimension=None, locationRadius=None, videoEmbeddable=None, forContentOwner=None, videoLicense=None, videoCategoryId=None, videoType=None, forDeveloper=None, channelId=None, type=None, publishedBefore=None, onBehalfOfContentOwner=None, order=None, location=None, topicId=None, channelType=None, forMine=None, videoCaption=None, videoDefinition=None, regionCode=None, relevanceLanguage=None, safeSearch=None, videoDuration=None, videoSyndicated=None, publishedAfter=None, relatedToVideoId=None, pageToken=None, q=None, maxResults=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, pageToken=None, order=None, videoType=None, relevanceLanguage=None, forMine=None, channelId=None, videoDuration=None, videoEmbeddable=None, videoCategoryId=None, onBehalfOfContentOwner=None, channelType=None, publishedAfter=None, videoDimension=None, q=None, videoSyndicated=None, locationRadius=None, publishedBefore=None, topicId=None, videoDefinition=None, maxResults=None, videoCaption=None, safeSearch=None, forDeveloper=None, eventType=None, location=None, type=None, forContentOwner=None, relatedToVideoId=None, regionCode=None, videoLicense=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of search resources</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -90,46 +90,12 @@
</div>
<div class="method">
- <code class="details" id="list">list(part, eventType=None, videoDimension=None, locationRadius=None, videoEmbeddable=None, forContentOwner=None, videoLicense=None, videoCategoryId=None, videoType=None, forDeveloper=None, channelId=None, type=None, publishedBefore=None, onBehalfOfContentOwner=None, order=None, location=None, topicId=None, channelType=None, forMine=None, videoCaption=None, videoDefinition=None, regionCode=None, relevanceLanguage=None, safeSearch=None, videoDuration=None, videoSyndicated=None, publishedAfter=None, relatedToVideoId=None, pageToken=None, q=None, maxResults=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, pageToken=None, order=None, videoType=None, relevanceLanguage=None, forMine=None, channelId=None, videoDuration=None, videoEmbeddable=None, videoCategoryId=None, onBehalfOfContentOwner=None, channelType=None, publishedAfter=None, videoDimension=None, q=None, videoSyndicated=None, locationRadius=None, publishedBefore=None, topicId=None, videoDefinition=None, maxResults=None, videoCaption=None, safeSearch=None, forDeveloper=None, eventType=None, location=None, type=None, forContentOwner=None, relatedToVideoId=None, regionCode=None, videoLicense=None, x__xgafv=None)</code>
<pre>Retrieves a list of search resources
Args:
part: string, The *part* parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet. (required) (repeated)
- eventType: string, Filter on the livestream status of the videos.
- Allowed values
- none -
- upcoming - The live broadcast is upcoming.
- live - The live broadcast is active.
- completed - The live broadcast has been completed.
- videoDimension: string, Filter on 3d videos.
- Allowed values
- any -
- 2d - Restrict search results to exclude 3D videos.
- 3d - Restrict search results to only include 3D videos.
- locationRadius: string, Filter on distance from the location (specified above).
- videoEmbeddable: string, Filter on embeddable videos.
- Allowed values
- videoEmbeddableUnspecified -
- any - Return all videos, embeddable or not.
- true - Only retrieve embeddable videos.
- forContentOwner: boolean, Search owned by a content owner.
- videoLicense: string, Filter on the license of the videos.
- Allowed values
- any - Return all videos, regardless of which license they have, that match the query parameters.
- youtube - Only return videos that have the standard YouTube license.
- creativeCommon - Only return videos that have a Creative Commons license. Users can reuse videos with this license in other videos that they create. Learn more.
- videoCategoryId: string, Filter on videos in a specific category.
- videoType: string, Filter on videos of a specific type.
- Allowed values
- videoTypeUnspecified -
- any - Return all videos.
- movie - Only retrieve movies.
- episode - Only retrieve episodes of shows.
- forDeveloper: boolean, Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
- channelId: string, Filter on resources belonging to this channelId.
- type: string, Restrict results to a particular set of resource types from One Platform. (repeated)
- publishedBefore: string, Filter on resources published before this date.
- onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ 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.
order: string, Sort order of the results.
Allowed values
searchSortUnspecified -
@@ -139,33 +105,15 @@
relevance - Resources are sorted based on their relevance to the search query. This is the default value for this parameter.
title - Resources are sorted alphabetically by title.
videoCount - Channels are sorted in descending order of their number of uploaded videos.
- location: string, Filter on location of the video
- topicId: string, Restrict results to a particular topic.
- channelType: string, Add a filter on the channel search.
+ videoType: string, Filter on videos of a specific type.
Allowed values
- channelTypeUnspecified -
- any - Return all channels.
- show - Only retrieve shows.
- forMine: boolean, Search for the private videos of the authenticated user.
- videoCaption: string, Filter on the presence of captions on the videos.
- Allowed values
- videoCaptionUnspecified -
- any - Do not filter results based on caption availability.
- closedCaption - Only include videos that have captions.
- none - Only include videos that do not have captions.
- videoDefinition: string, Filter on the definition of the videos.
- Allowed values
- any - Return all videos, regardless of their resolution.
- standard - Only retrieve videos in standard definition.
- high - Only retrieve HD videos.
- regionCode: string, Display the content as seen by viewers in this country.
+ videoTypeUnspecified -
+ any - Return all videos.
+ movie - Only retrieve movies.
+ episode - Only retrieve episodes of shows.
relevanceLanguage: string, Return results relevant to this language.
- safeSearch: string, Indicates whether the search results should include restricted content as well as standard content.
- Allowed values
- safeSearchSettingUnspecified -
- none - YouTube will not filter the search result set.
- moderate - YouTube will filter some content from search results and, at the least, will filter content that is restricted in your locale. Based on their content, search results could be removed from search results or demoted in search results. This is the default parameter value.
- strict - YouTube will try to exclude all restricted content from the search result set. Based on their content, search results could be removed from search results or demoted in search results.
+ forMine: boolean, Search for the private videos of the authenticated user.
+ channelId: string, Filter on resources belonging to this channelId.
videoDuration: string, Filter on the duration of the videos.
Allowed values
videoDurationUnspecified -
@@ -173,16 +121,68 @@
short - Only include videos that are less than four minutes long.
medium - Only include videos that are between four and 20 minutes long (inclusive).
long - Only include videos longer than 20 minutes.
+ videoEmbeddable: string, Filter on embeddable videos.
+ Allowed values
+ videoEmbeddableUnspecified -
+ any - Return all videos, embeddable or not.
+ true - Only retrieve embeddable videos.
+ videoCategoryId: string, Filter on videos in a specific category.
+ onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ channelType: string, Add a filter on the channel search.
+ Allowed values
+ channelTypeUnspecified -
+ any - Return all channels.
+ show - Only retrieve shows.
+ publishedAfter: string, Filter on resources published after this date.
+ videoDimension: string, Filter on 3d videos.
+ Allowed values
+ any -
+ 2d - Restrict search results to exclude 3D videos.
+ 3d - Restrict search results to only include 3D videos.
+ q: string, Textual search terms to match.
videoSyndicated: string, Filter on syndicated videos.
Allowed values
videoSyndicatedUnspecified -
any - Return all videos, syndicated or not.
true - Only retrieve syndicated videos.
- publishedAfter: string, Filter on resources published after this date.
- relatedToVideoId: string, Search related to a resource.
- 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.
- q: string, Textual search terms to match.
+ locationRadius: string, Filter on distance from the location (specified above).
+ publishedBefore: string, Filter on resources published before this date.
+ topicId: string, Restrict results to a particular topic.
+ videoDefinition: string, Filter on the definition of the videos.
+ Allowed values
+ any - Return all videos, regardless of their resolution.
+ standard - Only retrieve videos in standard definition.
+ high - Only retrieve HD videos.
maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
+ videoCaption: string, Filter on the presence of captions on the videos.
+ Allowed values
+ videoCaptionUnspecified -
+ any - Do not filter results based on caption availability.
+ closedCaption - Only include videos that have captions.
+ none - Only include videos that do not have captions.
+ safeSearch: string, Indicates whether the search results should include restricted content as well as standard content.
+ Allowed values
+ safeSearchSettingUnspecified -
+ none - YouTube will not filter the search result set.
+ moderate - YouTube will filter some content from search results and, at the least, will filter content that is restricted in your locale. Based on their content, search results could be removed from search results or demoted in search results. This is the default parameter value.
+ strict - YouTube will try to exclude all restricted content from the search result set. Based on their content, search results could be removed from search results or demoted in search results.
+ forDeveloper: boolean, Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
+ eventType: string, Filter on the livestream status of the videos.
+ Allowed values
+ none -
+ upcoming - The live broadcast is upcoming.
+ live - The live broadcast is active.
+ completed - The live broadcast has been completed.
+ location: string, Filter on location of the video
+ type: string, Restrict results to a particular set of resource types from One Platform. (repeated)
+ forContentOwner: boolean, Search owned by a content owner.
+ relatedToVideoId: string, Search related to a resource.
+ regionCode: string, Display the content as seen by viewers in this country.
+ videoLicense: string, Filter on the license of the videos.
+ Allowed values
+ any - Return all videos, regardless of which license they have, that match the query parameters.
+ youtube - Only return videos that have the standard YouTube license.
+ creativeCommon - Only return videos that have a Creative Commons license. Users can reuse videos with this license in other videos that they create. Learn more.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -193,13 +193,16 @@
{
"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.
+ "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
+ "kind": "youtube#searchListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse".
"items": [ # Pagination information for token pagination.
{ # A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.
+ "etag": "A String", # Etag of this resource.
"snippet": { # Basic details about a search result, including title, description and thumbnails of the item referenced by the search result. # The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.
- "description": "A String", # A description of the search result.
- "channelId": "A String", # The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
- "title": "A String", # The title of the search result.
- "channelTitle": "A String", # The title of the channel that published the resource that the search result identifies.
+ "liveBroadcastContent": "A String", # It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.
"publishedAt": "A String", # The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 format.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
@@ -207,11 +210,6 @@
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "height": 42, # (Optional) Height of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- },
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
@@ -227,31 +225,33 @@
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
+ "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ },
},
- "liveBroadcastContent": "A String", # It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.
+ "channelTitle": "A String", # The title of the channel that published the resource that the search result identifies.
+ "description": "A String", # A description of the search result.
+ "channelId": "A String", # The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
+ "title": "A String", # The title of the search result.
},
"kind": "youtube#searchResult", # Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult".
- "etag": "A String", # Etag of this resource.
"id": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information that can be used to uniquely identify the resource that matches the search request.
"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
"kind": "A String", # The type of the API resource.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
+ "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
},
},
],
- "kind": "youtube#searchListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse".
- "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
"tokenPagination": { # Stub token pagination template to suppress results.
},
+ "regionCode": "A String",
"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.
},
- "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.
- "regionCode": "A String",
}</pre>
</div>