API Reference google_api_you_tube v0.54.0

API client metadata for GoogleApi.YouTube.V3.

API calls for all endpoints tagged AbuseReports.

API calls for all endpoints tagged Activities.

API calls for all endpoints tagged Captions.

API calls for all endpoints tagged ChannelBanners.

API calls for all endpoints tagged ChannelSections.

API calls for all endpoints tagged Channels.

API calls for all endpoints tagged CommentThreads.

API calls for all endpoints tagged Comments.

API calls for all endpoints tagged I18nLanguages.

API calls for all endpoints tagged I18nRegions.

API calls for all endpoints tagged LiveBroadcasts.

API calls for all endpoints tagged LiveChatBans.

API calls for all endpoints tagged LiveChatMessages.

API calls for all endpoints tagged LiveChatModerators.

API calls for all endpoints tagged LiveStreams.

API calls for all endpoints tagged Members.

API calls for all endpoints tagged MembershipsLevels.

API calls for all endpoints tagged PlaylistImages.

API calls for all endpoints tagged PlaylistItems.

API calls for all endpoints tagged Playlists.

API calls for all endpoints tagged Search.

API calls for all endpoints tagged Subscriptions.

API calls for all endpoints tagged SuperChatEvents.

API calls for all endpoints tagged Tests.

API calls for all endpoints tagged ThirdPartyLinks.

API calls for all endpoints tagged Thumbnails.

API calls for all endpoints tagged VideoAbuseReportReasons.

API calls for all endpoints tagged VideoCategories.

API calls for all endpoints tagged VideoTrainability.

API calls for all endpoints tagged Videos.

API calls for all endpoints tagged Watermarks.

API calls for all endpoints tagged Youtube.

Handle Tesla connections for GoogleApi.YouTube.V3.

Attributes

• abuseTypes (type: list(GoogleApi.YouTube.V3.Model.AbuseType.t), default: nil) -
• description (type: String.t, default: nil) -
• relatedEntities (type: list(GoogleApi.YouTube.V3.Model.RelatedEntity.t), default: nil) -
• subject (type: GoogleApi.YouTube.V3.Model.Entity.t, default: nil) -

Attributes

• id (type: String.t, default: nil) -

Rights management policy for YouTube resources.

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.

Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc.

Details about a channel bulletin post.

Details about a resource which was added to a channel.

Information about a resource that received a comment.

Information about a video that was marked as a favorite video.

Information about a resource that received a positive (like) rating.

Information about a new playlist item.

Details about a resource which is being promoted.

Information that identifies the recommended resource.

Details about a social network post.

Information about a channel that a user subscribed to.

