YouTube
The YouTube integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to connect YouTube channels to Home Assistant.
For every channel you add, it will create sensors for:
- Views count
- Subscriber count
- Video count
- The latest upload (videos and Shorts)
- The latest uploaded Short
- The latest uploaded video (excludes Shorts)
Prerequisites
To be able to configure the integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], you need to have a YouTube channel. To learn how to create one, refer to the YouTube documentation.
You need to configure developer credentials to allow Home Assistant to access your Google Account. These credentials are the same as the ones for Nest, Google Mail and Google Sheets. These are not the same as the one for Google Calendar.
Scenario 1: You already have credentials
In this case, all you need to do is enable the API:
- Go to the Google Cloud console YouTube Data API v3 .
- Confirm that the correct project is selected, then select Enable.
- Continue with the steps described in the Configuration section.
Scenario 2: You do not have credentials set up yet
In this case, you need to generate a client secret first:
To generate client ID and client secret
This section explains how to generate a client ID and client secret in the Google Cloud console.
- Go to the Google Cloud console.
- Select Create or select a project, then New project, enter a project name, and select Create.
- When the project opens, make sure it is selected in the console toolbar at the top. If it isn’t, select it.
- Go to YouTube Data API v3 , then select Enable.
- Go to the Branding page in the Google Auth Platform Console.
- If Google Auth Platform is not configured, select Get started:
- Under App Information, enter an app name (for example, Home Assistant) and select your email address for User support email. Then select Next.
- Under Audience, select External, then select Next.
- Under Contact Information, enter your email address, then select Next.
- Review the Google API Services User Data Policy. If you agree, select the check box, then select Continue and Create.
- In the left sidebar, select Branding:
- Under App domain, enter
https://home-assistant.iofor Application home page, Application privacy policy link, and Application terms of service link. - Under Authorized domains, add
home-assistant.io.
- Under App domain, enter
- In the left sidebar, select Audience:
- Under Publishing status, select Publish app.
Otherwise, your credentials will expire every 7 days.
- If you leave the app in Testing, under Test users, select Add users, add your Google Account email address, then select Save.
- Under Publishing status, select Publish app.
- In the left sidebar, select Clients:
- Select Create client.
- For Application type, choose Web application and give the client a name (for example,
Home Assistant Client). - Under Authorized redirect URIs, add
https://my.home-assistant.io/redirect/oauth, then select Create.Note: This is not a placeholder. It is the URI that must be used.
- From the resulting dialog, take a note of the Client ID and Client Secret. You cannot retrieve it again after closing the dialog.
- Once you have noted these strings, select Ok to close.
- Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases, your new credentials will be active within a few minutes. However, Google states that activation may take up to five hours in some circumstances.
Configuration
To add the YouTube service to your Home Assistant instance, use this My button:
Manual configuration steps
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select YouTube.
-
Follow the instructions on screen to complete the setup.
The integration setup will next give you instructions to enter the Application Credentials (OAuth Client ID and Client Secret) and authorize Home Assistant to connect to YouTube.
OAuth and device authorization steps
-
Continue through the steps of selecting the account you want to authorize.
-
NOTE: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed.
-
You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Select Continue.
-
The page will now display Link account to Home Assistant?, note Your instance URL. If this is not correct, refer to My Home Assistant. If everything looks good, select Link Account.
-
You may close the window, and return back to Home Assistant where you should see a Success! message from Home Assistant.
Removing the integration
This integration follows standard integration removal, no extra steps are required.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three dots
menu. Then, select Delete.