Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / af918e8ef422438aaca0c468de8b3b2c184d884e / . / docs / dyn / youtube_v3.search.html
blob: 5d8487f6c1bc7ec254b1847d0be74b574e6022af [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.search.html">search</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]81 <code><a href="#list">list(part, videoDimension=None, videoCaption=None, topicId=None, forContentOwner=None, relatedToVideoId=None, safeSearch=None, regionCode=None, relevanceLanguage=None, channelId=None, forDeveloper=None, locationRadius=None, videoSyndicated=None, videoDuration=None, channelType=None, type=None, videoEmbeddable=None, videoLicense=None, videoType=None, onBehalfOfContentOwner=None, location=None, maxResults=None, publishedBefore=None, videoDefinition=None, q=None, pageToken=None, eventType=None, order=None, videoCategoryId=None, publishedAfter=None, forMine=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]82<p class="firstline">Retrieves a list of search resources</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]93 <code class="details" id="list">list(part, videoDimension=None, videoCaption=None, topicId=None, forContentOwner=None, relatedToVideoId=None, safeSearch=None, regionCode=None, relevanceLanguage=None, channelId=None, forDeveloper=None, locationRadius=None, videoSyndicated=None, videoDuration=None, channelType=None, type=None, videoEmbeddable=None, videoLicense=None, videoType=None, onBehalfOfContentOwner=None, location=None, maxResults=None, publishedBefore=None, videoDefinition=None, q=None, pageToken=None, eventType=None, order=None, videoCategoryId=None, publishedAfter=None, forMine=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]94 <pre>Retrieves a list of search resources
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95
96Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 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)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]98 videoDimension: string, Filter on 3d videos.
99 Allowed values
100 any -
101 2d - Restrict search results to exclude 3D videos.
102 3d - Restrict search results to only include 3D videos.
103 videoCaption: string, Filter on the presence of captions on the videos.
104 Allowed values
105 videoCaptionUnspecified -
106 any - Do not filter results based on caption availability.
107 closedCaption - Only include videos that have captions.
108 none - Only include videos that do not have captions.
109 topicId: string, Restrict results to a particular topic.
110 forContentOwner: boolean, Search owned by a content owner.
111 relatedToVideoId: string, Search related to a resource.
112 safeSearch: string, Indicates whether the search results should include restricted content as well as standard content.
113 Allowed values
114 safeSearchSettingUnspecified -
115 none - YouTube will not filter the search result set.
116 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.
117 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.
118 regionCode: string, Display the content as seen by viewers in this country.
119 relevanceLanguage: string, Return results relevant to this language.
120 channelId: string, Filter on resources belonging to this channelId.
121 forDeveloper: boolean, Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
122 locationRadius: string, Filter on distance from the location (specified above).
123 videoSyndicated: string, Filter on syndicated videos.
124 Allowed values
125 videoSyndicatedUnspecified -
126 any - Return all videos, syndicated or not.
127 true - Only retrieve syndicated videos.
128 videoDuration: string, Filter on the duration of the videos.
129 Allowed values
130 videoDurationUnspecified -
131 any - Do not filter video search results based on their duration. This is the default value.
132 short - Only include videos that are less than four minutes long.
133 medium - Only include videos that are between four and 20 minutes long (inclusive).
134 long - Only include videos longer than 20 minutes.
135 channelType: string, Add a filter on the channel search.
136 Allowed values
137 channelTypeUnspecified -
138 any - Return all channels.
139 show - Only retrieve shows.
140 type: string, Restrict results to a particular set of resource types from One Platform. (repeated)
141 videoEmbeddable: string, Filter on embeddable videos.
142 Allowed values
143 videoEmbeddableUnspecified -
144 any - Return all videos, embeddable or not.
145 true - Only retrieve embeddable videos.
146 videoLicense: string, Filter on the license of the videos.
147 Allowed values
148 any - Return all videos, regardless of which license they have, that match the query parameters.
149 youtube - Only return videos that have the standard YouTube license.
150 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.
151 videoType: string, Filter on videos of a specific type.
152 Allowed values
153 videoTypeUnspecified -
154 any - Return all videos.
155 movie - Only retrieve movies.
156 episode - Only retrieve episodes of shows.
157 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
158 location: string, Filter on location of the video
159 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
160 publishedBefore: string, Filter on resources published before this date.
161 videoDefinition: string, Filter on the definition of the videos.
162 Allowed values
163 any - Return all videos, regardless of their resolution.
164 standard - Only retrieve videos in standard definition.
165 high - Only retrieve HD videos.
166 q: string, Textual search terms to match.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]167 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]168 eventType: string, Filter on the livestream status of the videos.
169 Allowed values
170 none -
171 upcoming - The live broadcast is upcoming.
172 live - The live broadcast is active.
173 completed - The live broadcast has been completed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]174 order: string, Sort order of the results.
175 Allowed values
176 searchSortUnspecified -
177 date - Resources are sorted in reverse chronological order based on the date they were created.
178 rating - Resources are sorted from highest to lowest rating.
179 viewCount - Resources are sorted from highest to lowest number of views.
180 relevance - Resources are sorted based on their relevance to the search query. This is the default value for this parameter.
181 title - Resources are sorted alphabetically by title.
182 videoCount - Channels are sorted in descending order of their number of uploaded videos.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]183 videoCategoryId: string, Filter on videos in a specific category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]184 publishedAfter: string, Filter on resources published after this date.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]185 forMine: boolean, Search for the private videos of the authenticated user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]186 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]188 1 - v1 error format
189 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]190
191Returns:
192 An object of the form:
193
194 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]195 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
196 },
197 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
198 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
199 &quot;totalResults&quot;: 42, # The total number of results in the result set.
200 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]201 &quot;items&quot;: [ # Pagination information for token pagination.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 { # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]203 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]204 &quot;snippet&quot;: { # 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&#x27;s title and the description will be the video&#x27;s description.
205 &quot;publishedAt&quot;: &quot;A String&quot;, # The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]206 &quot;description&quot;: &quot;A String&quot;, # A description of the search result.
207 &quot;title&quot;: &quot;A String&quot;, # The title of the search result.
208 &quot;channelTitle&quot;: &quot;A String&quot;, # The title of the channel that published the resource that the search result identifies.
209 &quot;channelId&quot;: &quot;A String&quot;, # The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
210 &quot;liveBroadcastContent&quot;: &quot;A String&quot;, # It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it&#x27;s &quot;none&quot; if there is not any upcoming/active live broadcasts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]211 &quot;thumbnails&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]212 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]213 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]214 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]215 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]217 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]218 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
219 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]220 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]221 },
222 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]223 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
224 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]225 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]226 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]227 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]228 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
229 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]230 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
231 },
232 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
233 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
234 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
235 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]236 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]237 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]238 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]239 &quot;kind&quot;: &quot;youtube#searchResult&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#searchResult&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]240 &quot;id&quot;: { # 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.
241 &quot;videoId&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]242 &quot;channelId&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]243 &quot;playlistId&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]244 &quot;kind&quot;: &quot;A String&quot;, # The type of the API resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]245 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]246 },
247 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]248 &quot;regionCode&quot;: &quot;A String&quot;,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]249 &quot;kind&quot;: &quot;youtube#searchListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#searchListResponse&quot;.
250 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
251 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
252 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
253 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
254 &quot;prevPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
260 <pre>Retrieves the next page of results.
261
262Args:
263 previous_request: The request for the previous page. (required)
264 previous_response: The response from the request for the previous page. (required)
265
266Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]267 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 page. Returns None if there are no more items in the collection.
269 </pre>
270</div>
271
272</body></html>