YouTube API . search

Instance Methods

list(q=None, maxResults=None, startIndex=None, type=None, order=None)

Universal search for youtube.

Method Details

list(q=None, maxResults=None, startIndex=None, type=None, order=None)
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.
    },
  }