Class SubscriptionsResource.ListRequest

Returns subscription resources that match the API request criteria.

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

The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions.

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

ForChannelId

The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels.

Declaration
[RequestParameter("forChannelId", RequestParameterType.Query)]
public virtual string ForChannelId { 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.SubscriptionListResponse>.HttpMethod

Id

The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription 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.SubscriptionListResponse>.MethodName

Mine

Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions.

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

MyRecentSubscribers

Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in reverse chronological order (newest first).

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

MySubscribers

Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in no particular order.

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

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

Order

The order parameter specifies the method that will be used to sort resources in the API response.

Declaration
[RequestParameter("order", RequestParameterType.Query)]
public virtual SubscriptionsResource.ListRequest.OrderEnum? Order { get; set; }
Property Value
Type Description
System.Nullable<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
System.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 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.SubscriptionListResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

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

Implements