# YouTube Data API v3 . search

## Instance Methods

Retrieves a list of search resources

Retrieves the next page of results.

### Method Details

`list(part, forDeveloper=None, locationRadius=None, videoDefinition=None, order=None, forContentOwner=None, videoType=None, topicId=None, videoEmbeddable=None, videoDuration=None, forMine=None, maxResults=None, relevanceLanguage=None, publishedAfter=None, pageToken=None, q=None, regionCode=None, onBehalfOfContentOwner=None, location=None, videoDimension=None, type=None, videoSyndicated=None, channelId=None, eventType=None, publishedBefore=None, videoCategoryId=None, channelType=None, relatedToVideoId=None, videoLicense=None, safeSearch=None, videoCaption=None, x__xgafv=None)`

    Retrieves a list of search resources

    Args:
      part: string, The <code><strong>part</strong></code> parameter specifies a
    comma-separated list of one or more <code>search</code> resource properties
    that the API response will include. Set the parameter value to
    <code>snippet</code>. (required) (repeated)
      forDeveloper: boolean, Restrict the search to only retrieve videos uploaded using the project id
    of the authenticated user.
      locationRadius: string, Filter on distance from the location (specified above).
      videoDefinition: string, Filter on the definition of the videos.
      order: string, Sort order of the results.
      forContentOwner: boolean, Search owned by a content owner.
      videoType: string, Filter on videos of a specific type.
      topicId: string, Restrict results to a particular topic.
      videoEmbeddable: string, Filter on embeddable videos.
      videoDuration: string, Filter on the duration of the videos.
      forMine: boolean, Search for the private videos of the authenticated user.
      maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the
    maximum number of items that should be returned in the result set.
      relevanceLanguage: string, Return results relevant to this language.
      publishedAfter: string, Filter on resources published after this date.
      pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific
    page in the result set that should be returned. In an API response, the
    <code>nextPageToken</code> and <code>prevPageToken</code> properties
    identify other pages that could be retrieved.
      q: string, Textual search terms to match.
      regionCode: string, Display the content as seen by viewers in this country.
      onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
    content partners.<br><br>The
    <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates
    that the
    request'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.
      location: string, Filter on location of the video
      videoDimension: string, Filter on 3d videos.
      type: string, Restrict results to a particular set of resource types from One Platform. (repeated)
      videoSyndicated: string, Filter on syndicated videos.
      channelId: string, Filter on resources belonging to this channelId.
      eventType: string, Filter on the livestream status of the videos.
      publishedBefore: string, Filter on resources published before this date.
      videoCategoryId: string, Filter on videos in a specific category.
      channelType: string, Add a filter on the channel search.
      relatedToVideoId: string, Search related to a resource.
      videoLicense: string, Filter on the license of the videos.
      safeSearch: string, Indicates whether the search results should include restricted content as
    well as standard content.
      videoCaption: string, Filter on the presence of captions on the videos.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
            # parameter to retrieve the next page in the result set.
        "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
        "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.
            # available and number of resources returned in a single page.
          "resultsPerPage": 42, # The number of results included in the API response.
          "totalResults": 42, # The total number of results in the result set.
        },
        "etag": "A String", # Etag of this resource.
        "eventId": "A String", # Serialized EventId of the request which produced this response.
        "tokenPagination": { # Stub token pagination template to suppress results.
        },
        "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
            # parameter to retrieve the previous page in the result set.
        "regionCode": "A String",
        "kind": "youtube#searchListResponse", # Identifies what kind of resource this is. Value: the fixed string
            # <code>"youtube#searchListResponse"</code>.
        "items": [ # Pagination information for token pagination.
          { # 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.
            "kind": "youtube#searchResult", # Identifies what kind of resource this is. Value: the fixed string
                # <code>"youtube#searchResult"</code>.
            "snippet": { # Basic details about a search result, including title, description and # The <code>snippet</code> 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.
                # thumbnails of the item referenced by the search result.
              "description": "A String", # A description of the search result.
              "channelTitle": "A String", # The title of the channel that published the resource that the search result
                  # identifies.
              "publishedAt": "A String", # The creation date and time of the resource that the search result
                  # identifies. The value is specified in <a
                  # href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
                  # format.
              "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.
                "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
                  "width": 42, # (Optional) Width of the thumbnail image.
                  "url": "A String", # The thumbnail image's URL.
                  "height": 42, # (Optional) Height of the thumbnail image.
                },
                "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
                  "width": 42, # (Optional) Width of the thumbnail image.
                  "url": "A String", # The thumbnail image's URL.
                  "height": 42, # (Optional) Height of the thumbnail image.
                },
                "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
                  "width": 42, # (Optional) Width of the thumbnail image.
                  "url": "A String", # The thumbnail image's URL.
                  "height": 42, # (Optional) Height of the thumbnail image.
                },
                "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
                  "width": 42, # (Optional) Width of the thumbnail image.
                  "url": "A String", # The thumbnail image's URL.
                  "height": 42, # (Optional) Height of the thumbnail image.
                },
                "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
                  "width": 42, # (Optional) Width of the thumbnail image.
                  "url": "A String", # The thumbnail image's URL.
                  "height": 42, # (Optional) Height of the thumbnail image.
                },
              },
              "title": "A String", # The title of the search result.
              "liveBroadcastContent": "A String", # It indicates if the resource (video or channel) has upcoming/active live
                  # broadcast content. Or it's "none" if there is not any upcoming/active
                  # live broadcasts.
              "channelId": "A String", # The value that YouTube uses to uniquely identify the channel that
                  # published the resource that the search result identifies.
            },
            "id": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information that can be used to
                # uniquely identify the resource that matches the search request.
              "kind": "A String", # The type of the API resource.
              "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
                  # <code>resourceId.kind</code> value is <code>youtube#video</code>.
              "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
                  # <code>resourceId.kind</code> value is <code>youtube#channel</code>.
              "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
                  # <code>resourceId.kind</code> value is <code>youtube#playlist</code>.
            },
            "etag": "A String", # Etag of this resource.
          },
        ],
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.