nodes/generated

Interface YouTubeNodeParameters

Source
interface YouTubeNodeParameters {
    binaryProperty?: string;
    categoryId?: string;
    channelId?: string;
    filters?:
        | {
            categoryId?: string;
            forUsername?: string;
            id?: string;
            managedByMe?: boolean;
        }
        | { channelId?: string; id?: string }
        | {
            channelId?: string;
            forDeveloper?: boolean;
            publishedAfter?: string;
            publishedBefore?: string;
            q?: string;
            regionCode?: string;
            relatedToVideoId?: string;
            videoCategoryId?: string;
            videoSyndicated?: boolean;
            videoType?: "any" | "episode" | "movie";
        };
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "delete"
    | "upload"
    | "uploadBanner"
    | "rate";
    options?: | {
        h1?: string;
        onBehalfOfContentOwner?: string;
    }
    | {
        defaultLanguage?: string;
        description?: string;
        onBehalfOfContentOwner?: string;
        onBehalfOfContentOwnerChannel?: string;
        privacyStatus?: "public"
        | "private"
        | "unlisted";
        tags?: string;
    }
    | {
        onBehalfOfContentOwner?: string;
        onBehalfOfContentOwnerChannel?: string;
    }
    | { onBehalfOfContentOwner?: string }
    | {
        onBehalfOfContentOwner?: string;
        onBehalfOfContentOwnerChannel?: string;
    }
    | {
        endAt?: string;
        note?: string;
        onBehalfOfContentOwner?: string;
        position?: number;
        startAt?: string;
    }
    | {
        defaultLanguage?: string;
        description?: string;
        embeddable?: boolean;
        license?: "youtube"
        | "creativeCommon";
        notifySubscribers?: boolean;
        privacyStatus?: "public" | "private" | "unlisted";
        publicStatsViewable?: boolean;
        publishAt?: string;
        recordingDate?: string;
        selfDeclaredMadeForKids?: boolean;
        tags?: string;
    }
    | {
        order?: "relevance"
        | "date";
        safeSearch?: "none" | "moderate" | "strict";
    };
    part?: | (
        | "id"
        | "status"
        | "*"
        | "statistics"
        | "brandingSettings"
        | "contentDetails"
        | "contentOwnerDetails"
        | "localizations"
        | "snippet"
        | "topicDetails"
    )[]
    | (
        | "id"
        | "status"
        | "*"
        | "player"
        | "contentDetails"
        | "localizations"
        | "snippet"
    )[]
    | (
        | "id"
        | "status"
        | "*"
        | "contentDetails"
        | "snippet"
    )[]
    | (
        | "id"
        | "status"
        | "*"
        | "statistics"
        | "player"
        | "contentDetails"
        | "localizations"
        | "snippet"
        | "topicDetails"
        | "liveStreamingDetails"
        | "recordingDetails"
    )[];
    playlistId?: string;
    playlistItemId?: string;
    rating?: "none"
    | "like"
    | "dislike";
    regionCode?: string;
    resource?:
        | "video"
        | "channel"
        | "playlist"
        | "playlistItem"
        | "videoCategory";
    returnAll?: boolean;
    title?: string;
    updateFields?: | {
        brandingSettingsUi?: {
            channelSettingsValues: {
                channel?: {
                    country?: string;
                    defaultLanguage?: string;
                    defaultTab?: string;
                    description?: string;
                    featuredChannelsTitle?: string;
                    featuredChannelsUrls?: string;
                    keywords?: string;
                    moderateComments?: boolean;
                    profileColor?: string;
                    showBrowseView?: boolean;
                    showRelatedChannels?: boolean;
                    trackingAnalyticsAccountId?: string;
                    unsubscribedTrailer?: string;
                };
            };
            imageSettingsValues: {
                image?: {
                    bannerExternalUrl?: string;
                    trackingImageUrl?: string;
                    watchIconImageUrl?: string;
                };
            };
            statusValue: {
                status?: { selfDeclaredMadeForKids?: boolean };
            };
        };
        onBehalfOfContentOwner?: string;
    }
    | {
        defaultLanguage?: string;
        description?: string;
        onBehalfOfContentOwner?: string;
        privacyStatus?: "public"
        | "private"
        | "unlisted";
        tags?: string;
    }
    | {
        defaultLanguage?: string;
        description?: string;
        embeddable?: boolean;
        license?: "youtube"
        | "creativeCommon";
        notifySubscribers?: boolean;
        privacyStatus?: "public" | "private" | "unlistef";
        publicStatsViewable?: boolean;
        publishAt?: string;
        recordingDate?: string;
        selfDeclaredMadeForKids?: boolean;
        tags?: string;
    };
    videoId?: string;
}

Properties§

Source§

readonly binaryProperty?: string

Default: "data"

Source§

readonly categoryId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getVideoCategories","loadOptionsDependsOn":["regionCode"]}

Source§

readonly channelId?: string

ID of the channel

Source§

