Class SubscriptionsResource.ListRequest

Retrieves a list of resources, possibly filtered.

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

ChannelId

Return the subscriptions of the given channel owner.

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

ForChannelId

Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

Id

Return the subscriptions with the given IDs for Stubby or Apiary.

Declaration
[RequestParameter("id", RequestParameterType.Query)]
public virtual Repeatable<string> Id { get; set; }
Property Value
Type Description
Repeatable<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
long?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Mine

Flag for returning the subscriptions of the authenticated user.

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

MyRecentSubscribers

Declaration
[RequestParameter("myRecentSubscribers", RequestParameterType.Query)]
public virtual bool? MyRecentSubscribers { get; set; }
Property Value
Type Description
bool?

MySubscribers

Return the subscribers of the given channel owner.

Declaration
[RequestParameter("mySubscribers", RequestParameterType.Query)]
public virtual bool? MySubscribers { get; set; }
Property Value
Type Description
bool?

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

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
string

Order

The order of the returned subscriptions

Declaration
[RequestParameter("order", RequestParameterType.Query)]
public virtual SubscriptionsResource.ListRequest.OrderEnum? Order { get; set; }
Property Value
Type Description
SubscriptionsResource.ListRequest.OrderEnum?

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
string

Part

The part parameter specifies a comma-separated list of one or more subscription 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 subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, 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<string>

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements