List

Returns subscription resources that match the API request criteria

12 variables
35 variables

Returns subscription resources that match the API request criteria

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage your YouTube account
  • See, edit, and permanently delete your YouTube videos, ratings, comments and captions
  • View your YouTube account
  • View and manage your assets and associated content on YouTube

Input

This building block consumes 12 input parameters

  = Parameter name
  = Format

part STRING Required

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

channelId STRING

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

forChannelId STRING

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

id STRING

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

maxResults INTEGER

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

mine BOOLEAN

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

myRecentSubscribers BOOLEAN

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

mySubscribers BOOLEAN

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

onBehalfOfContentOwner STRING

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

onBehalfOfContentOwnerChannel STRING

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

order ENUMERATION

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

pageToken STRING

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

Output

This building block provides 35 output parameters

  = Parameter name
  = Format

etag STRING

Etag of this resource

eventId STRING

Serialized EventId of the request which produced this response

items[] OBJECT

A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video

items[].contentDetails OBJECT

Details about the content to witch a subscription refers

items[].contentDetails.activityType ENUMERATION

The type of activity this subscription is for (only uploads, everything)

items[].contentDetails.newItemCount INTEGER

The number of new items in the subscription since its content was last read

items[].contentDetails.totalItemCount INTEGER

The approximate number of items that the subscription points to

items[].etag STRING

Etag of this resource

items[].id STRING

The ID that YouTube uses to uniquely identify the subscription

items[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#subscription"

items[].snippet OBJECT

Basic details about a subscription, including title, description and thumbnails of the subscribed item

items[].snippet.channelId STRING

The ID that YouTube uses to uniquely identify the subscriber's channel

items[].snippet.channelTitle STRING

Channel title for the channel that the subscription belongs to

items[].snippet.description STRING

The subscription's details

items[].snippet.publishedAt DATE_TIME

The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format

items[].snippet.resourceId OBJECT

A resource id is a generic reference that points to another YouTube resource

items[].snippet.resourceId.channelId STRING

The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel

items[].snippet.resourceId.kind STRING

The type of the API resource

items[].snippet.resourceId.playlistId STRING

The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist

items[].snippet.resourceId.videoId STRING

The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video

items[].snippet.thumbnails OBJECT

Internal representation of thumbnails for a YouTube resource

items[].snippet.title STRING

The subscription's title

items[].subscriberSnippet OBJECT

Basic details about a subscription's subscriber including title, description, channel ID and thumbnails

items[].subscriberSnippet.channelId STRING

The channel ID of the subscriber

items[].subscriberSnippet.description STRING

The description of the subscriber

items[].subscriberSnippet.thumbnails OBJECT

Internal representation of thumbnails for a YouTube resource

items[].subscriberSnippet.title STRING

The title of the subscriber

kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse"

nextPageToken STRING

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set

pageInfo OBJECT

Paging details for lists of resources, including total number of items available and number of resources returned in a single page

pageInfo.resultsPerPage INTEGER

The number of results included in the API response

pageInfo.totalResults INTEGER

The total number of results in the result set

prevPageToken STRING

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set

tokenPagination OBJECT

Stub token pagination template to suppress results

visitorId STRING

The visitorId identifies the visitor