readonly filters?:
    | {
        categoryId?: string;
        forUsername?: string;
        id?: string;
        managedByMe?: boolean;
    }
    | { channelId?: string; id?: string }
    | {
        channelId?: string;
        forDeveloper?: boolean;
        publishedAfter?: string;
        publishedBefore?: string;
        q?: string;
        regionCode?: string;
        relatedToVideoId?: string;
        videoCategoryId?: string;
        videoSyndicated?: boolean;
        videoType?: "any" | "episode" | "movie";
    }

Default: {}

Source§

readonly limit?: number

Max number of results to return Default: 25 Type options: {"minValue":1,"maxValue":50}

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "delete"
    | "upload"
    | "uploadBanner"
    | "rate"

Default: "getAll"

Source§

readonly options?:
    | { h1?: string; onBehalfOfContentOwner?: string }
    | {
        defaultLanguage?: string;
        description?: string;
        onBehalfOfContentOwner?: string;
        onBehalfOfContentOwnerChannel?: string;
        privacyStatus?: "public" | "private" | "unlisted";
        tags?: string;
    }
    | {
        onBehalfOfContentOwner?: string;
        onBehalfOfContentOwnerChannel?: string;
    }
    | { onBehalfOfContentOwner?: string }
    | {
        onBehalfOfContentOwner?: string;
        onBehalfOfContentOwnerChannel?: string;
    }
    | {
        endAt?: string;
        note?: string;
        onBehalfOfContentOwner?: string;
        position?: number;
        startAt?: string;
    }
    | {
        defaultLanguage?: string;
        description?: string;
        embeddable?: boolean;
        license?: "youtube"
        | "creativeCommon";
        notifySubscribers?: boolean;
        privacyStatus?: "public" | "private" | "unlisted";
        publicStatsViewable?: boolean;
        publishAt?: string;
        recordingDate?: string;
        selfDeclaredMadeForKids?: boolean;
        tags?: string;
    }
    | {
        order?: "relevance"
        | "date";
        safeSearch?: "none" | "moderate" | "strict";
    }

Default: {}

Source§

readonly part?:
    | (
        | "id"
        | "status"
        | "*"
        | "statistics"
        | "brandingSettings"
        | "contentDetails"
        | "contentOwnerDetails"
        | "localizations"
        | "snippet"
        | "topicDetails"
    )[]
    | (
        | "id"
        | "status"
        | "*"
        | "player"
        | "contentDetails"
        | "localizations"
        | "snippet"
    )[]
    | (
        | "id"
        | "status"
        | "*"
        | "contentDetails"
        | "snippet"
    )[]
    | (
        | "id"
        | "status"
        | "*"
        | "statistics"
        | "player"
        | "contentDetails"
        | "localizations"
        | "snippet"
        | "topicDetails"
        | "liveStreamingDetails"
        | "recordingDetails"
    )[]

The fields parameter specifies a comma-separated list of one or more channel resource properties that the API response will include Default: ["*"]

Source§

readonly playlistId?: string

Source§

readonly playlistItemId?: string

Source§

readonly rating?: "none" | "like" | "dislike"

Source§

readonly regionCode?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getCountriesCodes"}

Source§

readonly resource?:
    | "video"
    | "channel"
    | "playlist"
    | "playlistItem"
    | "videoCategory"

Default: "channel"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly title?: string

The playlist's title

Source§

readonly updateFields?:
    | {
        brandingSettingsUi?: {
            channelSettingsValues: {
                channel?: {
                    country?: string;
                    defaultLanguage?: string;
                    defaultTab?: string;
                    description?: string;
                    featuredChannelsTitle?: string;
                    featuredChannelsUrls?: string;
                    keywords?: string;
                    moderateComments?: boolean;
                    profileColor?: string;
                    showBrowseView?: boolean;
                    showRelatedChannels?: boolean;
                    trackingAnalyticsAccountId?: string;
                    unsubscribedTrailer?: string;
                };
            };
            imageSettingsValues: {
                image?: {
                    bannerExternalUrl?: string;
                    trackingImageUrl?: string;
                    watchIconImageUrl?: string;
                };
            };
            statusValue: {
                status?: { selfDeclaredMadeForKids?: boolean };
            };
        };
        onBehalfOfContentOwner?: string;
    }
    | {
        defaultLanguage?: string;
        description?: string;
        onBehalfOfContentOwner?: string;
        privacyStatus?: "public"
        | "private"
        | "unlisted";
        tags?: string;
    }
    | {
        defaultLanguage?: string;
        description?: string;
        embeddable?: boolean;
        license?: "youtube"
        | "creativeCommon";
        notifySubscribers?: boolean;
        privacyStatus?: "public" | "private" | "unlistef";
        publicStatsViewable?: boolean;
        publishAt?: string;
        recordingDate?: string;
        selfDeclaredMadeForKids?: boolean;
        tags?: string;
    }

Default: {}

Source§

readonly videoId?: string