n8n/packages/nodes-base/nodes/Google/YouTube/YouTube.node.ts

822 lines
22 KiB
TypeScript
Raw Normal View History

2020-07-01 19:54:51 -07:00
import {
2020-08-09 14:39:28 -07:00
IExecuteFunctions,
BINARY_ENCODING,
2020-07-01 19:54:51 -07:00
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeTypeDescription,
INodeType,
ILoadOptionsFunctions,
INodePropertyOptions,
} from 'n8n-workflow';
import {
googleApiRequest,
googleApiRequestAllItems,
} from './GenericFunctions';
import {
channelOperations,
channelFields,
} from './ChannelDescription';
2020-08-09 14:39:28 -07:00
import {
playlistOperations,
playlistFields,
} from './PlaylistDescription';
import {
videoOperations,
videoFields,
} from './VideoDescription';
import {
countriesCodes,
} from './CountryCodes';
2020-07-01 19:54:51 -07:00
export class YouTube implements INodeType {
description: INodeTypeDescription = {
displayName: 'Youtube',
name: 'youTube',
icon: 'file:youTube.png',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume YouTube API.',
defaults: {
name: 'YouTube',
color: '#FF0000',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'youTubeOAuth2Api',
required: true,
}
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Channel',
value: 'channel',
},
2020-08-09 14:39:28 -07:00
{
name: 'Playlist',
value: 'playlist',
},
{
name: 'Video',
value: 'video',
},
2020-07-01 19:54:51 -07:00
],
default: 'channel',
description: 'The resource to operate on.'
},
...channelOperations,
...channelFields,
2020-08-09 14:39:28 -07:00
...playlistOperations,
...playlistFields,
...videoOperations,
...videoFields,
2020-07-01 19:54:51 -07:00
],
};
methods = {
loadOptions: {
// Get all the languages to display them to user so that he can
// select them easily
async getLanguages(
this: ILoadOptionsFunctions
): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const languages = await googleApiRequestAllItems.call(
this,
'items',
'GET',
'/youtube/v3/i18nLanguages',
);
for (const language of languages) {
const languageName = language.id.toUpperCase();
const languageId = language.id;
returnData.push({
name: languageName,
value: languageId
});
}
return returnData;
},
2020-08-09 14:39:28 -07:00
// Get all the countries codes to display them to user so that he can
// select them easily
async getCountriesCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
for (const countryCode of countriesCodes) {
const countryCodeName = `${countryCode.name} - ${countryCode.alpha2}`;
const countryCodeId = countryCode.alpha2;
returnData.push({
name: countryCodeName,
value: countryCodeId,
});
}
return returnData;
},
// Get all the video categories to display them to user so that he can
// select them easily
async getVideoCategories(
this: ILoadOptionsFunctions
): Promise<INodePropertyOptions[]> {
const countryCode = this.getCurrentNodeParameter('countryCode') as string;
const returnData: INodePropertyOptions[] = [];
const qs: IDataObject = {};
qs.regionCode = countryCode;
qs.part = 'snippet';
const categories = await googleApiRequestAllItems.call(
this,
'items',
'GET',
'/youtube/v3/videoCategories',
{},
qs,
);
for (const category of categories) {
const categoryName = category.snippet.title;
const categoryId = category.id;
returnData.push({
name: categoryName,
value: categoryId
});
}
return returnData;
},
2020-07-01 19:54:51 -07:00
}
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = (items.length as unknown) as number;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < length; i++) {
if (resource === 'channel') {
//https://developers.google.com/youtube/v3/docs/channels/list
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const part = this.getNodeParameter('part', i) as string[];
const options = this.getNodeParameter('options', i) as IDataObject;
2020-08-09 14:39:28 -07:00
const filters = this.getNodeParameter('filters', i) as IDataObject;
2020-07-01 19:54:51 -07:00
qs.part = part.join(',');
2020-08-09 14:39:28 -07:00
if (filters.categoryId) {
qs.categoryId = filters.categoryId as string;
2020-07-01 19:54:51 -07:00
}
2020-08-09 14:39:28 -07:00
if (filters.forUsername) {
qs.forUsername = filters.forUsername as string;
2020-07-01 19:54:51 -07:00
}
2020-08-09 14:39:28 -07:00
if (filters.id) {
qs.id = filters.id as string;
2020-07-01 19:54:51 -07:00
}
2020-08-09 14:39:28 -07:00
if (filters.managedByMe) {
qs.managedByMe = filters.managedByMe as boolean;
2020-07-01 19:54:51 -07:00
}
2020-08-09 14:39:28 -07:00
if (filters.mine) {
qs.mine = filters.mine as boolean;
2020-07-01 19:54:51 -07:00
}
if (options.h1) {
qs.h1 = options.h1 as string;
}
if (options.onBehalfOfContentOwner) {
qs.onBehalfOfContentOwner = options.onBehalfOfContentOwner as string;
}
if (returnAll) {
responseData = await googleApiRequestAllItems.call(
this,
'items',
'GET',
`/youtube/v3/channels`,
{},
qs
);
} else {
qs.maxResults = this.getNodeParameter('limit', i) as number;
responseData = await googleApiRequest.call(
this,
'GET',
`/youtube/v3/channels`,
{},
qs
);
responseData = responseData.items;
}
}
//https://developers.google.com/youtube/v3/docs/channels/update
if (operation === 'update') {
const channelId = this.getNodeParameter('channelId', i) as string;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
const body: IDataObject = {
id: channelId,
brandingSettings: {
channel: {},
image: {},
},
};
qs.part = 'brandingSettings';
if (updateFields.onBehalfOfContentOwner) {
qs.onBehalfOfContentOwner = updateFields.onBehalfOfContentOwner as string;
}
if (updateFields.brandingSettingsUi) {
const channelSettingsValues = (updateFields.brandingSettingsUi as IDataObject).channelSettingsValues as IDataObject | undefined;
const channelSettings: IDataObject = {};
if (channelSettingsValues?.channel) {
const channelSettingsOptions = channelSettingsValues.channel as IDataObject;
if (channelSettingsOptions.country) {
channelSettings.country = channelSettingsOptions.country;
}
if (channelSettingsOptions.description) {
channelSettings.description = channelSettingsOptions.description;
}
if (channelSettingsOptions.defaultLanguage) {
channelSettings.defaultLanguage = channelSettingsOptions.defaultLanguage;
}
if (channelSettingsOptions.defaultTab) {
channelSettings.defaultTab = channelSettingsOptions.defaultTab;
}
if (channelSettingsOptions.featuredChannelsTitle) {
channelSettings.featuredChannelsTitle = channelSettingsOptions.featuredChannelsTitle;
}
if (channelSettingsOptions.featuredChannelsUrls) {
channelSettings.featuredChannelsUrls = channelSettingsOptions.featuredChannelsUrls;
}
if (channelSettingsOptions.keywords) {
channelSettings.keywords = channelSettingsOptions.keywords;
}
if (channelSettingsOptions.moderateComments) {
channelSettings.moderateComments = channelSettingsOptions.moderateComments as boolean;
}
if (channelSettingsOptions.profileColor) {
channelSettings.profileColor = channelSettingsOptions.profileColor as string;
}
if (channelSettingsOptions.profileColor) {
channelSettings.profileColor = channelSettingsOptions.profileColor as string;
}
if (channelSettingsOptions.showRelatedChannels) {
channelSettings.showRelatedChannels = channelSettingsOptions.showRelatedChannels as boolean;
}
if (channelSettingsOptions.showBrowseView) {
channelSettings.showBrowseView = channelSettingsOptions.showBrowseView as boolean;
}
if (channelSettingsOptions.trackingAnalyticsAccountId) {
channelSettings.trackingAnalyticsAccountId = channelSettingsOptions.trackingAnalyticsAccountId as string;
}
if (channelSettingsOptions.unsubscribedTrailer) {
channelSettings.unsubscribedTrailer = channelSettingsOptions.unsubscribedTrailer as string;
}
}
const imageSettingsValues = (updateFields.brandingSettingsUi as IDataObject).imageSettingsValues as IDataObject | undefined;
const imageSettings: IDataObject = {};
if (imageSettingsValues?.image) {
const imageSettingsOptions = imageSettings.image as IDataObject;
if (imageSettingsOptions.bannerExternalUrl) {
imageSettings.bannerExternalUrl = imageSettingsOptions.bannerExternalUrl as string
}
if (imageSettingsOptions.trackingImageUrl) {
imageSettings.trackingImageUrl = imageSettingsOptions.trackingImageUrl as string
}
if (imageSettingsOptions.watchIconImageUrl) {
imageSettings.watchIconImageUrl = imageSettingsOptions.watchIconImageUrl as string
}
}
//@ts-ignore
body.brandingSettings.channel = channelSettings;
//@ts-ignore
body.brandingSettings.image = imageSettings;
}
responseData = await googleApiRequest.call(
this,
'PUT',
'/youtube/v3/channels',
body,
qs
);
}
//https://developers.google.com/youtube/v3/docs/channelBanners/insert
if (operation === 'uploadBanner') {
const channelId = this.getNodeParameter('channelId', i) as string;
const binaryProperty = this.getNodeParameter('binaryProperty', i) as string;
let mimeType;
// Is binary file to upload
const item = items[i];
if (item.binary === undefined) {
throw new Error('No binary data exists on item!');
}
if (item.binary[binaryProperty] === undefined) {
throw new Error(`No binary data property "${binaryProperty}" does not exists on item!`);
}
if (item.binary[binaryProperty].mimeType) {
mimeType = item.binary[binaryProperty].mimeType;
}
const body = Buffer.from(item.binary[binaryProperty].data, BINARY_ENCODING);
const requestOptions = {
headers: {
'Content-Type': mimeType,
},
json: false,
};
let response = await googleApiRequest.call(this, 'POST', '/upload/youtube/v3/channelBanners/insert', body, qs, undefined, requestOptions);
const { url } = JSON.parse(response);
qs.part = 'brandingSettings'
responseData = await googleApiRequest.call(
this,
'PUT',
`/youtube/v3/channels`,
{
id: channelId,
brandingSettings: {
image: {
bannerExternalUrl: url,
},
},
},
qs,
);
}
}
2020-08-09 14:39:28 -07:00
if (resource === 'playlist') {
//https://developers.google.com/youtube/v3/docs/playlists/list
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const part = this.getNodeParameter('part', i) as string[];
const options = this.getNodeParameter('options', i) as IDataObject;
const filters = this.getNodeParameter('filters', i) as IDataObject;
qs.part = part.join(',');
Object.assign(qs, options, filters);
if (returnAll) {
responseData = await googleApiRequestAllItems.call(
this,
'items',
'GET',
`/youtube/v3/playlists`,
{},
qs
);
} else {
qs.maxResults = this.getNodeParameter('limit', i) as number;
responseData = await googleApiRequest.call(
this,
'GET',
`/youtube/v3/playlists`,
{},
qs
);
responseData = responseData.items;
}
}
//https://developers.google.com/youtube/v3/docs/playlists/insert
if (operation === 'create') {
const title = this.getNodeParameter('title', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
qs.part = 'snippet';
const body: IDataObject = {
snippet: {
title,
},
};
if (options.tags) {
//@ts-ignore
body.snippet.tags = (options.tags as string).split(',') as string[];
}
if (options.description) {
//@ts-ignore
body.snippet.privacyStatus = options.privacyStatus as string;
}
if (options.defaultLanguage) {
//@ts-ignore
body.snippet.defaultLanguage = options.defaultLanguage as string;
}
if (options.onBehalfOfContentOwner) {
qs.onBehalfOfContentOwner = options.onBehalfOfContentOwner as string;
}
if (options.onBehalfOfContentOwnerChannel) {
qs.onBehalfOfContentOwnerChannel = options.onBehalfOfContentOwnerChannel as string;
}
responseData = await googleApiRequest.call(
this,
'POST',
'/youtube/v3/playlists',
body,
qs
);
}
//https://developers.google.com/youtube/v3/docs/playlists/update
if (operation === 'update') {
const playlistId = this.getNodeParameter('playlistId', i) as string;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
qs.part = 'snippet';
const body: IDataObject = {
id: playlistId,
snippet: {
}
};
if (updateFields.tags) {
//@ts-ignore
body.snippet.tags = (updateFields.tags as string).split(',') as string[];
}
if (updateFields.title) {
//@ts-ignore
body.snippet.title = updateFields.title as string
}
if (updateFields.description) {
//@ts-ignore
body.snippet.description = updateFields.description as string;
}
if (updateFields.defaultLanguage) {
//@ts-ignore
body.snippet.defaultLanguage = updateFields.defaultLanguage as string;
}
if (updateFields.onBehalfOfContentOwner) {
qs.onBehalfOfContentOwner = updateFields.onBehalfOfContentOwner as string;
}
responseData = await googleApiRequest.call(
this,
'PUT',
'/youtube/v3/playlists',
body,
qs
);
}
//https://developers.google.com/youtube/v3/docs/playlists/delete
if (operation === 'delete') {
const playlistId = this.getNodeParameter('playlistId', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
const body: IDataObject = {
id: playlistId,
};
if (options.onBehalfOfContentOwner) {
qs.onBehalfOfContentOwner = options.onBehalfOfContentOwner as string;
}
responseData = await googleApiRequest.call(
this,
'DELETE',
'/youtube/v3/playlists',
body,
);
responseData = { success: true };
}
}
if (resource === 'video') {
//https://developers.google.com/youtube/v3/docs/videos/list?hl=en
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const part = this.getNodeParameter('part', i) as string[];
const options = this.getNodeParameter('options', i) as IDataObject;
const filters = this.getNodeParameter('filters', i) as IDataObject;
qs.part = part.join(',');
qs.chart = 'mostPopular';
Object.assign(qs, options, filters);
if (returnAll) {
responseData = await googleApiRequestAllItems.call(
this,
'items',
'GET',
`/youtube/v3/videos`,
{},
qs
);
} else {
qs.maxResults = this.getNodeParameter('limit', i) as number;
responseData = await googleApiRequest.call(
this,
'GET',
`/youtube/v3/videos`,
{},
qs
);
responseData = responseData.items;
}
}
//https://developers.google.com/youtube/v3/docs/videos/list?hl=en
if (operation === 'get') {
const part = this.getNodeParameter('part', i) as string[];
const videoId = this.getNodeParameter('videoId', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
qs.part = part.join(',');
qs.id = videoId;
Object.assign(qs, options);
responseData = await googleApiRequest.call(
this,
'GET',
`/youtube/v3/videos`,
{},
qs
);
responseData = responseData.items;
}
//https://developers.google.com/youtube/v3/guides/uploading_a_video?hl=en
if (operation === 'upload') {
const title = this.getNodeParameter('title', i) as string;
const categoryId = this.getNodeParameter('categoryId', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
const binaryProperty = this.getNodeParameter('binaryProperty', i) as string;
let mimeType;
// Is binary file to upload
const item = items[i];
if (item.binary === undefined) {
throw new Error('No binary data exists on item!');
}
if (item.binary[binaryProperty] === undefined) {
throw new Error(`No binary data property "${binaryProperty}" does not exists on item!`);
}
if (item.binary[binaryProperty].mimeType) {
mimeType = item.binary[binaryProperty].mimeType;
}
const body = Buffer.from(item.binary[binaryProperty].data, BINARY_ENCODING);
const requestOptions = {
headers: {
'Content-Type': mimeType,
},
json: false,
};
let response = await googleApiRequest.call(this, 'POST', '/upload/youtube/v3/videos', body, qs, undefined, requestOptions);
const { id } = JSON.parse(response);
qs.part = 'snippet, status, recordingDetails';
const data = {
id,
snippet: {
title,
categoryId,
},
status: {
},
recordingDetails: {
},
}
if (options.description) {
//@ts-ignore
data.snippet.description = options.description as string;
}
if (options.privacyStatus) {
//@ts-ignore
data.status.privacyStatus = options.privacyStatus as string;
}
if (options.tags) {
//@ts-ignore
data.snippet.tags = (options.tags as string).split(',') as string[];
}
if (options.embeddable) {
//@ts-ignore
data.status.embeddable = options.embeddable as boolean;
}
if (options.publicStatsViewable) {
//@ts-ignore
data.status.publicStatsViewable = options.publicStatsViewable as boolean;
}
if (options.publishAt) {
//@ts-ignore
data.status.publishAt = options.publishAt as string;
}
if (options.recordingDate) {
//@ts-ignore
data.recordingDetails.recordingDate = options.recordingDate as string;
}
if (options.selfDeclaredMadeForKids) {
//@ts-ignore
data.status.selfDeclaredMadeForKids = options.selfDeclaredMadeForKids as boolean;
}
if (options.license) {
//@ts-ignore
data.status.license = options.license as string;
}
if (options.defaultLanguage) {
//@ts-ignore
data.snippet.defaultLanguage = options.defaultLanguage as string;
}
if (options.notifySubscribers) {
qs.notifySubscribers = options.notifySubscribers;
delete options.notifySubscribers;
}
responseData = await googleApiRequest.call(
this,
'PUT',
`/youtube/v3/videos`,
data,
qs,
);
}
//https://developers.google.com/youtube/v3/docs/playlists/update
if (operation === 'update') {
const id = this.getNodeParameter('videoId', i) as string;
//const categoryId = this.getNodeParameter('categoryId', i) as string;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
qs.part = 'snippet, status, recordingDetails';
const body = {
id,
snippet: {
//categoryId,
},
status: {
},
recordingDetails: {
},
}
if (updateFields.description) {
//@ts-ignore
data.snippet.description = updateFields.description as string;
}
if (updateFields.privacyStatus) {
//@ts-ignore
data.status.privacyStatus = updateFields.privacyStatus as string;
}
if (updateFields.tags) {
//@ts-ignore
data.snippet.tags = (updateFields.tags as string).split(',') as string[];
}
if (updateFields.description) {
//@ts-ignore
data.snippet.title = updateFields.title as string;
}
if (updateFields.embeddable) {
//@ts-ignore
data.status.embeddable = updateFields.embeddable as boolean;
}
if (updateFields.publicStatsViewable) {
//@ts-ignore
data.status.publicStatsViewable = updateFields.publicStatsViewable as boolean;
}
if (updateFields.publishAt) {
//@ts-ignore
data.status.publishAt = updateFields.publishAt as string;
}
if (updateFields.recordingDate) {
//@ts-ignore
data.recordingDetails.recordingDate = updateFields.recordingDate as string;
}
if (updateFields.selfDeclaredMadeForKids) {
//@ts-ignore
data.status.selfDeclaredMadeForKids = updateFields.selfDeclaredMadeForKids as boolean;
}
if (updateFields.license) {
//@ts-ignore
data.status.license = options.license as string;
}
if (updateFields.defaultLanguage) {
//@ts-ignore
data.snippet.defaultLanguage = updateFields.defaultLanguage as string;
}
responseData = await googleApiRequest.call(
this,
'PUT',
'/youtube/v3/videos',
body,
qs
);
}
//https://developers.google.com/youtube/v3/docs/videos/delete?hl=en
if (operation === 'delete') {
const videoId = this.getNodeParameter('videoId', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
const body: IDataObject = {
id: videoId,
};
if (options.onBehalfOfContentOwner) {
qs.onBehalfOfContentOwner = options.onBehalfOfContentOwner as string;
}
responseData = await googleApiRequest.call(
this,
'DELETE',
'/youtube/v3/video',
body,
);
responseData = { success: true };
}
//https://developers.google.com/youtube/v3/docs/videos/rate?hl=en
if (operation === 'rate') {
const videoId = this.getNodeParameter('videoId', i) as string;
const rating = this.getNodeParameter('rating', i) as string;
const body: IDataObject = {
id: videoId,
rating,
};
responseData = await googleApiRequest.call(
this,
'POST',
'/youtube/v3/videos/rate',
body,
);
responseData = { success: true };
}
}
2020-07-01 19:54:51 -07:00
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else if (responseData !== undefined) {
returnData.push(responseData as IDataObject);
}
return [this.helpers.returnJsonArray(returnData)];
}
}