Show / Hide Table of Contents

Class ChannelsResource.ListRequest

Retrieves a list of resources, possibly filtered.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ChannelListResponse>
YouTubeBaseServiceRequest<ChannelListResponse>
ChannelsResource.ListRequest
Implements
IClientServiceRequest<ChannelListResponse>
IClientServiceRequest
Inherited Members
YouTubeBaseServiceRequest<ChannelListResponse>.Xgafv
YouTubeBaseServiceRequest<ChannelListResponse>.AccessToken
YouTubeBaseServiceRequest<ChannelListResponse>.Alt
YouTubeBaseServiceRequest<ChannelListResponse>.Callback
YouTubeBaseServiceRequest<ChannelListResponse>.Fields
YouTubeBaseServiceRequest<ChannelListResponse>.Key
YouTubeBaseServiceRequest<ChannelListResponse>.OauthToken
YouTubeBaseServiceRequest<ChannelListResponse>.PrettyPrint
YouTubeBaseServiceRequest<ChannelListResponse>.QuotaUser
YouTubeBaseServiceRequest<ChannelListResponse>.UploadType
YouTubeBaseServiceRequest<ChannelListResponse>.UploadProtocol
ClientServiceRequest<ChannelListResponse>.Execute()
ClientServiceRequest<ChannelListResponse>.ExecuteAsStream()
ClientServiceRequest<ChannelListResponse>.ExecuteAsync()
ClientServiceRequest<ChannelListResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ChannelListResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ChannelListResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ChannelListResponse>.CreateRequest(Nullable<Boolean>)
ClientServiceRequest<ChannelListResponse>.GenerateRequestUri()
ClientServiceRequest<ChannelListResponse>.GetBody()
ClientServiceRequest<ChannelListResponse>.GetDefaultETagAction(String)
ClientServiceRequest<ChannelListResponse>.ETagAction
ClientServiceRequest<ChannelListResponse>.ModifyRequest
ClientServiceRequest<ChannelListResponse>.RequestParameters
ClientServiceRequest<ChannelListResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
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<ChannelListResponse>, IClientServiceRequest<ChannelListResponse>, 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

CategoryId

Return the channels within the specified guide category ID.

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

ForUsername

Return the channel associated with a YouTube username.

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

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

Id

Return the channels with the specified IDs.

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

ManagedByMe

Return the channels managed by the authenticated user.

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.ChannelListResponse>.MethodName

Mine

Return the ids of 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

Return the channels subscribed to the authenticated user

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

Methods

InitParameters()

Initializes List parameter list.

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

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
Back to top