provider subscriptions GET
/youtube/v3/subscriptions @utdk/google/youtube
/youtube/v3/subscriptions subscriptions.list
Retrieves a list of resources, possibly filtered.
- $.xgafv query
- V1 error format.
- enum: 1, 2
- access_token query
- OAuth access token.
- string
- alt query
- Data format for response.
- enum: json, media, proto
- callback query
- JSONP
- string
- fields query
- Selector specifying which fields to include in a partial response.
- string
- key query
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- string
- oauth_token query
- OAuth 2.0 token for the current user.
- string
- prettyPrint query
- Returns response with indentations and line breaks.
- boolean
- quotaUser query
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- string
- upload_protocol query
- Upload protocol for media (e.g. "raw", "multipart").
- string
- uploadType query
- Legacy upload protocol for media (e.g. "media", "multipart").
- string
- part query 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.
- array
- channelId query
- Return the subscriptions of the given channel owner.
- string
- forChannelId query
- Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.
- string
- id query
- Return the subscriptions with the given IDs for Stubby or Apiary.
- array
- maxResults query
- The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
- integer
- mine query
- Flag for returning the subscriptions of the authenticated user.
- boolean
- myRecentSubscribers query
- boolean
- mySubscribers query
- Return the subscribers of the given channel owner.
- boolean
- onBehalfOfContentOwner query
- *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.
- string
- onBehalfOfContentOwnerChannel query
- 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.
- string
- order query
- The order of the returned subscriptions
- enum: subscriptionOrderUnspecified, relevance, unread, alphabetical
- pageToken query
- 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.
- string
Try it
Authentication
Configure credentials for YouTube Data API v3
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import google_youtube from '@utdk/google/youtube';
await google_youtube.subscriptionsList()