Class VideosResource.ListRequest

Retrieves a list of resources, possibly filtered.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<VideoListResponse>
YouTubeBaseServiceRequest<VideoListResponse>
VideosResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class VideosResource.ListRequest : YouTubeBaseServiceRequest<VideoListResponse>, IClientServiceRequest<VideoListResponse>, 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<string> part

Properties

Chart

Return the videos that are in the specified chart.

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

Hl

Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

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

HttpMethod

Gets the HTTP method.

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

Id

Return videos with the given ids.

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

Locale

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

MaxHeight

Declaration
[RequestParameter("maxHeight", RequestParameterType.Query)]
public virtual int? MaxHeight { get; set; }
Property Value
Type Description
int?

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
long?

MaxWidth

Return the player with maximum height specified in

Declaration
[RequestParameter("maxWidth", RequestParameterType.Query)]
public virtual int? MaxWidth { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

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

MyRating

Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.

Declaration
[RequestParameter("myRating", RequestParameterType.Query)]
public virtual VideosResource.ListRequest.MyRatingEnum? MyRating { get; set; }
Property Value
Type Description
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
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
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 Repeatable<string> Part { get; }
Property Value
Type Description
Repeatable<string>

RegionCode

Use a chart that is specific to the specified region

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

RestPath

Gets the REST path.

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

VideoCategoryId

Use chart that is specific to the specified video category

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements