googleapis

/// <reference types="node" /> import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common'; import { Readable } from 'stream'; export declare namespace youtube_v3 { export interface Options extends GlobalOptions { version: 'v3'; } interface StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth; /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * 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. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * 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. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * YouTube Data API v3 * * The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels. * * @example * ```js * const {google} = require('googleapis'); * const youtube = google.youtube('v3'); * ``` */ export class Youtube { context: APIRequestContext; abuseReports: Resource$Abusereports; activities: Resource$Activities; captions: Resource$Captions; channelBanners: Resource$Channelbanners; channels: Resource$Channels; channelSections: Resource$Channelsections; comments: Resource$Comments; commentThreads: Resource$Commentthreads; i18nLanguages: Resource$I18nlanguages; i18nRegions: Resource$I18nregions; liveBroadcasts: Resource$Livebroadcasts; liveChatBans: Resource$Livechatbans; liveChatMessages: Resource$Livechatmessages; liveChatModerators: Resource$Livechatmoderators; liveStreams: Resource$Livestreams; members: Resource$Members; membershipsLevels: Resource$Membershipslevels; playlistItems: Resource$Playlistitems; playlists: Resource$Playlists; search: Resource$Search; subscriptions: Resource$Subscriptions; superChatEvents: Resource$Superchatevents; tests: Resource$Tests; thirdPartyLinks: Resource$Thirdpartylinks; thumbnails: Resource$Thumbnails; videoAbuseReportReasons: Resource$Videoabusereportreasons; videoCategories: Resource$Videocategories; videos: Resource$Videos; watermarks: Resource$Watermarks; constructor(options: GlobalOptions, google?: GoogleConfigurable); } export interface Schema$AbuseReport { abuseTypes?: Schema$AbuseType[]; description?: string | null; relatedEntities?: Schema$RelatedEntity[]; subject?: Schema$Entity; } export interface Schema$AbuseType { id?: string | null; } /** * Rights management policy for YouTube resources. */ export interface Schema$AccessPolicy { /** * The value of allowed indicates whether the access to the policy is allowed or denied by default. */ allowed?: boolean | null; /** * A list of region codes that identify countries where the default policy do not apply. */ exception?: string[] | null; } /** * An *activity* resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded. */ export interface Schema$Activity { /** * The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video. */ contentDetails?: Schema$ActivityContentDetails; /** * Etag of this resource */ etag?: string | null; /** * The ID that YouTube uses to uniquely identify the activity. */ id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#activity". */ kind?: string | null; /** * The snippet object contains basic details about the activity, including the activity's type and group ID. */ snippet?: Schema$ActivitySnippet; } /** * Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. */ export interface Schema$ActivityContentDetails { /** * The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin. */ bulletin?: Schema$ActivityContentDetailsBulletin; /** * The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem. */ channelItem?: Schema$ActivityContentDetailsChannelItem; /** * The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment. */ comment?: Schema$ActivityContentDetailsComment; /** * The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite. */ favorite?: Schema$ActivityContentDetailsFavorite; /** * The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like. */ like?: Schema$ActivityContentDetailsLike; /** * The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem. */ playlistItem?: Schema$ActivityContentDetailsPlaylistItem; /** * The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem. */ promotedItem?: Schema$ActivityContentDetailsPromotedItem; /** * The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation. */ recommendation?: Schema$ActivityContentDetailsRecommendation; /** * The social object contains details about a social network post. This property is only present if the snippet.type is social. */ social?: Schema$ActivityContentDetailsSocial; /** * The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription. */ subscription?: Schema$ActivityContentDetailsSubscription; /** * The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload. */ upload?: Schema$ActivityContentDetailsUpload; } /** * Details about a channel bulletin post. */ export interface Schema$ActivityContentDetailsBulletin { /** * The resourceId object contains information that identifies the resource associated with a bulletin post. @mutable youtube.activities.insert */ resourceId?: Schema$ResourceId; } /** * Details about a resource which was added to a channel. */ export interface Schema$ActivityContentDetailsChannelItem { /** * The resourceId object contains information that identifies the resource that was added to the channel. */ resourceId?: Schema$ResourceId; } /** * Information about a resource that received a comment. */ export interface Schema$ActivityContentDetailsComment { /** * The resourceId object contains information that identifies the resource associated with the comment. */ resourceId?: Schema$ResourceId; } /** * Information about a video that was marked as a favorite video. */ export interface Schema$ActivityContentDetailsFavorite { /** * The resourceId object contains information that identifies the resource that was marked as a favorite. */ resourceId?: Schema$ResourceId; } /** * Information about a resource that received a positive (like) rating. */ export interface Schema$ActivityContentDetailsLike { /** * The resourceId object contains information that identifies the rated resource. */ resourceId?: Schema$ResourceId; } /** * Information about a new playlist item. */ export interface Schema$ActivityContentDetailsPlaylistItem { /** * The value that YouTube uses to uniquely identify the playlist. */ playlistId?: string | null; /** * ID of the item within the playlist. */ playlistItemId?: string | null; /** * The resourceId object contains information about the resource that was added to the playlist. */ resourceId?: Schema$ResourceId; } /** * Details about a resource which is being promoted. */ export interface Schema$ActivityContentDetailsPromotedItem { /** * The URL the client should fetch to request a promoted item. */ adTag?: string | null; /** * The URL the client should ping to indicate that the user clicked through on this promoted item. */ clickTrackingUrl?: string | null; /** * The URL the client should ping to indicate that the user was shown this promoted item. */ creativeViewUrl?: string | null; /** * The type of call-to-action, a message to the user indicating action that can be taken. */ ctaType?: string | null; /** * The custom call-to-action button text. If specified, it will override the default button text for the cta_type. */ customCtaButtonText?: string | null; /** * The text description to accompany the promoted item. */ descriptionText?: string | null; /** * The URL the client should direct the user to, if the user chooses to visit the advertiser's website. */ destinationUrl?: string | null; /** * The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown. */ forecastingUrl?: string[] | null; /** * The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item. */ impressionUrl?: string[] | null; /** * The ID that YouTube uses to uniquely identify the promoted video. */ videoId?: string | null; } /** * Information that identifies the recommended resource. */ export interface Schema$ActivityContentDetailsRecommendation { /** * The reason that the resource is recommended to the user. */ reason?: string | null; /** * The resourceId object contains information that identifies the recommended resource. */ resourceId?: Schema$ResourceId; /** * The seedResourceId object contains information about the resource that caused the recommendation. */ seedResourceId?: Schema$ResourceId; } /** * Details about a social network post. */ export interface Schema$ActivityContentDetailsSocial { /** * The author of the social network post. */ author?: string | null; /** * An image of the post's author. */ imageUrl?: string | null; /** * The URL of the social network post. */ referenceUrl?: string | null; /** * The resourceId object encapsulates information that identifies the resource associated with a social network post. */ resourceId?: Schema$ResourceId; /** * The name of the social network. */ type?: string | null; } /** * Information about a channel that a user subscribed to. */ export interface Schema$ActivityContentDetailsSubscription { /** * The resourceId object contains information that identifies the resource that the user subscribed to. */ resourceId?: Schema$ResourceId; } /** * Information about the uploaded video. */ export interface Schema$ActivityContentDetailsUpload { /** * The ID that YouTube uses to uniquely identify the uploaded video. */ videoId?: string | null; } export interface Schema$ActivityListResponse { /** * Etag of this resource. */ etag?: string | null; /** * Serialized EventId of the request which produced this response. */ eventId?: string | null; items?: Schema$Activity[]; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#activityListResponse". */ kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string | null; /** * General pagination information. */ pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ visitorId?: string | null; } /** * Basic details about an activity, including title, description, thumbnails, activity type and group. Next ID: 12 */ export interface Schema$ActivitySnippet { /** * The ID that YouTube uses to uniquely identify the channel associated with the activity. */ channelId?: string | null; /** * Channel title for the channel responsible for this activity */ channelTitle?: string | null; /** * The description of the resource primarily associated with the activity. @mutable youtube.activities.insert */ description?: string | null; /** * The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value. */ groupId?: string | null; /** * The date and time that the video was uploaded. */ publishedAt?: string | null; /** * A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** * The title of the resource primarily associated with the activity. */ title?: string | null; /** * The type of activity that the resource describes. */ type?: string | null; } /** * A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video. */ export interface Schema$Caption { /** * Etag of this resource. */ etag?: string | null; /** * The ID that YouTube uses to uniquely identify the caption track. */ id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#caption". */ kind?: string | null; /** * The snippet object contains basic details about the caption. */ snippet?: Schema$CaptionSnippet; } export interface Schema$CaptionListResponse { /** * Etag of this resource. */ etag?: string | null; /** * Serialized EventId of the request which produced this response. */ eventId?: string | null; /** * A list of captions that match the request criteria. */ items?: Schema$Caption[]; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse". */ kind?: string | null; /** * The visitorId identifies the visitor. */ visitorId?: string | null; } /** * Basic details about a caption track, such as its language and name. */ export interface Schema$CaptionSnippet { /** * The type of audio track associated with the caption track. */ audioTrackType?: string | null; /** * The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed. */ failureReason?: string | null; /** * Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions. */ isAutoSynced?: boolean | null; /** * Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false. */ isCC?: boolean | null; /** * Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update */ isDraft?: boolean | null; /** * Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false. */ isEasyReader?: boolean | null; /** * Indicates whether the caption track uses large text for the vision-impaired. The default value is false. */ isLarge?: boolean | null; /** * The language of the caption track. The property value is a BCP-47 language tag. */ language?: string | null; /** * The date and time when the caption track was last updated. */ lastUpdated?: string | null; /** * The name of the caption track. The name is intended to be visible to the user as an option during playback. */ name?: string | null; /** * The caption track's status. */ status?: string | null; /** * The caption track's type. */ trackKind?: string | null; /** * The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert */ videoId?: string | null; } /** * Brief description of the live stream cdn settings. */ export interface Schema$CdnSettings { /** * The format of the video stream that you are sending to Youtube. */ format?: string | null; /** * The frame rate of the inbound video data. */ frameRate?: string | null; /** * The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube. */ ingestionInfo?: Schema$IngestionInfo; /** * The method or protocol used to transmit the video stream. */ ingestionType?: string | null; /** * The resolution of the inbound video data. */ resolution?: string | null; } /** * A *channel* resource contains information about a YouTube channel. */ export interface Schema$Channel { /** * The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process. */ auditDetails?: Schema$ChannelAuditDetails; /** * The brandingSettings object encapsulates information about the branding of the channel. */ brandingSettings?: Schema$ChannelBrandingSettings; /** * The contentDetails object encapsulates information about the channel's content. */ contentDetails?: Schema$ChannelContentDetails; /** * The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. */ contentOwnerDetails?: Schema$ChannelContentOwnerDetails; /** * The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. */ conversionPings?: Schema$ChannelConversionPings; /** * Etag of this resource. */ etag?: string | null; /** * The ID that YouTube uses to uniquely identify the channel. */ id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channel". */ kind?: string | null; /** * Localizations for different languages */ localizations?: { [key: string]: Schema$ChannelLocalization; } | null; /** * The snippet object contains basic details about the channel, such as its title, description, and thumbnail images. */ snippet?: Schema$ChannelSnippet; /** * The statistics object encapsulates statistics for the channel. */ statistics?: Schema$ChannelStatistics; /** * The status object encapsulates information about the privacy status of the channel. */ status?: Schema$ChannelStatus; /** * The topicDetails object encapsulates information about Freebase topics associated with the channel. */ topicDetails?: Schema$ChannelTopicDetails; } /** * The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. */ export interface Schema$ChannelAuditDetails { /** * Whether or not the channel respects the community guidelines. */ communityGuidelinesGoodStanding?: boolean | null; /** * Whether or not the channel has any unresolved claims. */ contentIdClaimsGoodStanding?: boolean | null; /** * Whether or not the channel has any copyright strikes. */ copyrightStrikesGoodStanding?: boolean | null; } /** * A channel banner returned as the response to a channel_banner.insert call. */ export interface Schema$ChannelBannerResource { etag?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource". */ kind?: string | null; /** * The URL of this banner image. */ url?: string | null; } /** * Branding properties of a YouTube channel. */ export interface Schema$ChannelBrandingSettings { /** * Branding properties for the channel view. */ channel?: Schema$ChannelSettings; /** * Additional experimental branding properties. */ hints?: Schema$PropertyValue[]; /** * Branding properties for branding images. */ image?: Schema$ImageSettings; /** * Branding properties for the watch page. */ watch?: Schema$WatchSettings; } /** * Details about the content of a channel. */ export interface Schema$ChannelContentDetails { relatedPlaylists?: { favorites?: string; likes?: string; uploads?: string; watchHistory?: string; watchLater?: string; } | null; } /** * The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. */ export interface Schema$ChannelContentOwnerDetails { /** * The ID of the content owner linked to the channel. */ contentOwner?: string | null; /** * The date and time when the channel was linked to the content owner. */ timeLinked?: string | null; } /** * Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. */ export interface Schema$ChannelConversionPing { /** * Defines the context of the ping. */ context?: string | null; /** * The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. */ conversionUrl?: string | null; } /** * The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. */ export interface Schema$ChannelConversionPings { /** * Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. */ pings?: Schema$ChannelConversionPing[]; } export interface Schema$ChannelListResponse { /** * Etag of this resource. */ etag?: string | null; /** * Serialized EventId of the request which produced this response. */ eventId?: string | null; items?: Schema$Channel[]; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse". */ kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string | null; /** * General pagination information. */ pageInfo?: Schema$PageInfo; /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string | null; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ visitorId?: string | null; } /** * Channel localization setting */ export interface Schema$ChannelLocalization { /** * The localized strings for channel's description. */ description?: string | null; /** * The localized strings for channel's title. */ title?: string | null; } export interface Schema$ChannelProfileDetails { /** * The YouTube channel ID. */ channelId?: string | null; /** * The channel's URL. */ channelUrl?: string | null; /** * The channel's display name. */ displayName?: string | null; /** * The channels's avatar URL. */ profileImageUrl?: string | null; } export interface Schema$ChannelSection { /** * The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section. */ contentDetails?: Schema$ChannelSectionContentDetails; /** * Etag of this resource. */ etag?: string | null; /** * The ID that YouTube uses to uniquely identify the channel section. */ id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". */ kind?: string | null; /** * Localizations for different languages */ localizations?: { [key: string]: Schema$ChannelSectionLocalization; } | null; /** * The snippet object contains basic details about the channel section, such as its type, style and title. */ snippet?: Schema$ChannelSectionSnippet; /** * The targeting object contains basic targeting settings about the channel section. */ targeting?: Schema$ChannelSectionTargeting; } /** * Details about a channelsection, including playlists and channels. */ export interface Schema$ChannelSectionContentDetails { /** * The channel ids for type multiple_channels. */ channels?: string[] | null; /** * The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. */ playlists?: string[] | null; } export interface Schema$ChannelSectionListResponse { /** * Etag of this resource. */ etag?: string | null; /** * Serialized EventId of the request which produced this response. */ eventId?: string | null; /** * A list of ChannelSections that match the request criteria. */ items?: Schema$ChannelSection[]; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse". */ kind?: string | null; /** * The visitorId identifies the visitor. */ visitorId?: string | null; } /** * ChannelSection localization setting */ export interface Schema$ChannelSectionLocalization { /** * The localized strings for channel section's title. */ title?: string | null; } /** * Basic details about a channel section, including title, style and position. */ export interface Schema$ChannelSectionSnippet { /** * The ID that YouTube uses to uniquely identify the channel that published the channel section. */ channelId?: string | null; /** * The language of the channel section's default title and description. */ defaultLanguage?: string | null; /** * Localized title, read-only. */ localized?: Schema$ChannelSectionLocalization; /** * The position of the channel section in the channel. */ position?: number | null; /** * The style of the channel section. */ style?: string | null; /** * The channel section's title for multiple_playlists and multiple_channels. */ title?: string | null; /** * The type of the channel section. */ type?: string | null; } /** * ChannelSection targeting setting. */ export interface Schema$ChannelSectionTargeting { /** * The country the channel section is targeting. */ countries?: string[] | null; /** * The language the channel section is targeting. */ languages?: string[] | null; /** * The region the channel section is targeting. */ regions?: string[] | null; } /** * Branding properties for the channel view. */ export interface Schema$ChannelSettings { /** * The country of the channel. */ country?: string | null; defaultLanguage?: string | null; /** * Which content tab users should see when viewing the channel. */ defaultTab?: string | null; /** * Specifies the channel description. */ description?: string | null; /** * Title for the featured channels tab. */ featuredChannelsTitle?: string | null; /** * The list of featured channels. */ featuredChannelsUrls?: string[] | null; /** * Lists keywords associated with the channel, comma-separated. */ keywords?: string | null; /** * Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. */ moderateComments?: boolean | null; /** * A prominent color that can be rendered on this channel page. */ profileColor?: string | null; /** * Whether the tab to browse the videos should be displayed. */ showBrowseView?: boolean | null; /** * Whether related channels should be proposed. */ showRelatedChannels?: boolean | null; /** * Specifies the channel title. */ title?: string | null; /** * The ID for a Google Analytics account to track and measure traffic to the channels. */ trackingAnalyticsAccountId?: string | null; /** * The trailer of the channel, for users that are not subscribers. */ unsubscribedTrailer?: string | null; } /** * Basic details about a channel, including title, description and thumbnails. */ export interface Schema$ChannelSnippet { /** * The country of the channel. */ country?: string | null; /** * The custom url of the channel. */ customUrl?: string | null; /** * The language of the channel's default title and description. */ defaultLanguage?: string | null; /** * The description of the channel. */ description?: string | null; /** * Localized title and description, read-only. */ localized?: Schema$ChannelLocalization; /** * The date and time that the channel was created. */ publishedAt?: string | null; /** * A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response. Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain. Thumbnail images might be empty for newly created channels and might take up to one day to populate. */ thumbnails?: Schema$ThumbnailDetails; /** * The channel's title. */ title?: string | null; } /** * Statistics about a channel: number of subscribers, number of videos in the channel, etc. */ export interface Schema$ChannelStatistics { /** * The number of comments for the channel. */ commentCount?: string | null; /** * Whether or not the number of subscribers is shown for this user. */ hiddenSubscriberCount?: boolean | null; /** * The number of subscribers that the channel has. */ subscriberCount?: string | null; /** * The number of videos uploaded to the channel. */ videoCount?: string | null; /** * The number of times the channel has been viewed. */ viewCount?: string | null; } /** * JSON template for the status part of a channel. */ export interface Schema$ChannelStatus { /** * If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity. */ isLinked?: boolean | null; /** * The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information. */ longUploadsStatus?: string | null; madeForKids?: boolean | null; /** * Privacy status of the channel. */ privacyStatus?: string | null; selfDeclaredMadeForKids?: boolean | null; } /** * Freebase topic information related to the channel. */ export interface Schema$ChannelTopicDetails { /** * A list of Wikipedia URLs that describe the channel's content. */ topicCategories?: string[] | null; /** * A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API. */ topicIds?: string[] | null; } /** * Information specific to a store on a merchandising platform linked to a YouTube channel. */ export interface Schema$ChannelToStoreLinkDetails { /** * Name of the store. */ storeName?: string | null; /** * Landing page of the store. */ storeUrl?: string | null; } /** * A *comment* represents a single YouTube comment. */ export interface Schema$Comment { /** * Etag of this resource. */ etag?: string | null; /** * The ID that YouTube uses to uniquely identify the comment. */ id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#comment". */ kind?: string | null; /** * The snippet object contains basic details about the comment. */ snippet?: Schema$CommentSnippet; } export interface Schema$CommentListResponse { /** * Etag of this resource. */ etag?: string | null; /** * Serialized EventId of the request which produced this response. */ eventId?: string | null; /** * A list of comments that match the request criteria. */ items?: Schema$Comment[]; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse". */ kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string | null; /** * General pagination information. */ pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ visitorId?: string | null; } /** * Basic details about a comment, such as its author and text. */ export interface Schema$CommentSnippet { authorChannelId?: Schema$CommentSnippetAuthorChannelId; /** * Link to the author's YouTube channel, if any. */ authorChannelUrl?: string | null; /** * The name of the user who posted the comment. */ authorDisplayName?: string | null; /** * The URL for the avatar of the user who posted the comment. */ authorProfileImageUrl?: string | null; /** * Whether the current viewer can rate this comment. */ canRate?: boolean | null; /** * The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel. */ channelId?: string | null; /** * The total number of likes this comment has received. */ likeCount?: number | null; /** * The comment's moderation status. Will not be set if the comments were requested through the id filter. */ moderationStatus?: string | null; /** * The unique id of the parent comment, only set for replies. */ parentId?: string | null; /** * The date and time when the comment was originally published. */ publishedAt?: string | null; /** * The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc. */ textDisplay?: string | null; /** * The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author. */ textOriginal?: string | null; /** * The date and time when the comment was last updated. */ updatedAt?: string | null; /** * The ID of the video the comment refers to, if any. */ videoId?: string | null; /** * The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future. */ viewerRating?: string | null; } /** * The id of the author's YouTube channel, if any. */ export interface Schema$CommentSnippetAuthorChannelId { value?: string | null; } /** * A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies. */ export interface Schema$CommentThread { /** * Etag of this resource. */ etag?: string | null; /** * The ID that YouTube uses to uniquely identify the comment thread. */ id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". */ kind?: string | null; /** * The replies object contains a limited number of replies (if any) to the top level comment found in the snippet. */ replies?: Schema$CommentThreadReplies; /** * The snippet object contains basic details about the comment thread and also the top level comment. */ snippet?: Schema$CommentThreadSnippet; } export interface Schema$CommentThreadListResponse { /** * Etag of this resource. */ etag?: string | null; /** * Serialized EventId of the request which produced this response. */ eventId?: string | null; /** * A list of comment threads that match the request criteria. */ items?: Schema$CommentThread[]; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse". */ kind?: string | null; /** * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string | null; /** * General pagination information. */ pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; /** * The visitorId identifies the visitor. */ visitorId?: string | null; } /** * Comments written in (direct or indirect) reply to the top level comment. */ export interface Schema$CommentThreadReplies { /** * A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies. */ comments?: Schema$Comment[]; } /** * Basic details about a comment thread. */ export interface Schema$CommentThreadSnippet { /** * Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field. */ canReply?: boolean | null; /** * The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself. */ channelId?: string | null; /** * Whether the thread (and therefore all its comments) is visible to all YouTube users. */ isPublic?: boolean | null; /** * The top level comment of this thread. */ topLevelComment?: Schema$Comment; /** * The total number of replies (not including the top level comment). */ totalReplyCount?: number | null; /** * The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. */ videoId?: string | null; } /** * Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange */ export interface Schema$ContentRating { /** * The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. */ acbRating?: string | null; /** * The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). */ agcomRating?: string | null; /** * The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. */ anatelRating?: string | null; /** * The video's British Board of Film Classification (BBFC) rating. */ bbfcRating?: string | null; /** * The video's rating from Thailand's Board of Film and Video Censors. */ bfvcRating?: string | null; /** * The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). */ bmukkRating?: string | null; /** * The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. */ catvfrRating?: string | null;