YouTube
Get notifications about uploaded YouTube videos, and search for any YouTube data!
This module is only available to users with a Premium Subscription.
BotGhost provides a YouTube module for its users. This module will allow bot users to search for YouTube videos and channels, and see notifications of new uploads.
Credentials Setup
In this area, you can set up the module with your API key.
The YouTube module requires you to create an application on the Google Cloud Console, to communicate with the YouTube API. Follow the steps below to retrieve your API key, and paste it into the settings of the module:
Open the Google Cloud Console project creation page. If prompted, sign into or create a Google account, or click the name of the account you wish to use.
Enter a name for your project, then click on 'Create'.
Click on the search tab at the top of your screen and search for the YouTube Data API V3. Then click on the API listed under 'Marketplace'.
Click on the blue 'Enable' button.
In the top-right corner, click 'Create Credentials'.
Select 'Public Data' and then click on the 'Next' button.
Click the copy button on the right of the API key.
Do not share this API key with anyone. It is linked to your Google Account, and you are responsible for its use. If you or others misuse this key, it could lead to account restrictions. You can learn more about this at https://console.cloud.google.com/terms.
Head back to the module on your bot's dashboard, and paste your API key. Press 'Save Changes'.
Settings
Credentials Setup
Here you may setup the API keys required for your module to work.
YouTube API Key
Paste your YouTube API Key here. Learn how to get a YouTube API key in the Credentials Setup section of this page.
Upload Notifications
In this area, you can set up (a) new upload tracker(s) to receive notifications for newly uploaded videos from Youtube channels.
Announcement Channel
From this dropdown, you may choose which channel new uploads will be announced in.
YouTube Channel Handle
In this field, input the handle of the YouTube channel you are tracking uploads for. The handle can be found by opening the channel in a browser and checking the URL.
Search Filter
From this dropdown you can choose the type of notification you would like to receive.
| Filter Type | Details |
|---|---|
All Uploads | If selected, you will receive notifications for all uploaded videos from the channel. |
Uploads Matching Query | If this option is selected then only notifications for videos that match the query input will be posted. |
Search Query
In this field you can input a term in which the bot will only search and post notifications based off that query. This setting is only visible with Search Filter set to "Uploads Matching Query.
Notification Roles
From this selection you can choose server roles that will be pinged once a notification is posted.
YouTube Upload Notification
In this section you can customize the message for the notifications that will be posted. Module variables can be used to customize this.
Automatically Crosspost Message
If this toggle is enabled then notifications posted in an announcement channel chosen from Announcement Channel will automatically get published to all servers / channels that follow the channel.
To save the upload tracker's settings, you need to click "Add" in the bottom-right corner of the settings.
Tracked Uploads
In this area, you can view, edit, and delete the settings for the upload tracker(s) you added above.
When adding a new upload tracker, it and its settings will appear in this section. All upload trackers will be ordered by the number in which they were created.
To view, edit, and delete the settings you selected above for that tracker, simply click the dropdown arrow next to the upload tracker you wish to do so for.
To save the edits you made on the upload tracker's settings, you need to click "Edit" in the bottom-right corner of the settings.
Search Filters
In this area, you can customize the filters used in search results of the /youtube-search command and search query trackers.
YouTube Safesearch Type
In this section you can change the filter sensitivity for the command. It can be changed from having no filter, to having a highly sensitive one that won't allow inappropriate content.
Definition Requirement
From this dropdown you can define the quality of the searched content.
Duration Requirement
From this dropdown you can define the duration of the searched content.
Variables
Here is some module variables that can be used to customize Upload Notifications.
| Variable | Details |
|---|---|
| Displays the video title. |
| Displays the video thumbnail |
| Displays the video channel name |
| Displays the video description |
| Links the url for the video. |
Commands
In this area, you can view and modify the commands of the YouTube module. Below you may find some information on each command of the module.
Events
In this area, you can view and modify the events of the YouTube module. Below you may find some information on each event of the module.
It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended.
Additionally, a copy of the edited commands / events will be created if you update the module.
Last updated
