YouTube Connector for Tableau
In this article you will learn how to integrate YouTube data in Tableau
without coding in just a few clicks (live / bi-directional connection to YouTube).
Read / write YouTube data inside your app, perform many Youtube operations without coding using easy to use high performance API Connector for YouTube.
Using YouTube Connector you will be able to connect, read, and write data from within Tableau. Follow the steps below to see how we would accomplish that.
Download
Documentation
The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.
If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.
|
Connect to YouTube in other apps
|
Create Data Source in ZappySys Data Gateway based on API Driver
-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
-
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.
YouTubeDSN
-
When the Configuration window appears give your data source a name if you haven't done that already,
then select "YouTube" from the list of Popular Connectors. If "YouTube" is not present
in the list, then click "Search Online" and download it. Then set the path to the location where you
downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
YouTubeDSN
YouTube
-
Now it's time to configure the Connection Manager. Select Authentication Type,
e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one).
More info is available in the Authentication section.
Steps to get YouTube Credentials
This walkthrough will help you create an API Key which you will be able to use in all requests and authenticate accordingly.
- Go to Google API Console
- From the Project Dropdown (usually found at the top bar) click Select Project
- On Project Popup click CREATE PROJECT
- Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
- Click ENABLE APIs AND SERVICES
- Now we need to Enable three APIs one by one (YouTube Data API, YouTube Analytics API, YouTube Reporting API).
- Search YouTube Data API. Select and click ENABLE
- Search YouTube Analytics API. Select and click ENABLE
- Search YouTube Reporting API. Select and click ENABLE
- Go to back to main screen of Google API Console
- Click OAuth Consent Screen Tab. Enter necessary details and Save.
- Click Credentials Tab
- Click CREATE CREDENTIALS (some where in topbar) and select API key option.
- In the popup, copy API Key from the field "Your API key", close this window, and use it in the UI configuration, "key" field
Fill in all required parameters and set optional parameters if needed:
YouTubeDSN
YouTube
API Key [Http]
https://youtube.googleapis.com/youtube/v3
Steps to get YouTube Credentials
To register a custom app, perform the following steps (detailed steps found in the help link at the end)
- Go to Google API Console
- From the Project Dropdown (usually found at the top bar) click Select Project
- On Project Popup click CREATE PROJECT
- Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
- Click ENABLE APIs AND SERVICES
- Now we need to Enable three APIs one by one (YouTube Data API, YouTube Analytics API, YouTube Reporting API).
- Search YouTube Data API. Select and click ENABLE
- Search YouTube Analytics API. Select and click ENABLE
- Search YouTube Reporting API. Select and click ENABLE
- Go to back to main screen of Google API Console
- Click OAuth Consent Screen Tab. Enter necessary details and Save.
- Click Credentials Tab
- Click CREATE CREDENTIALS (some where in topbar) and select OAuth Client ID option.
- When prompted Select Application Type as Desktop App and click Create to receive your ClientID and Secret. Later on you can use this information now to configure Connection.
- Go to OAuth Consent Screen tab. Under Publishing Status click PUBLISH APP to ensure your refresh token doesnt expire often. If you planning to use App for Private use then do not have to worry about Verification Status after Publish.
Fill in all required parameters and set optional parameters if needed:
YouTubeDSN
YouTube
User Account [OAuth]
https://youtube.googleapis.com/youtube/v3
Steps to get YouTube Credentials
Use these steps to authenticate as service account rather than Google / GSuite User. Learn more about service account
here
Basically to call Google API as Service account we need to perform following steps listed in 3 sections (Detailed steps found in the help link at the end)
Create Project
First thing is create a Project so we can call Google API. Skip this section if you already have Project (Go to next section)
- Go to Google API Console
- From the Project Dropdown (usually found at the top bar) click Select Project
- On Project Popup click CREATE PROJECT
- Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
- Click ENABLE APIs AND SERVICES
- Now we need to Enable three APIs one by one (YouTube Data API, YouTube Analytics API, YouTube Reporting API)
- Search YouTube Data API. Select and click ENABLE
- Search YouTube Analytics API. Select and click ENABLE
- Search YouTube Reporting API. Select and click ENABLE
Create Service Account
Once Project is created and APIs are enabled we can now create a service account under that project. Service account has its ID which looks like some email ID (not to confuse with Google /Gmail email ID)
- Go to Create Service Account
- From the Project Dropdown (usually found at the top bar) click Select Project
- Enter Service account name and Service account description
- For Role, do not select anything for now and Click Continue and then click Done. Next we will create Key.
Create Key
Once service account is created we need to create key file (i.e. credentials).
- In the Cloud Console, click the email address for the service account that you created.
- Click Keys.
- Click Add key, then click Create new key.
- Click Create and select P12 format. A P12 key file is downloaded to your computer. We will use this file in our API connection.
- Click Close.
- Now you may use downloaded *.p12 key file as secret file and Service Account Email as Client ID (e.g. some-service-account-name@your-project-id.iam.gserviceaccount.com ).
Add Permission
Now last thing is give read/write permission to Service Account. Basically you can create or open Google Sheet and add the Service Account as an editor to it as below.
- Copy the email address of your service account we created in previous step (its usually like this some-service-account-name@your-project-id.iam.gserviceaccount.com).
- Create or select an existing Google Sheet.
- Navigate to Sheet for which you like to give read/write access to Service Account.
- Click on the Share button in the top right, and add the email address of the service account as an editor. Here is how to share file(s) with specific people. Juse share with Service Account (use Service Account Email found on previous section)
Fill in all required parameters and set optional parameters if needed:
YouTubeDSN
YouTube
Service Account (Using Private Key File) [OAuth]
https://youtube.googleapis.com/youtube/v3
-
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Read data in SQL Server from the ZappySys Data Gateway
-
To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
-
Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
-
Optional: Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).
You need to enable RPC Out if you plan to use EXEC(...) AT [MY_LINKED_SERVER_NAME]
rather than OPENQUERY.
If don't enabled it, you will encounter the Server 'MY_LINKED_SERVER_NAME' is not configured for RPC
error.
Query Example:
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
If you plan to use 'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]'
in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction.
error.
Query Example:
Insert Into dbo.Products
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
-
Finally, open a new query and execute a query we saved in one of the previous steps:
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');
Create Linked Server using Code
In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'YouTubeDSN'
USE [master]
GO
--///////////////////////////////////////////////////////////////////////////////////////
--Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
--///////////////////////////////////////////////////////////////////////////////////////
//Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
//Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
//Replace Port 5000 if you configured gateway on a different port
--1. Configure your gateway service as per this article https://zappysys.com/links?id=10036
--2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express
--Uncomment below if you like to drop linked server if it already exists
--EXEC master.dbo.sp_dropserver @server=N'LS_YouTubeDSN', @droplogins='droplogins'
--3. Create new linked server
EXEC master.dbo.sp_addlinkedserver
@server = N'LS_YouTubeDSN' --Linked server name (this will be used in OPENQUERY sql
, @srvproduct=N''
---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
, @provider=N'SQLNCLI11'
---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
--, @provider=N'MSOLEDBSQL'
, @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
, @provstr=N'Network Library=DBMSSOCN;'
, @catalog=N'YouTubeDSN' --Data source name you gave on Gateway service settings
--4. Attach gateway login with linked server
EXEC master.dbo.sp_addlinkedsrvlogin
@rmtsrvname=N'LS_YouTubeDSN' --linked server name
, @useself=N'False'
, @locallogin=NULL
, @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
, @rmtpassword='YOUR_GATEWAY_PASSWORD' --enter your Gateway user's password
GO
--5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
EXEC sp_serveroption 'LS_YouTubeDSN', 'rpc', true;
EXEC sp_serveroption 'LS_YouTubeDSN', 'rpc out', true;
--Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
EXEC sp_serveroption 'LS_YouTubeDSN', 'remote proc transaction promotion', false;
--Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
--EXEC sp_serveroption 'LS_YouTubeDSN', 'query timeout', 1200;
GO
Create View in SQL Server
Finally, use this or similar query in a view or stored procedure, which you will be able to use in Tableau. We will create a view to return invoices:
-
CREATE VIEW vwApiInvoices AS
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Invoices')
Read data in Tableau from SQL Server
Actually, we will be getting data from SQL Server which in turn will be getting data from ZappySys Data Gateway data source. Let's begin and see how to accomplish that:
- Open Tableau Desktop and click File > New
-
To create new Connection click More > Microsoft SQL Server > Enter your credentials to connect to SQL Server (in our example before we used tdsuser):
-
Once connection is created for SQL Server we can read YouTube data 3 different ways:
- Query View which contains OPENQUERY to Linked Server for YouTube data
- Use direct SQL Query using OPENQUERY
- Use Stored Procedure (Mostly useful to parameterize calls
-
See below example to pull data from YouTube in Tableau using SQL View approach:
-
Once your data sources are created you can click on Sheet1 and drag fields to create visualizations for Tableau Dashboard:
Passing Parameters to YouTube calls in Tableau (Dynamic SQL)
Now let's look at scenario where you have to pass parameters to build Dynamic Dashboard. You can try to insert Parameters in your Direct SQL when you build Dynamic SQL but we found some issues with that so we are going to suggest Stored Procedure approach.
For more information on Known issue on
Dynamic Metadata Check this post.
-
First lets create a stored procedure in SQL Server for Parameter Example. Notice how we added WITH RESULT SETS in the code to describe metadata.
--DROP PROC dbo.usp_GetInvoicesByCountry
--GO
/*
Purpose: Parameterize YouTube call via SQL. Call ZappySys Drivers inside SQL Server.
*/
CREATE PROC dbo.usp_GetInvoicesByCountry
@country varchar(100)
AS
DECLARE @sql varchar(max)
--//Escape single ticks carefully
SET @sql = 'SELECT OrderID,CustomerID,Country,Quantity FROM $
WITH (Src=''https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json@filter=Country eq '+ @country +'''
,Filter=''$.value[*]''
,DataFormat=''OData''
)'
DECLARE @sqlFull varchar(max)
SET @sqlFull='SELECT * FROM OPENQUERY( [LS] , ''' + REPLACE( @sql, '''', '''''' ) + ''' )'
PRINT @sqlFull --//For DEBUG purpose
EXECUTE (@sqlFull)
WITH RESULT SETS (
(OrderID int,CustomerID varchar(100),Country varchar(100),Quantity int) --//describe first result. If you don't do this then wont work in Tableau
)
GO
-- Example call
EXEC dbo.usp_GetInvoicesByCountry @country='Germany'
- Once you create a stored procedure go to Tableau datasource and select Database which contains the stored procedure we just created.
-
Now find your stored proc and drag it on the datasource pane. You will see parameters UI as below. You can create new parameter - Select New Parameter under Value Column.
- Thats it now you can reuse your parameterized datasource anywhere in Dashboard.
-
If you have need to select Parameters from predefined values rather than free text then edit your parameter and select List option. Define values you like to select from as below.
-
When you create Tableau Dashboard you will see Parameter dropdown (If you selected List) elase you may see Textbox to enter custom value.
Firewall settings
So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.
Method-1 (Preferred)
If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.
- Search for gateway in start menu and open ZappySys Data Gateway.
- Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it).
Method-2
Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
- Search for Windows Firewall Advanced Security in start menu.
- Under Inbound Rules > Right click and click [New Rule] >> Click Next
- Select Port on Rule Type >> Click Next
- Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
- Select Profile (i.e. Private, Public) >> Click Next
- Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
- Click OK to save the rule
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders]
@fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
AS
SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT
"ShipCountry",
"OrderID",
"CustomerID",
"EmployeeID",
"OrderDate",
"RequiredDate",
"ShippedDate",
"ShipVia",
"Freight",
"ShipName",
"ShipAddress",
"ShipCity",
"ShipRegion",
"ShipPostalCode"
FROM "Orders"
Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by YouTube Connector
YouTube Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
Read videos details by IDs or chart or myRating (pass one of them) [
Read more...]
Parameter |
Description |
Ids (up to 25 comma-separated) |
Comma-separated IDs of YouTube videos (max 25 IDs)
|
chart |
The chart parameter identifies the chart that you want to retrieve.
Option |
Value |
mostPopular |
mostPopular |
|
myRating |
Option |
Value |
like |
like |
dislike |
dislike |
|
part |
Option |
Value |
contentDetails |
contentDetails |
fileDetails |
fileDetails |
id |
id |
liveStreamingDetails |
liveStreamingDetails |
localizations |
localizations |
player |
player |
processingDetails |
processingDetails |
recordingDetails |
recordingDetails |
snippet |
snippet |
statistics |
statistics |
status |
status |
suggestions |
suggestions |
topicDetails |
topicDetails |
|
hl |
|
maxHeight |
Acceptable values are 72 to 8192, inclusive.
|
maxResults |
Acceptable values are 1 to 50, inclusive. Default value is 5.
|
maxWidth |
Acceptable values are 72 to 8192, inclusive.
|
onBehalfOfContentOwner |
|
regionCode |
|
videoCategoryId |
|
[
Read more...]
Parameter |
Description |
id |
|
onBehalfOfContentOwner |
|
[
Read more...]
Parameter |
Description |
part |
Option |
Value |
contentDetails |
contentDetails |
id |
id |
localizations |
localizations |
player |
player |
snippet |
snippet |
status |
status |
|
id |
Get playlist with this Id. If you pass this, don't set 'channelId' nor 'mine'.
|
channelId |
Set this parameter to show playlists from the specified channel. If you pass this, don't set 'id' nor 'mine'.
|
mine |
Set this parameter to show playlists for my account. If you pass this, don't set 'id' nor 'channelId'.
Option |
Value |
true |
true |
false |
false |
|
hl |
|
maxResults |
|
onBehalfOfContentOwner |
|
onBehalfOfContentOwnerChannel |
|
[
Read more...]
Parameter |
Description |
part |
Option |
Value |
contentDetails |
contentDetails |
id |
id |
snippet |
snippet |
status |
status |
|
id |
|
playlistId |
|
maxResults |
|
onBehalfOfContentOwner |
|
videoId |
|
[
Read more...]
Parameter |
Description |
part |
Option |
Value |
id |
id |
replies |
replies |
snippet |
snippet |
|
allThreadsRelatedToChannelId |
|
channelId |
|
id |
|
videoId |
|
maxResults |
|
moderationStatus |
Option |
Value |
heldForReview |
heldForReview |
likelySpam |
likelySpam |
published |
published |
|
order |
Option |
Value |
time |
time |
relevance |
relevance |
|
searchTerms |
|
textFormat |
Option |
Value |
html |
html |
plainText |
plainText |
|
[
Read more...]
Parameter |
Description |
part |
Option |
Value |
auditDetails |
auditDetails |
brandingSettings |
brandingSettings |
contentDetails |
contentDetails |
contentOwnerDetails |
contentOwnerDetails |
id |
id |
localizations |
localizations |
snippet |
snippet |
statistics |
statistics |
status |
status |
topicDetails |
topicDetails |
|
mine |
Option |
Value |
true |
true |
false |
false |
|
forUsername |
|
id |
|
managedByMe |
Option |
Value |
true |
true |
false |
false |
|
hl |
|
maxResults |
|
onBehalfOfContentOwner |
|
[
Read more...]
Parameter |
Description |
forMine (search in my account only) |
Option |
Value |
true |
true |
false |
false |
|
query (search term) |
|
channelId |
|
channelType |
Option |
Value |
any |
any |
show |
show |
|
eventType |
Option |
Value |
completed |
completed |
live |
live |
upcoming |
upcoming |
|
location |
|
locationRadius |
|
maxResults |
|
onehalfOfContentOwner |
|
order |
Option |
Value |
date |
date |
rating |
rating |
relevance |
relevance |
title |
title |
videoCount |
videoCount |
viewCount |
viewCount |
|
publishedAfter |
|
publishedBefore |
|
regionCode |
|
relevanceLanguage |
|
safeSearch |
Option |
Value |
moderate |
moderate |
none |
none |
strict |
strict |
|
topicId |
|
videoCaption |
Option |
Value |
any |
any |
closedCaption |
closedCaption |
none |
none |
|
videoCategoryId |
|
videoDefinition |
Option |
Value |
any |
any |
high |
high |
standard |
standard |
|
videoDimension |
Option |
Value |
2d |
2d |
3d |
3d |
any |
any |
|
videoDuration |
Option |
Value |
any |
any |
long |
long |
medium |
medium |
short |
short |
|
videoEmbeddable |
Option |
Value |
any |
any |
true |
true |
|
videoLicense |
Option |
Value |
any |
any |
creativeCommon |
creativeCommon |
youtube |
youtube |
|
videoSyndicated |
Option |
Value |
any |
any |
true |
true |
|
videoType |
Option |
Value |
any |
any |
episode |
episode |
movie |
movie |
|
forContentOwner |
Option |
Value |
true |
true |
false |
false |
|
forDeveloper |
Option |
Value |
true |
true |
false |
false |
|
relatedToVideoId |
|
[
Read more...]
Parameter |
Description |
part |
|
forMine (search in my account only) |
If set to 'true', parameter 'type' must be set to 'video'.
Option |
Value |
true |
true |
false |
false |
|
query (search term) |
|
type |
Must be set to 'video' if 'forMine' is set to 'true'.
Option |
Value |
channel |
channel |
playlist |
playlist |
video |
video |
|
channelId |
|
channelType |
Option |
Value |
any |
any |
show |
show |
|
eventType |
Option |
Value |
completed |
completed |
live |
live |
upcoming |
upcoming |
|
location |
|
locationRadius |
|
maxResults |
|
onehalfOfContentOwner |
|
order |
Option |
Value |
date |
date |
rating |
rating |
relevance |
relevance |
title |
title |
videoCount |
videoCount |
viewCount |
viewCount |
|
publishedAfter |
|
publishedBefore |
|
regionCode |
|
relevanceLanguage |
|
safeSearch |
Option |
Value |
moderate |
moderate |
none |
none |
strict |
strict |
|
topicId |
|
videoCaption |
Option |
Value |
any |
any |
closedCaption |
closedCaption |
none |
none |
|
videoCategoryId |
|
videoDefinition |
Option |
Value |
any |
any |
high |
high |
standard |
standard |
|
videoDimension |
Option |
Value |
2d |
2d |
3d |
3d |
any |
any |
|
videoDuration |
Option |
Value |
any |
any |
long |
long |
medium |
medium |
short |
short |
|
videoEmbeddable |
Option |
Value |
any |
any |
true |
true |
|
videoLicense |
Option |
Value |
any |
any |
creativeCommon |
creativeCommon |
youtube |
youtube |
|
videoSyndicated |
Option |
Value |
any |
any |
true |
true |
|
videoType |
Option |
Value |
any |
any |
episode |
episode |
movie |
movie |
|
forContentOwner |
Option |
Value |
true |
true |
false |
false |
|
forDeveloper |
Option |
Value |
true |
true |
false |
false |
|
relatedToVideoId |
|
[
Read more...]
Parameter |
Description |
ids |
Option |
Value |
Filter1 |
channel==MINE |
Filter2 |
channel==ENTER_CHANNEL_ID |
Filter3 |
contentOwner==ENTER_OWNER_NAME |
|
metrics |
Option |
Value |
adEarnings |
adEarnings |
annotationImpressions |
annotationImpressions |
annotationClickableImpressions |
annotationClickableImpressions |
annotationClicks |
annotationClicks |
annotationClickThroughRate |
annotationClickThroughRate |
annotationClosableImpressions |
annotationClosableImpressions |
annotationCloses |
annotationCloses |
annotationCloseRate |
annotationCloseRate |
audienceWatchRatio |
audienceWatchRatio |
averageViewDuration |
averageViewDuration |
averageViewPercentage |
averageViewPercentage |
cardClickRate |
cardClickRate |
cardClicks |
cardClicks |
cardImpressions |
cardImpressions |
cardTeaserClickRate |
cardTeaserClickRate |
cardTeaserClicks |
cardTeaserClicks |
cardTeaserImpressions |
cardTeaserImpressions |
comments |
comments |
dislikes |
dislikes |
earnings |
earnings |
estimatedMinutesWatched |
estimatedMinutesWatched |
estimatedPartnerAdSenseRevenue |
estimatedPartnerAdSenseRevenue |
estimatedPartnerDoubleClickRevenue |
estimatedPartnerDoubleClickRevenue |
grossRevenue |
grossRevenue |
impressionBasedCpm |
impressionBasedCpm |
impressions |
impressions |
likes |
likes |
monetizedPlaybacks |
monetizedPlaybacks |
playbackBasedCpm |
playbackBasedCpm |
playlistStarts |
playlistStarts |
savesAdded |
savesAdded |
savesRemoved |
savesRemoved |
shares |
shares |
subscribersGained |
subscribersGained |
subscribersLost |
subscribersLost |
videosAddedToPlaylists |
videosAddedToPlaylists |
videosRemovedFromPlaylists |
videosRemovedFromPlaylists |
viewerPercentage |
viewerPercentage |
views |
views |
|
Start Date (yyyy-MM-dd) |
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
End Date (yyyy-MM-dd) |
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
currency |
|
dimensions |
Option |
Value |
adType |
adType |
ageGroup |
ageGroup |
asset |
asset |
audienceType |
audienceType |
channel |
channel |
claimedStatus |
claimedStatus |
contentOwner |
contentOwner |
country |
country |
day |
day |
deviceType |
deviceType |
elapsedVideoTimeRatio |
elapsedVideoTimeRatio |
gender |
gender |
insightPlaybackLocationDetail |
insightPlaybackLocationDetail |
insightPlaybackLocationType |
insightPlaybackLocationType |
insightTrafficSourceDetail |
insightTrafficSourceDetail |
insightTrafficSourceType |
insightTrafficSourceType |
liveOrOnDemand |
liveOrOnDemand |
operatingSystem |
operatingSystem |
playlist |
playlist |
province |
province |
sharingService |
sharingService |
subscribedStatus |
subscribedStatus |
subtitleLanguage |
subtitleLanguage |
uploaderType |
uploaderType |
video |
video |
|
filters |
A list of filters that should be applied when retrieving YouTube Analytics data. The documentation for channel reports and content owner reports identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions.
Option |
Value |
Example1 |
country==IT |
Example2 |
video==dMH0bHeiRNg |
Example3 |
gender==FEMALE |
Example4 |
dimension==some_value |
|
includeHistoricalChannelData |
Option |
Value |
true |
true |
false |
false |
|
maxResults |
|
sort |
A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The - prefix causes descending sort order.
Option |
Value |
adType |
adType |
ageGroup |
ageGroup |
asset |
asset |
audienceType |
audienceType |
channel |
channel |
claimedStatus |
claimedStatus |
contentOwner |
contentOwner |
country |
country |
day |
day |
deviceType |
deviceType |
elapsedVideoTimeRatio |
elapsedVideoTimeRatio |
gender |
gender |
insightPlaybackLocationDetail |
insightPlaybackLocationDetail |
insightPlaybackLocationType |
insightPlaybackLocationType |
insightTrafficSourceDetail |
insightTrafficSourceDetail |
insightTrafficSourceType |
insightTrafficSourceType |
liveOrOnDemand |
liveOrOnDemand |
operatingSystem |
operatingSystem |
playlist |
playlist |
province |
province |
sharingService |
sharingService |
subscribedStatus |
subscribedStatus |
subtitleLanguage |
subtitleLanguage |
uploaderType |
uploaderType |
video |
video |
|
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
Body |
Request Body content goes here
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
|
Headers |
Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
|
YouTube Connector Examples for Tableau Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Get videos of my account [Read more...]
Get channels of my account [Read more...]
Get playlists of my account [Read more...]
SELECT * FROM MyPlaylists
Get comments of a video [Read more...]
SELECT * FROM get_comments WITH (videoId='INPUT_YOUR_VIDEO_ID')
Get comments of a channel [Read more...]
SELECT * FROM get_comments WITH (channelId='INPUT_YOUR_CHANNEL_ID')
Get my playlists of my account [Read more...]
SELECT * FROM MyPlaylists
Get my playlists of specific channel [Read more...]
SELECT * FROM get_playlists WITH (channelId='UCVGOyzms_XJNk_DHqrffXCw')
Search for videos in whole YouTube [Read more...]
SELECT * FROM search WITH (q='ZappySys Tutorials', maxResults='50')
Search for videos in a channel [Read more...]
SELECT * FROM search WITH (q='GPU', maxResults='50', channelId='UCXuqSBlHAE6Xw-yeJA0Tunw')
SELECT *
FROM get_channels
WITH(
id='UC2d5diIOoCEa47p4PjpIHya,AC2d5diIOoCEa47p4PjpIHyQ,TC2d5diIOoCEa47p4PjpIHyI'
)
Gets a report of specific channel [Read more...]
SELECT *
FROM get_report
WITH(
ids='channel==ENTER_CHANNEL_ID'
, metrics='likes~shares~views'
, startDate='2022-08-01'
, endDate='2022-08-30'
)
Gets a report of my channel with relative date [Read more...]
SELECT *
FROM get_report
WITH(
ids='channel==MINE'
, metrics='likes~shares~views'
, startDate='yearstart' --OR put date like '2022-08-01'
, endDate='today' --OR put date like '2022-08-01'
, dimensions='country'
)
Conclusion
In this article we discussed how to connect to YouTube in Tableau and integrate data without any coding. Click here to Download YouTube Connector for Tableau and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download YouTube Connector for Tableau
Documentation
More integrations
Other application integration scenarios for YouTube
Other connectors for Tableau
Download YouTube Connector for Tableau
Documentation
Common Searches:
How to connect YouTube in Tableau?
How to get YouTube data in Tableau?
How to read YouTube data in Tableau?
How to load YouTube data in Tableau?
How to import YouTube data in Tableau?
How to pull YouTube data in Tableau?
How to push data to YouTube in Tableau?
How to write data to YouTube in Tableau?
How to POST data to YouTube in Tableau?
Call YouTube API in Tableau
Consume YouTube API in Tableau
YouTube Tableau Automate
YouTube Tableau Integration
Integration YouTube in Tableau
Consume real-time YouTube data in Tableau
Consume real-time YouTube API data in Tableau
YouTube ODBC Driver | ODBC Driver for YouTube | ODBC YouTube Driver | SSIS YouTube Source | SSIS YouTube Destination
Connect YouTube in Tableau
Load YouTube in Tableau
Load YouTube data in Tableau
Read YouTube data in Tableau
YouTube API Call in Tableau