Class ChannelsResource.ListRequest
Returns a collection of zero or more channel resources that match the request criteria.
Inheritance
Inherited Members
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class ListRequest : YouTubeBaseServiceRequest<ChannelListResponse>, IClientServiceRequest<ChannelListResponse>, IClientServiceRequestConstructors
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
CategoryId
The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.
Declaration
[RequestParameter("categoryId", RequestParameterType.Query)]
public virtual string CategoryId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ForUsername
The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.
Declaration
[RequestParameter("forUsername", RequestParameterType.Query)]
public virtual string ForUsername { 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 brandingSettings 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
Id
The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.
Declaration
[RequestParameter("id", RequestParameterType.Query)]
public virtual string Id { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ManagedByMe
Note: This parameter is intended exclusively for YouTube content partners.
Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
Declaration
[RequestParameter("managedByMe", RequestParameterType.Query)]
public virtual bool? ManagedByMe { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
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
Mine
Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
Declaration
[RequestParameter("mine", RequestParameterType.Query)]
public virtual bool? Mine { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
MySubscribers
Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers to the authenticated user's channel.
Declaration
[RequestParameter("mySubscribers", RequestParameterType.Query)]
public virtual bool? MySubscribers { 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 |
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 channel 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 channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested 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
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()