Class PlaylistsResource.ListRequest

Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.

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

This value indicates that the API should only return the specified channel's playlists.

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

Hl

The hl parameter should be used for filter out the properties that are not in the given language. Used for the snippet part.

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

Id

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

Declaration
[RequestParameter("id", RequestParameterType.Query)]
public virtual string Id { 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.PlaylistListResponse>.MethodName

Mine

Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user.

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

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

OnBehalfOfContentOwnerChannel

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

Declaration
[RequestParameter("onBehalfOfContentOwnerChannel", RequestParameterType.Query)]
public virtual string OnBehalfOfContentOwnerChannel { 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.

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 playlist 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 playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. 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

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

Methods

InitParameters()

Initializes List parameter list.

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

Implements