Information about the uploaded video.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Activity.t), default: nil) -
• kind (type: String.t, default: youtube#activityListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#activityListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about an activity, including title, description, thumbnails, activity type and group. Next ID: 12

A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Caption.t), default: nil) - A list of captions that match the request criteria.
• kind (type: String.t, default: youtube#captionListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about a caption track, such as its language and name.

Brief description of the live stream cdn settings.

A channel resource contains information about a YouTube channel.

The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process.

A channel banner returned as the response to a channel_banner.insert call.

Branding properties of a YouTube channel.

Details about the content of a channel.

Attributes

• favorites (type: String.t, default: nil) - The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
• likes (type: String.t, default: nil) - The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
• uploads (type: String.t, default: nil) - The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.
• watchHistory (type: String.t, default: nil) - The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
• watchLater (type: String.t, default: nil) - The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.

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.

The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Channel.t), default: nil) -
• kind (type: String.t, default: youtube#channelListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Channel localization setting

Attributes

• channelId (type: String.t, default: nil) - The YouTube channel ID.
• channelUrl (type: String.t, default: nil) - The channel's URL.
• displayName (type: String.t, default: nil) - The channel's display name.
• profileImageUrl (type: String.t, default: nil) - The channels's avatar URL.

Attributes

• contentDetails (type: GoogleApi.YouTube.V3.Model.ChannelSectionContentDetails.t, default: nil) - The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
• etag (type: String.t, default: nil) - Etag of this resource.
• id (type: String.t, default: nil) - The ID that YouTube uses to uniquely identify the channel section.
• kind (type: String.t, default: youtube#channelSection) - Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
• localizations (type: %{optional(String.t) => GoogleApi.YouTube.V3.Model.ChannelSectionLocalization.t}, default: nil) - Localizations for different languages
• snippet (type: GoogleApi.YouTube.V3.Model.ChannelSectionSnippet.t, default: nil) - The snippet object contains basic details about the channel section, such as its type, style and title.
• targeting (type: GoogleApi.YouTube.V3.Model.ChannelSectionTargeting.t, default: nil) - The targeting object contains basic targeting settings about the channel section.

Details about a channelsection, including playlists and channels.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.ChannelSection.t), default: nil) - A list of ChannelSections that match the request criteria.
• kind (type: String.t, default: youtube#channelSectionListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

ChannelSection localization setting

Basic details about a channel section, including title, style and position.

ChannelSection targeting setting.

Branding properties for the channel view.

Basic details about a channel, including title, description and thumbnails.

Statistics about a channel: number of subscribers, number of videos in the channel, etc.

JSON template for the status part of a channel.

Information specific to a store on a merchandising platform linked to a YouTube channel.

Information specific to billing.

Information specific to merchant affiliate program.

Freebase topic information related to the channel.

A comment represents a single YouTube comment.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Comment.t), default: nil) - A list of comments that match the request criteria.
• kind (type: String.t, default: youtube#commentListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about a comment, such as its author and text.

Contains the id of the author's YouTube channel, if any.

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.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.CommentThread.t), default: nil) - A list of comment threads that match the request criteria.
• kind (type: String.t, default: youtube#commentThreadListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Comments written in (direct or indirect) reply to the top level comment.

Basic details about a comment thread.

Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange

Note that there may be a 5-second end-point resolution issue. For instance, if a cuepoint comes in for 22:03:27, we may stuff the cuepoint into 22:03:25 or 22:03:30, depending. This is an artifact of HLS.

Schedule to insert cuepoints into a broadcast by ads automator.

Attributes

• id (type: String.t, default: nil) -
• typeId (type: String.t, default: nil) -
• url (type: String.t, default: nil) -

Geographical coordinates of a point, in WGS84.

An i18nLanguage resource identifies a UI language currently supported by YouTube.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.I18nLanguage.t), default: nil) - A list of supported i18n languages. In this map, the i18n language ID is the map key, and its value is the corresponding i18nLanguage resource.
• kind (type: String.t, default: youtube#i18nLanguageListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguageListResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about an i18n language, such as language code and human-readable name.

A i18nRegion resource identifies a region where YouTube is available.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.I18nRegion.t), default: nil) - A list of regions where YouTube is available. In this map, the i18n region ID is the map key, and its value is the corresponding i18nRegion resource.
• kind (type: String.t, default: youtube#i18nRegionListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegionListResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about an i18n region, such as region code and human-readable name.

Branding properties for images associated with the channel.

Describes information necessary for ingesting an RTMP, HTTP, or SRT stream.

Describes an invideo branding.

Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one.

Describes a temporal position of a visual widget inside a video.

Attributes

• value (type: String.t, default: nil) -

Attributes

• displayName (type: String.t, default: nil) - The name that should be used when referring to this level.

A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.

Detailed settings of a broadcast.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.LiveBroadcast.t), default: nil) - A list of broadcasts that match the request criteria.
• kind (type: String.t, default: youtube#liveBroadcastListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Monetization settings of a broadcast.

Basic broadcast information.

Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts.

Live broadcast state.

A __liveChatBan__ resource represents a ban for a YouTube live chat.

Attributes

• banDurationSeconds (type: String.t, default: nil) - The duration of a ban, only filled if the ban has type TEMPORARY.
• bannedUserDetails (type: GoogleApi.YouTube.V3.Model.ChannelProfileDetails.t, default: nil) -
• liveChatId (type: String.t, default: nil) - The chat this ban is pertinent to.
• type (type: String.t, default: nil) - The type of ban.

Attributes

• amountDisplayString (type: String.t, default: nil) - A rendered string that displays the fund amount and currency to the user.
• amountMicros (type: String.t, default: nil) - The amount of the fund.
• currency (type: String.t, default: nil) - The currency in which the fund was made.
• userComment (type: String.t, default: nil) - The comment added by the user to this fan funding event.

Attributes

• associatedMembershipGiftingMessageId (type: String.t, default: nil) - The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.
• gifterChannelId (type: String.t, default: nil) - The ID of the user that made the membership gifting purchase. This matches the snippet.authorChannelId of the associated membership gifting message.
• memberLevelName (type: String.t, default: nil) - The name of the Level at which the viewer is a member. This matches the snippet.membershipGiftingDetails.giftMembershipsLevelName of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.

Attributes

• memberLevelName (type: String.t, default: nil) - The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
• memberMonth (type: integer(), default: nil) - The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.
• userComment (type: String.t, default: nil) - The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.

Attributes

• giftMembershipsCount (type: integer(), default: nil) - The number of gift memberships purchased by the user.
• giftMembershipsLevelName (type: String.t, default: nil) - The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.

A liveChatMessage resource represents a chat message in a YouTube Live Chat.

Attributes

• channelId (type: String.t, default: nil) - The YouTube channel ID.
• channelUrl (type: String.t, default: nil) - The channel's URL.
• displayName (type: String.t, default: nil) - The channel's display name.
• isChatModerator (type: boolean(), default: nil) - Whether the author is a moderator of the live chat.
• isChatOwner (type: boolean(), default: nil) - Whether the author is the owner of the live chat.
• isChatSponsor (type: boolean(), default: nil) - Whether the author is a sponsor of the live chat.
• isVerified (type: boolean(), default: nil) - Whether the author's identity has been verified by YouTube.
• profileImageUrl (type: String.t, default: nil) - The channels's avatar URL.

Attributes

• deletedMessageId (type: String.t, default: nil) -

Attributes

• activePollItem (type: GoogleApi.YouTube.V3.Model.LiveChatMessage.t, default: nil) - Set when there is an active poll.
• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.LiveChatMessage.t), default: nil) -
• kind (type: String.t, default: youtube#liveChatMessageListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse".
• nextPageToken (type: String.t, default: nil) -
• offlineAt (type: DateTime.t, default: nil) - The date and time when the underlying stream went offline.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• pollingIntervalMillis (type: integer(), default: nil) - The amount of time the client should wait before polling again.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Attributes

• retractedMessageId (type: String.t, default: nil) -

Next ID: 34

A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.LiveChatModerator.t), default: nil) - A list of moderators that match the request criteria.
• kind (type: String.t, default: youtube#liveChatModeratorListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Attributes

• liveChatId (type: String.t, default: nil) - The ID of the live chat this moderator can act on.
• moderatorDetails (type: GoogleApi.YouTube.V3.Model.ChannelProfileDetails.t, default: nil) - Details about the moderator.

Attributes

• isUpgrade (type: boolean(), default: nil) - If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.
• memberLevelName (type: String.t, default: nil) - The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.

Attributes

• metadata (type: GoogleApi.YouTube.V3.Model.LiveChatPollDetailsPollMetadata.t, default: nil) -
• status (type: String.t, default: nil) -

Attributes

• options (type: list(GoogleApi.YouTube.V3.Model.LiveChatPollDetailsPollMetadataPollOption.t), default: nil) - The options will be returned in the order that is displayed in 1P
• questionText (type: String.t, default: nil) -

Attributes

• optionText (type: String.t, default: nil) -
• tally (type: String.t, default: nil) -

Attributes

• amountDisplayString (type: String.t, default: nil) - A rendered string that displays the fund amount and currency to the user.
• amountMicros (type: String.t, default: nil) - The amount purchased by the user, in micros (1,750,000 micros = 1.75).
• currency (type: String.t, default: nil) - The currency in which the purchase was made.
• tier (type: integer(), default: nil) - The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
• userComment (type: String.t, default: nil) - The comment added by the user to this Super Chat event.

Attributes

• amountDisplayString (type: String.t, default: nil) - A rendered string that displays the fund amount and currency to the user.
• amountMicros (type: String.t, default: nil) - The amount purchased by the user, in micros (1,750,000 micros = 1.75).
• currency (type: String.t, default: nil) - The currency in which the purchase was made.
• superStickerMetadata (type: GoogleApi.YouTube.V3.Model.SuperStickerMetadata.t, default: nil) - Information about the Super Sticker.
• tier (type: integer(), default: nil) - The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.

Attributes

• messageText (type: String.t, default: nil) - The user's message.

Attributes

• banDurationSeconds (type: String.t, default: nil) - The duration of the ban. This property is only present if the banType is temporary.
• banType (type: String.t, default: nil) - The type of ban.
• bannedUserDetails (type: GoogleApi.YouTube.V3.Model.ChannelProfileDetails.t, default: nil) - The details of the user that was banned.

A live stream describes a live ingestion point.

Attributes

• description (type: String.t, default: nil) - The long-form description of the issue and how to resolve it.
• reason (type: String.t, default: nil) - The short-form reason for this issue.
• severity (type: String.t, default: nil) - How severe this issue is to the stream.
• type (type: String.t, default: nil) - The kind of error happening.

Detailed settings of a stream.

Attributes

• configurationIssues (type: list(GoogleApi.YouTube.V3.Model.LiveStreamConfigurationIssue.t), default: nil) - The configurations issues on this stream
• lastUpdateTimeSeconds (type: String.t, default: nil) - The last time this status was updated (in seconds)
• status (type: String.t, default: nil) - The status code of this stream

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.LiveStream.t), default: nil) - A list of live streams that match the request criteria.
• kind (type: String.t, default: youtube#liveStreamListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) -
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Attributes

• channelId (type: String.t, default: nil) - The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
• description (type: String.t, default: nil) - The stream's description. The value cannot be longer than 10000 characters.
• isDefaultStream (type: boolean(), default: nil) -
• publishedAt (type: DateTime.t, default: nil) - The date and time that the stream was created.
• title (type: String.t, default: nil) - The stream's title. The value must be between 1 and 128 characters long.

Brief description of the live stream status.

Attributes

• default (type: String.t, default: nil) -
• defaultLanguage (type: GoogleApi.YouTube.V3.Model.LanguageTag.t, default: nil) - The language of the default property.
• localized (type: list(GoogleApi.YouTube.V3.Model.LocalizedString.t), default: nil) -

Attributes

• language (type: String.t, default: nil) -
• value (type: String.t, default: nil) -

A member resource represents a member for a YouTube channel. A member provides recurring monetary support to a creator and receives special benefits.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Member.t), default: nil) - A list of members that match the request criteria.
• kind (type: String.t, default: youtube#memberListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#memberListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) -
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Attributes

• creatorChannelId (type: String.t, default: nil) - The id of the channel that's offering memberships.
• memberDetails (type: GoogleApi.YouTube.V3.Model.ChannelProfileDetails.t, default: nil) - Details about the member.
• membershipsDetails (type: GoogleApi.YouTube.V3.Model.MembershipsDetails.t, default: nil) - Details about the user's membership.

Attributes

• accessibleLevels (type: list(String.t), default: nil) - Ids of all levels that the user has access to. This includes the currently active level and all other levels that are included because of a higher purchase.
• highestAccessibleLevel (type: String.t, default: nil) - Id of the highest level that the user has access to at the moment.
• highestAccessibleLevelDisplayName (type: String.t, default: nil) - Display name for the highest level that the user has access to at the moment.
• membershipsDuration (type: GoogleApi.YouTube.V3.Model.MembershipsDuration.t, default: nil) - Data about memberships duration without taking into consideration pricing levels.
• membershipsDurationAtLevels (type: list(GoogleApi.YouTube.V3.Model.MembershipsDurationAtLevel.t), default: nil) - Data about memberships duration on particular pricing levels.

Attributes

• memberSince (type: String.t, default: nil) - The date and time when the user became a continuous member across all levels.
• memberTotalDurationMonths (type: integer(), default: nil) - The cumulative time the user has been a member across all levels in complete months (the time is rounded down to the nearest integer).

Attributes

• level (type: String.t, default: nil) - Pricing level ID.
• memberSince (type: String.t, default: nil) - The date and time when the user became a continuous member for the given level.
• memberTotalDurationMonths (type: integer(), default: nil) - The cumulative time the user has been a member for the given level in complete months (the time is rounded down to the nearest integer).

A membershipsLevel resource represents an offer made by YouTube creators for their fans. Users can become members of the channel by joining one of the available levels. They will provide recurring monetary support and receives special benefits.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.MembershipsLevel.t), default: nil) - A list of pricing levels offered by a creator to the fans.
• kind (type: String.t, default: youtube#membershipsLevelListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#membershipsLevelListResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Attributes

• creatorChannelId (type: String.t, default: nil) - The id of the channel that's offering channel memberships.
• levelDetails (type: GoogleApi.YouTube.V3.Model.LevelDetails.t, default: nil) - Details about the pricing level.

Settings and Info of the monitor stream

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

A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private. YouTube also uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.

Attributes

• itemCount (type: integer(), default: nil) - The number of videos in the playlist.

Attributes

• id (type: String.t, default: nil) - Identifies this resource (playlist id and image type).
• kind (type: String.t, default: youtube#playlistImage) - Identifies what kind of resource this is. Value: the fixed string "youtube#playlistImages".
• snippet (type: GoogleApi.YouTube.V3.Model.PlaylistImageSnippet.t, default: nil) -

Attributes

• items (type: list(GoogleApi.YouTube.V3.Model.PlaylistImage.t), default: nil) -
• kind (type: String.t, default: youtube#playlistImageListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#playlistImageListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

A playlistImage resource identifies another resource, such as a image, that is associated with a playlist. In addition, the playlistImage resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistImages.list method to retrieve image data for any of those playlists. You can also add or remove images from those lists by calling the playlistImages.insert and playlistImages.delete methods.

A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.

Attributes

• endAt (type: String.t, default: nil) - The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.
• note (type: String.t, default: nil) - A user-generated note for this item.
• startAt (type: String.t, default: nil) - The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.
• videoId (type: String.t, default: nil) - The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.
• videoPublishedAt (type: DateTime.t, default: nil) - The date and time that the video was published to YouTube.

Attributes

• etag (type: String.t, default: nil) -
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.PlaylistItem.t), default: nil) - A list of playlist items that match the request criteria.
• kind (type: String.t, default: youtube#playlistItemListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItemListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about a playlist, including title, description and thumbnails. Basic details of a YouTube Playlist item provided by the author. Next ID: 15

Information about the playlist item's privacy status.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Playlist.t), default: nil) - A list of playlists that match the request criteria
• kind (type: String.t, default: youtube#playlistListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#playlistListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Playlist localization setting

Attributes

• embedHtml (type: String.t, default: nil) - An <iframe> tag that embeds a player that will play the playlist.

Basic details about a playlist, including title, description and thumbnails.

Attributes

• podcastStatus (type: String.t, default: nil) - The playlist's podcast status.
• privacyStatus (type: String.t, default: nil) - The playlist's privacy status.

A pair Property / Value.

Attributes

• entity (type: GoogleApi.YouTube.V3.Model.Entity.t, default: nil) -

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

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.SearchResult.t), default: nil) - Pagination information for token pagination.
• kind (type: String.t, default: youtube#searchListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• regionCode (type: String.t, default: nil) -
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.

Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.

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.

Details about the content to witch a subscription refers.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Subscription.t), default: nil) - A list of subscriptions that match the request criteria.
• kind (type: String.t, default: youtube#subscriptionListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) -
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

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

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

A __superChatEvent__ resource represents a Super Chat purchase on a YouTube channel.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.SuperChatEvent.t), default: nil) - A list of Super Chat purchases that match the request criteria.
• kind (type: String.t, default: youtube#superChatEventListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEventListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) -
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Attributes

• amountMicros (type: String.t, default: nil) - The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000.
• channelId (type: String.t, default: nil) - Channel id where the event occurred.
• commentText (type: String.t, default: nil) - The text contents of the comment left by the user.
• createdAt (type: DateTime.t, default: nil) - The date and time when the event occurred.
• currency (type: String.t, default: nil) - The currency in which the purchase was made. ISO 4217.
• displayString (type: String.t, default: nil) - A rendered string that displays the purchase amount and currency (e.g., "$1.00"). The string is rendered for the given language.
• isSuperStickerEvent (type: boolean(), default: nil) - True if this event is a Super Sticker event.
• messageType (type: integer(), default: nil) - The tier for the paid message, which is based on the amount of money spent to purchase the message.
• superStickerMetadata (type: GoogleApi.YouTube.V3.Model.SuperStickerMetadata.t, default: nil) - If this event is a Super Sticker event, this field will contain metadata about the Super Sticker.
• supporterDetails (type: GoogleApi.YouTube.V3.Model.ChannelProfileDetails.t, default: nil) - Details about the supporter.

Attributes

• altText (type: String.t, default: nil) - Internationalized alt text that describes the sticker image and any animation associated with it.
• altTextLanguage (type: String.t, default: nil) - Specifies the localization language in which the alt text is returned.
• stickerId (type: String.t, default: nil) - Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker.

Attributes

• etag (type: String.t, default: nil) - Etag for the resource. See https://en.wikipedia.org/wiki/HTTP_ETag.
• featuredPart (type: boolean(), default: nil) -
• gaia (type: String.t, default: nil) -
• id (type: String.t, default: nil) -
• snippet (type: GoogleApi.YouTube.V3.Model.TestItemTestItemSnippet.t, default: nil) -

Attributes

A third party account link resource represents a link between a YouTube account or a channel and an account on a third-party service.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• items (type: list(GoogleApi.YouTube.V3.Model.ThirdPartyLink.t), default: nil) -
• kind (type: String.t, default: youtube#thirdPartyLinkListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLinkListResponse".

Basic information about a third party account link, including its type and type-specific information.

The third-party link status object contains information about the status of the link.

A thumbnail is an image representing a YouTube resource.

Internal representation of thumbnails for a YouTube resource.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.ThumbnailDetails.t), default: nil) - A list of thumbnails.
• kind (type: String.t, default: youtube#thumbnailSetResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#thumbnailSetResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Stub token pagination template to suppress results.

A video resource represents a YouTube video.

Attributes

• comments (type: String.t, default: nil) - Additional comments regarding the abuse report.
• language (type: String.t, default: nil) - The language that the content was viewed in.
• reasonId (type: String.t, default: nil) - The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID.
• secondaryReasonId (type: String.t, default: nil) - The specific, or secondary, reason that this content is abusive (if available). The value is an abuse report reason ID that is a valid secondary reason for the primary reason.
• videoId (type: String.t, default: nil) - The ID that YouTube uses to uniquely identify the video.

A __videoAbuseReportReason__ resource identifies a reason that a video could be reported as abusive. Video abuse report reasons are used with video.ReportAbuse.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.VideoAbuseReportReason.t), default: nil) - A list of valid abuse reasons that are used with video.ReportAbuse.
• kind (type: String.t, default: youtube#videoAbuseReportReasonListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReasonListResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about a video category, such as its localized title.

Attributes

• id (type: String.t, default: nil) - The ID of this abuse report secondary reason.
• label (type: String.t, default: nil) - The localized label for this abuse report secondary reason.

Attributes

• alcoholContent (type: boolean(), default: nil) - Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.
• restricted (type: boolean(), default: nil) - Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.
• videoGameRating (type: String.t, default: nil) - Video game rating, if any.

A videoCategory resource identifies a category that has been or could be associated with uploaded videos.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.VideoCategory.t), default: nil) - A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding videoCategory resource.
• kind (type: String.t, default: youtube#videoCategoryListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategoryListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Basic details about a video category, such as its localized title.

Details about the content of a YouTube Video.

DEPRECATED Region restriction of the video.

Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information.

Information about an audio stream.

Information about a video stream.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.VideoRating.t), default: nil) - A list of ratings that match the request criteria.
• kind (type: String.t, default: youtube#videoGetRatingResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse".
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Attributes

• etag (type: String.t, default: nil) - Etag of this resource.
• eventId (type: String.t, default: nil) - Serialized EventId of the request which produced this response.
• items (type: list(GoogleApi.YouTube.V3.Model.Video.t), default: nil) -
• kind (type: String.t, default: youtube#videoListResponse) - Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse".
• nextPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
• pageInfo (type: GoogleApi.YouTube.V3.Model.PageInfo.t, default: nil) - General pagination information.
• prevPageToken (type: String.t, default: nil) - The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
• tokenPagination (type: GoogleApi.YouTube.V3.Model.TokenPagination.t, default: nil) -
• visitorId (type: String.t, default: nil) - The visitorId identifies the visitor.

Details about the live streaming metadata.

Localized versions of certain video properties (e.g. title).

Details about monetization of a YouTube Video.

Details about paid content, such as paid product placement, sponsorships or endorsement, contained in a YouTube video and a method to inform viewers of paid promotion. This data can only be retrieved by the video owner.

Player to be used for a video playback.

Describes processing status and progress and availability of some other Video resource parts.

Video processing progress and completion time estimate.

DEPRECATED. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [1] https://developers.google.com/resources/api-libraries/documentation/youtube/v3/csharp/latest/classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569&rcl=344141677

Basic details about rating of a video.

Recording information associated with the video.

Basic details about a video, including title, description, uploader, thumbnails and category.

Statistics about the video, such as the number of times the video was viewed or liked.

Basic details about a video category, such as its localized title. Next Id: 19

Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions.

A single tag suggestion with its relevance information.

Freebase topic information related to the video.

Specifies who is allowed to train on the video.

Branding properties for the watch. All deprecated.