Network.Google.Resource.YouTube.Subscriptions.List

Returns subscription resources that match the API request criteria.

See: YouTube Data API Reference for youtube.subscriptions.list.

REST Resource

type SubscriptionsListResource = "youtube" :> ("v3" :> ("subscriptions" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "channelId" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "id" Text :> (QueryParam "mySubscribers" Bool :> (QueryParam "forChannelId" Text :> (QueryParam "pageToken" Text :> (QueryParam "order" SubscriptionsListOrder :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` SubscriptionListResponse))))))))))))))

A resource alias for youtube.subscriptions.list method which the SubscriptionsList request conforms to.

Creating a Request

subscriptionsList

Arguments

:: Text

sPart

-> SubscriptionsList

Creates a value of SubscriptionsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sPart
• sMine
• sChannelId
• sOnBehalfOfContentOwner
• sOnBehalfOfContentOwnerChannel
• sId
• sMySubscribers
• sForChannelId
• sPageToken
• sOrder
• sMaxResults

data SubscriptionsList

Returns subscription resources that match the API request criteria.

See: subscriptionsList smart constructor.

Instances

Eq SubscriptionsList

Data SubscriptionsList

Show SubscriptionsList

Generic SubscriptionsList

GoogleRequest SubscriptionsList

type Rep SubscriptionsList

type Rs SubscriptionsList = SubscriptionListResponse

Request Lenses

sPart :: Lens' SubscriptionsList Text

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.

sMine :: Lens' SubscriptionsList (Maybe Bool)

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

sChannelId :: Lens' SubscriptionsList (Maybe Text)

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

sOnBehalfOfContentOwner :: Lens' SubscriptionsList (Maybe Text)

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.

sOnBehalfOfContentOwnerChannel :: Lens' SubscriptionsList (Maybe Text)

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.

sId :: Lens' SubscriptionsList (Maybe Text)

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.

sMySubscribers :: Lens' SubscriptionsList (Maybe Bool)

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

sForChannelId :: Lens' SubscriptionsList (Maybe Text)

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

sPageToken :: Lens' SubscriptionsList (Maybe Text)

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.

sOrder :: Lens' SubscriptionsList SubscriptionsListOrder

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

sMaxResults :: Lens' SubscriptionsList Word32

The maxResults parameter specifies the maximum number of items that should be returned in the result set.