| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.search.html">search</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#list">list(q=None, maxResults=None, startIndex=None, type=None, order=None)</a></code></p> |
| <p class="firstline">Universal search for youtube.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="list">list(q=None, maxResults=None, startIndex=None, type=None, order=None)</code> |
| <pre>Universal search for youtube. |
| |
| Args: |
| q: string, Query to search in Youtube. |
| maxResults: integer, Maximum number of search results to return per page. |
| startIndex: integer, Index of the first search result to return. |
| type: string, Type of resource to search. (repeated) |
| Allowed values |
| channel - Search for channels. |
| playlist - Search for playlists. |
| video - Search for videos. |
| order: string, Sort order. |
| Allowed values |
| date - Sort according to the date. |
| rating - Sort according to the rating. |
| relevance - Sort according to the relevance. |
| view_count - Sort according to the view count. |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for a SearchService.List() response. |
| "searchResults": [ # List of results matching the request criteria. |
| { # JSON template for a YouTube Search result. |
| "snippet": { # JSON template for the snippet part of a search result. # Basic details about the search result: title, description, author. |
| "channelId": "A String", # Author of the found resource. |
| "description": "A String", # Description of the search result. |
| "publishedAt": "A String", # The date and time the found resource was created. |
| "title": "A String", # Title of the search result. |
| }, |
| "kind": "youtube#searchResult", # The type of this API resource. |
| "etag": "A String", # The eTag of the search result. |
| "id": { # JSON template for a resource id. # The id of the resource. |
| "kind": "A String", # The kind of the referred resource. |
| "channelId": "A String", # ID of the referred channel. Present only when type is "CHANNEL". |
| "playlistId": "A String", # ID of the referred playlist. Present only when type is "PLAYLIST". |
| "videoId": "A String", # ID of the referred video. Present only when type is "VIDEO". |
| }, |
| }, |
| ], |
| "kind": "youtube#searchListResponse", # The type of this API response. |
| "etag": "A String", # The eTag of the response. |
| "pageInfo": { # JSON template for a page info. # Paging information for the search result. |
| "totalResults": 42, # The total number of results. |
| "startIndex": 42, # The index position of the first result to display. |
| "resultPerPage": 42, # The number of results to display for each page. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |