Class SearchResource.ListRequest

Retrieves a list of search resources

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, Repeatable<String>)

Constructs a new List request.

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

Properties

ChannelId

Filter on resources belonging to this channelId.

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

ChannelType

Add a filter on the channel search.

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

EventType

Filter on the livestream status of the videos.

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

ForContentOwner

Search owned by a content owner.

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

ForDeveloper

Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.

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

ForMine

Search for the private videos of the authenticated user.

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

Filter on location of the video

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

LocationRadius

Filter on distance from the location (specified above).

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

Sort order of the results.

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 Repeatable<string> Part { get; }
Property Value
Type Description
Repeatable<System.String>

PublishedAfter

Filter on resources published after this date.

Declaration
[RequestParameter("publishedAfter", RequestParameterType.Query)]
public virtual object PublishedAfter { get; set; }
Property Value
Type Description
System.Object

PublishedBefore

Filter on resources published before this date.

Declaration
[RequestParameter("publishedBefore", RequestParameterType.Query)]
public virtual object PublishedBefore { get; set; }
Property Value
Type Description
System.Object

Q

Textual search terms to match.

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

RegionCode

Display the content as seen by viewers in this country.

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

RelatedToVideoId

Search related to a resource.

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

RelevanceLanguage

Return results relevant to this language.

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

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

Restrict results to a particular topic.

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

Type

Restrict results to a particular set of resource types from One Platform.

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

VideoCaption

Filter on the presence of captions on the videos.

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

VideoCategoryId

Filter on videos in a specific category.

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

VideoDefinition

Filter on the definition of the videos.

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

VideoDimension

Filter on 3d videos.

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

VideoDuration

Filter on the duration of the videos.

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

VideoEmbeddable

Filter on embeddable videos.

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

VideoLicense

Filter on the license of the videos.

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

VideoSyndicated

Filter on syndicated videos.

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

VideoType

Filter on videos of a specific type.

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