Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / dyn / youtube_v3.search.html
blob: 19bad22c90461f0d1fedf01b0232ae0c93335395 [file] [log] [blame]
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[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
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.search.html">search</a></h1>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]78 <code><a href="#list">list(part=None, channelId=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, videoDuration=None, forMine=None, q=None, safeSearch=None, videoEmbeddable=None, videoCategoryId=None, order=None)</a></code></p>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]79<p class="firstline">Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]85 <code class="details" id="list">list(part=None, channelId=None, videoSyndicated=None, channelType=None, videoCaption=None, publishedAfter=None, onBehalfOfContentOwner=None, forContentOwner=None, regionCode=None, type=None, topicId=None, publishedBefore=None, videoDimension=None, videoLicense=None, maxResults=None, videoType=None, videoDefinition=None, pageToken=None, relatedToVideoId=None, videoDuration=None, forMine=None, q=None, safeSearch=None, videoEmbeddable=None, videoCategoryId=None, order=None)</code>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]86 <pre>Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]87
88Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]89 part: string, The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet.
90
91If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. (required)
92 channelId: string, The channelId parameter indicates that the API response should only contain resources created by the channel
93 videoSyndicated: string, The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]94 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]95 any - Return all videos, syndicated or not.
96 true - Only retrieve syndicated videos.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]97 channelType: string, The channelType parameter lets you restrict a search to a particular type of channel.
98 Allowed values
99 any - Return all channels.
100 show - Only retrieve shows.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]101 videoCaption: string, The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]102 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]103 any - Do not filter results based on caption availability.
104 closedCaption - Only include videos that have captions.
105 none - Only include videos that do not have captions.
106 publishedAfter: string, The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]107 onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]108 forContentOwner: boolean, The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]109 regionCode: string, The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.
110 type: string, The type parameter restricts a search query to only retrieve a particular type of resource.
111 topicId: string, The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID.
112 publishedBefore: string, The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
113 videoDimension: string, The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]114 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]115 2d - Restrict search results to exclude 3D videos.
116 3d - Restrict search results to only include 3D videos.
117 any - Include both 3D and non-3D videos in returned results. This is the default value.
118 videoLicense: string, The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]119 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]120 any - Return all videos, regardless of which license they have, that match the query parameters.
121 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.
122 youtube - Only return videos that have the standard YouTube license.
123 maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]124 videoType: string, The videoType parameter lets you restrict a search to a particular type of videos.
125 Allowed values
126 any - Return all videos.
127 episode - Only retrieve episodes of shows.
128 movie - Only retrieve movies.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]129 videoDefinition: string, The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]130 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]131 any - Return all videos, regardless of their resolution.
132 high - Only retrieve HD videos.
133 standard - Only retrieve videos in standard definition.
134 pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]135 relatedToVideoId: string, The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]136 videoDuration: string, The videoDuration parameter filters video search results based on their duration.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]137 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]138 any - Do not filter video search results based on their duration. This is the default value.
139 long - Only include videos longer than 20 minutes.
140 medium - Only include videos that are between four and 20 minutes long (inclusive).
141 short - Only include videos that are less than four minutes long.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]142 forMine: boolean, The forMine parameter restricts the search to only retrieve videos owned by the authenticated user.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]143 q: string, The q parameter specifies the query term to search for.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]144 safeSearch: string, The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.
145 Allowed values
146 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. Note: The default value for the safeSearch parameter is moderate.
147 none - YouTube will not perform any filtering on the search result set.
148 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.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]149 videoEmbeddable: string, The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]150 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]151 any - Return all videos, embeddable or not.
152 true - Only retrieve embeddable videos.
153 videoCategoryId: string, The videoCategoryId parameter filters video search results based on their category.
154 order: string, The order parameter specifies the method that will be used to order resources in the API response.
155 Allowed values
156 date - Resources are sorted in reverse chronological order based on the date they were created.
157 rating - Resources are sorted from highest to lowest rating.
158 relevance - Resources are sorted based on their relevance to the search query. This is the default value for this parameter.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]159 title - Resources are sorted based on their title.
160 videoCount - Channels are sorted from highest to lowest number of video uploaded.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]161 viewCount - Resources are sorted from highest to lowest number of views.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]162
163Returns:
164 An object of the form:
165
166 { # A paginated list of search results returned as the response to a youtube.search.list call.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]167 "eventId": "A String", # Serialized EventId of the request which produced this response.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]168 "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.
169 "kind": "youtube#searchListResponse", # The type of the API response. For this operation, the value will be youtube#searchListResponse.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]170 "visitorId": "A String", # The visitorId identifies the visitor.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]171 "items": [ # A list of results that match the search criteria.
172 { # 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.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]173 "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.
174 "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.
175 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
176 "url": "A String", # The thumbnail image's URL.
177 "width": 42, # (Optional) Width of the thumbnail image.
178 "height": 42, # (Optional) Height of the thumbnail image.
179 },
180 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
181 "url": "A String", # The thumbnail image's URL.
182 "width": 42, # (Optional) Width of the thumbnail image.
183 "height": 42, # (Optional) Height of the thumbnail image.
184 },
185 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
186 "url": "A String", # The thumbnail image's URL.
187 "width": 42, # (Optional) Width of the thumbnail image.
188 "height": 42, # (Optional) Height of the thumbnail image.
189 },
190 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
191 "url": "A String", # The thumbnail image's URL.
192 "width": 42, # (Optional) Width of the thumbnail image.
193 "height": 42, # (Optional) Height of the thumbnail image.
194 },
195 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]196 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]197 "width": 42, # (Optional) Width of the thumbnail image.
198 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]199 },
200 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]201 "title": "A String", # The title of the search result.
202 "channelId": "A String", # The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
203 "publishedAt": "A String", # The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
204 "channelTitle": "A String", # The title of the channel that published the resource that the search result identifies.
205 "description": "A String", # A description of the search result.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]206 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]207 "kind": "youtube#searchResult", # The kind, fixed to "youtube#searchResult".
208 "etag": "A String", # Etag of this resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]209 "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.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]210 "kind": "A String", # The type of the API resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]211 "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.
212 "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.
213 "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.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]214 },
215 },
216 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]217 "etag": "A String", # The ETag for the response.
218 "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.
219 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the search result set.
220 "totalResults": 42, # The total number of results in the result set.
221 "resultsPerPage": 42, # The number of results included in the API response.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]222 },
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
228 <pre>Retrieves the next page of results.
229
230Args:
231 previous_request: The request for the previous page. (required)
232 previous_response: The response from the request for the previous page. (required)
233
234Returns:
235 A request object that you can call 'execute()' on to request the next
236 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]237 </pre>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]238</div>
239
240</body></html>