| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 | |
| 75 | <h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.search.html">search</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#list">list(q=None, maxResults=None, startIndex=None, type=None, order=None)</a></code></p> |
| 79 | <p class="firstline">Universal search for youtube.</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| 82 | <code class="details" id="list">list(q=None, maxResults=None, startIndex=None, type=None, order=None)</code> |
| 83 | <pre>Universal search for youtube. |
| 84 | |
| 85 | Args: |
| 86 | q: string, Query to search in Youtube. |
| 87 | maxResults: integer, Maximum number of search results to return per page. |
| 88 | startIndex: integer, Index of the first search result to return. |
| 89 | type: string, Type of resource to search. (repeated) |
| 90 | Allowed values |
| 91 | channel - Search for channels. |
| 92 | playlist - Search for playlists. |
| 93 | video - Search for videos. |
| 94 | order: string, Sort order. |
| 95 | Allowed values |
| 96 | date - Sort according to the date. |
| 97 | rating - Sort according to the rating. |
| 98 | relevance - Sort according to the relevance. |
| 99 | view_count - Sort according to the view count. |
| 100 | |
| 101 | Returns: |
| 102 | An object of the form: |
| 103 | |
| 104 | { # JSON template for a SearchService.List() response. |
| 105 | "searchResults": [ # List of results matching the request criteria. |
| 106 | { # JSON template for a YouTube Search result. |
| 107 | "snippet": { # JSON template for the snippet part of a search result. # Basic details about the search result: title, description, author. |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 108 | "channelId": "A String", # Author of the found resource. |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 109 | "description": "A String", # Description of the search result. |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 110 | "publishedAt": "A String", # The date and time the found resource was created. |
| 111 | "title": "A String", # Title of the search result. |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 112 | }, |
| 113 | "kind": "youtube#searchResult", # The type of this API resource. |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 114 | "etag": "A String", # The eTag of the search result. |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 115 | "id": { # JSON template for a resource id. # The id of the resource. |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 116 | "kind": "A String", # The kind of the referred resource. |
| 117 | "channelId": "A String", # ID of the referred channel. Present only when type is "CHANNEL". |
| 118 | "playlistId": "A String", # ID of the referred playlist. Present only when type is "PLAYLIST". |
| 119 | "videoId": "A String", # ID of the referred video. Present only when type is "VIDEO". |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 120 | }, |
| 121 | }, |
| 122 | ], |
| 123 | "kind": "youtube#searchListResponse", # The type of this API response. |
| 124 | "etag": "A String", # The eTag of the response. |
| 125 | "pageInfo": { # JSON template for a page info. # Paging information for the search result. |
| 126 | "totalResults": 42, # The total number of results. |
| 127 | "startIndex": 42, # The index position of the first result to display. |
| 128 | "resultPerPage": 42, # The number of results to display for each page. |
| 129 | }, |
| 130 | }</pre> |
| 131 | </div> |
| 132 | |
| 133 | </body></html> |