Class VideosResource.ListRequest

Returns a list of videos that match the API request parameters.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<VideoListResponse>
YouTubeBaseServiceRequest<VideoListResponse>
VideosResource.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<VideoListResponse>, IClientServiceRequest<VideoListResponse>, 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

Chart

The chart parameter identifies the chart that you want to retrieve.

Declaration
[RequestParameter("chart", RequestParameterType.Query)]
public virtual VideosResource.ListRequest.ChartEnum? Chart { get; set; }
Property Value
Type Description
System.Nullable<VideosResource.ListRequest.ChartEnum>

Hl

The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.

If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

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

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.VideoListResponse>.HttpMethod

Id

The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.

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

Locale

DEPRECATED

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

MaxHeight

The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request.

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

MaxResults

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

Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

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

MaxWidth

The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request.

Declaration
[RequestParameter("maxWidth", RequestParameterType.Query)]
public virtual long? MaxWidth { 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.VideoListResponse>.MethodName

MyRating

Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.

Declaration
[RequestParameter("myRating", RequestParameterType.Query)]
public virtual VideosResource.ListRequest.MyRatingEnum? MyRating { get; set; }
Property Value
Type Description
System.Nullable<VideosResource.ListRequest.MyRatingEnum>

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

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.

Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

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 video resource properties that the API response will include.

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.

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

RegionCode

The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. 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

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.VideoListResponse>.RestPath

VideoCategoryId

The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category.

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

Methods

InitParameters()

Initializes List parameter list.

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

Implements