Class SearchResource.ListRequest

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.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<SearchListResponse>
YouTubeBaseServiceRequest<SearchListResponse>
SearchResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class ListRequest : YouTubeBaseServiceRequest<SearchListResponse>, IClientServiceRequest<SearchListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string part)
Parameters
Type Name Description
IClientService service
System.String part

Properties

ChannelId

The channelId parameter indicates that the API response should only contain resources created by the channel

Declaration
[RequestParameter("channelId", RequestParameterType.Query)]
public virtual string ChannelId { get; set; }
Property Value
Type Description
System.String

ChannelType

The channelType parameter lets you restrict a search to a particular type of channel.

Declaration
[RequestParameter("channelType", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.ChannelTypeEnum? ChannelType { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.ChannelTypeEnum>

EventType

The eventType parameter restricts a search to broadcast events. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("eventType", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.EventTypeEnum? EventType { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.EventTypeEnum>

ForContentOwner

Note: This parameter is intended exclusively for YouTube content partners.

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 using a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.

Declaration
[RequestParameter("forContentOwner", RequestParameterType.Query)]
public virtual bool? ForContentOwner { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ForDeveloper

The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website. The API server uses the request's authorization credentials to identify the developer. Therefore, a developer can restrict results to videos uploaded through the developer's own app or website but not to videos uploaded through other apps or sites.

Declaration
[RequestParameter("forDeveloper", RequestParameterType.Query)]
public virtual bool? ForDeveloper { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ForMine

The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. If you set this parameter to true, then the type parameter's value must also be set to video.

Declaration
[RequestParameter("forMine", RequestParameterType.Query)]
public virtual bool? ForMine { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.SearchListResponse>.HttpMethod

Location

The location parameter, in conjunction with the locationRadius parameter, defines a circular geographic area and also restricts a search to videos that specify, in their metadata, a geographic location that falls within that area. The parameter value is a string that specifies latitude/longitude coordinates e.g. (37.42307,-122.08427).

  • The location parameter value identifies the point at the center of the area. - The locationRadius parameter specifies the maximum distance that the location associated with a video can be from that point for the video to still be included in the search results.The API returns an error if your request specifies a value for the location parameter but does not also specify a value for the locationRadius parameter.
Declaration
[RequestParameter("location", RequestParameterType.Query)]
public virtual string Location { get; set; }
Property Value
Type Description
System.String

LocationRadius

The locationRadius parameter, in conjunction with the location parameter, defines a circular geographic area.

The parameter value must be a floating point number followed by a measurement unit. Valid measurement units are m, km, ft, and mi. For example, valid parameter values include 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius parameter values larger than 1000 kilometers.

Note: See the definition of the location parameter for more information.

Declaration
[RequestParameter("locationRadius", RequestParameterType.Query)]
public virtual string LocationRadius { get; set; }
Property Value
Type Description
System.String

MaxResults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.SearchListResponse>.MethodName

OnBehalfOfContentOwner

Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner 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.

Declaration
[RequestParameter("onBehalfOfContentOwner", RequestParameterType.Query)]
public virtual string OnBehalfOfContentOwner { get; set; }
Property Value
Type Description
System.String

Order

The order parameter specifies the method that will be used to order resources in the API response.

Declaration
[RequestParameter("order", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.OrderEnum? Order { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.OrderEnum>

PageToken

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
System.String

Part

The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet.

Declaration
[RequestParameter("part", RequestParameterType.Query)]
public virtual string Part { get; }
Property Value
Type Description
System.String

PublishedAfter

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).

Declaration
[RequestParameter("publishedAfter", RequestParameterType.Query)]
public virtual DateTime? PublishedAfter { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

PublishedBefore

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).

Declaration
[RequestParameter("publishedBefore", RequestParameterType.Query)]
public virtual DateTime? PublishedBefore { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Q

The q parameter specifies the query term to search for.

Your request can also use the Boolean NOT (-) and OR (|) operators to exclude videos or to find videos that are associated with one of several search terms. For example, to search for videos matching either "boating" or "sailing", set the q parameter value to boating|sailing. Similarly, to search for videos matching either "boating" or "sailing" but not "fishing", set the q parameter value to boating|sailing -fishing. Note that the pipe character must be URL-escaped when it is sent in your API request. The URL- escaped value for the pipe character is %7C.

Declaration
[RequestParameter("q", RequestParameterType.Query)]
public virtual string Q { get; set; }
Property Value
Type Description
System.String

RegionCode

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.

Declaration
[RequestParameter("regionCode", RequestParameterType.Query)]
public virtual string RegionCode { get; set; }
Property Value
Type Description
System.String

RelatedToVideoId

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.

Declaration
[RequestParameter("relatedToVideoId", RequestParameterType.Query)]
public virtual string RelatedToVideoId { get; set; }
Property Value
Type Description
System.String

RelevanceLanguage

The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language. The parameter value is typically an ISO 639-1 two-letter language code. However, you should use the values zh-Hans for simplified Chinese and zh-Hant for traditional Chinese. Please note that results in other languages will still be returned if they are highly relevant to the search query term.

Declaration
[RequestParameter("relevanceLanguage", RequestParameterType.Query)]
public virtual string RelevanceLanguage { get; set; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.SearchListResponse>.RestPath

SafeSearch

The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.

Declaration
[RequestParameter("safeSearch", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.SafeSearchEnum? SafeSearch { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.SafeSearchEnum>

TopicId

The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID.

Declaration
[RequestParameter("topicId", RequestParameterType.Query)]
public virtual string TopicId { get; set; }
Property Value
Type Description
System.String

Type

The type parameter restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types.

Declaration
[RequestParameter("type", RequestParameterType.Query)]
public virtual string Type { get; set; }
Property Value
Type Description
System.String

VideoCaption

The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoCaption", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoCaptionEnum? VideoCaption { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoCaptionEnum>

VideoCategoryId

The videoCategoryId parameter filters video search results based on their category. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoCategoryId", RequestParameterType.Query)]
public virtual string VideoCategoryId { get; set; }
Property Value
Type Description
System.String

VideoDefinition

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. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoDefinition", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoDefinitionEnum? VideoDefinition { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoDefinitionEnum>

VideoDimension

The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoDimension", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoDimensionEnum? VideoDimension { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoDimensionEnum>

VideoDuration

The videoDuration parameter filters video search results based on their duration. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoDuration", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoDurationEnum? VideoDuration { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoDurationEnum>

VideoEmbeddable

The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoEmbeddable", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoEmbeddableEnum? VideoEmbeddable { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoEmbeddableEnum>

VideoLicense

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. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoLicense", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoLicenseEnum? VideoLicense { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoLicenseEnum>

VideoSyndicated

The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoSyndicated", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoSyndicatedEnum? VideoSyndicated { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoSyndicatedEnum>

VideoType

The videoType parameter lets you restrict a search to a particular type of videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Declaration
[RequestParameter("videoType", RequestParameterType.Query)]
public virtual SearchResource.ListRequest.VideoTypeEnum? VideoType { get; set; }
Property Value
Type Description
System.Nullable<SearchResource.ListRequest.VideoTypeEnum>

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.YouTube.v3.YouTubeBaseServiceRequest<Google.Apis.YouTube.v3.Data.SearchListResponse>.InitParameters()

Implements