CData Cloud offers access to YouTube Analytics across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to YouTube Analytics through CData Cloud.
CData Cloud allows you to standardize and configure connections to YouTube Analytics as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to YouTube Analytics in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to YouTube Analytics and configure any necessary connection properties to create a database in CData Cloud
Accessing data from YouTube Analytics through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to YouTube Analytics by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Provide the following connection properties before adding the authentication properties.
All connections to YouTube Analytics are authenticated using OAuth. The Cloud supports using user accounts and GCP instance accounts for authentication.
AuthScheme must be set to OAuth in all of the user account flows.
When running on a GCP virtual machine, the Cloud can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.
Use the OAuth authentication standard to connect to YouTube Analytics. You can authenticate with a user account or a service account. The Cloud facilitates this as described below.
The user account flow requires the authenticating user to interact with YouTube Analytics via the browser.
Instead of connecting with the Cloud's embedded credentials, you can register an app to obtain the OAuthClientId and OAuthClientSecret.
Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the Cloud.
You need to create an OAuth application in this flow. You can then connect to YouTube Analytics data that the service account has permission to access. See Custom Credentials for an authentication guide.
See Creating a Custom OAuth App for a procedure.
You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect:
You can use a custom OAuth app to authenticate with a service account or a user account. See Using OAuth Authentication for more information.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the Cloud.
You need to create an OAuth application in this flow. See Creating a Custom OAuth App to create and authorize an app. You can then connect to YouTube Analytics data that the service account has permission to access.
After setting the following connection properties, you are ready to connect:
Obtain a Verifier Code
Follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property:
On the headless machine, set the following connection properties to obtain the OAuth authentication values.
After the OAuth settings file is generated, set the following properties to connect to data:
Transfer OAuth Settings
Follow the steps below to install the Cloud on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the Cloud and connect with the following properties set:
On the headless machine, set the following connection properties to connect to data:
Create a Custom OAuth App
Creating a custom OAuth app is optional in the headless OAuth flow; you can skip creating an app by connecting with the Cloud's embedded OAuth credentials. You might want to create a custom OAuth app to change the information displayed when users log into YouTube Analytics to grant permissions to the Cloud.
See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.
Obtain a Verifier Code
Set the following properties on the headless machine:
You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, set the following properties to connect to data:
Transfer OAuth Settings
Follow the steps below to install the Cloud on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the Cloud and connect with the following properties set:
Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the Cloud.
You need to create an OAuth application in this flow. See Creating a Custom OAuth App to create and authorize an app. You can then connect to YouTube Analytics data that the service account has permission to access.
After setting the following connection properties, you are ready to connect:
You can use a custom OAuth app to authenticate a service account or a user account. See Using OAuth Authentication for more information.
Follow the procedure below to register an app and obtain the OAuthClientId and OAuthClientSecret.
In the user consent flow, click Credentials -> Create Credentials -> OAuth Client Id. Click Other. After creating the app, the OAuthClientId and OAuthClientSecret are displayed.
Follow the steps below to create an OAuth application and generate a private key. You will then authorize the service account.
YouTube Analytics data is organized into various metrics (Viewers, ViewerPercentage, AgeGroup, etc.), which can be queried over various dimensions (Day, DeviceType, etc.). There are many valid combinations of metrics and dimensions. The Cloud surfaces some of the most commonly used combinations as relational views for ease of use.
Additionally, the Cloud allows you to query all valid combinations, even those not included in the predefined views. You can use the CreateCustomSchema stored procedure to create a view on a query. Refer to Data Model for how to combine metrics and dimensions in queries and schemas. Below is a guide to getting started with the default views.
The dimension and metrics are clearly defined for each table and can be seen in the Data Model: Simply select the metrics and the dimensions you are interested in.
For example, a channel's top videos by most minutes watched in a specific country can be selected like this:
SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country='AL'
Unlike most database tables, it is not very helpful to select all metrics and dimensions in a given table. The Cloud thus interprets the SELECT * query to mean a default set of metrics and dimensions are requested. This includes queries that explicitly select all columns. Refer to the individual view's documentation in Data Model to see which fields are the default for each schema.
| Date | Build Number | Change Type | Description |
| 12/14/2022 | 8383 | General | Changed
|
| 09/30/2022 | 8308 | General | Changed
|
| 09/12/2022 | 8290 | YouTube Analytics | Added
|
| 08/17/2022 | 8264 | General | Changed
|
| 11/30/2021 | 8004 | YouTube Analytics | Added
|
| 10/26/2021 | 7969 | YouTube Analytics | Added
Deprecated
|
| 09/02/2021 | 7915 | General | Added
|
| 08/07/2021 | 7889 | General | Changed
|
| 08/06/2021 | 7888 | General | Changed
|
| 07/23/2021 | 7874 | General | Changed
|
| 07/08/2021 | 7859 | General | Added
|
| 04/23/2021 | 7785 | General | Added
|
| 04/23/2021 | 7783 | General | Changed
|
| 04/16/2021 | 7776 | General | Added
Changed
|
| 04/15 /2021 | 7775 | General | Changed
|
This section details a selection of advanced features of the YouTube Analytics Cloud.
The Cloud allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Configure the Cloud for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Cloud offloads as much of the SELECT statement processing as possible to YouTube Analytics and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
The CData Cloud allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from a tool. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Cloud.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Groups WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
SELECT * FROM Customers WHERE City = 'Raleigh';An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
For sources that do not support SQL-92, the Cloud offloads as much of SQL statement processing as possible to YouTube Analytics and then processes the rest of the query in memory (client-side). This results in optimal performance.
For data sources with limited query capabilities, the Cloud handles transformations of the SQL query to make it simpler for the Cloud. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The YouTube Analytics Query Evaluation component examines SQL queries and returns information indicating what parts of the query the Cloud is not capable of executing natively.
The YouTube Analytics Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.
There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.
Capturing Cloud logging can be very helpful when diagnosing error messages or other unexpected behavior.
You will simply need to set two connection properties to begin capturing Cloud logging.
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described in the following list:
| 1 | Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors. |
| 2 | Setting Verbosity to 2 will log everything included in Verbosity 1 and additional information about the request. |
| 3 | Setting Verbosity to 3 will additionally log HTTP headers, as well as the body of the request and the response. |
| 4 | Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation. |
| 5 | Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands. |
The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.
To refine the logged content further by showing/hiding specific categories of information, see LogModules.
Best Practices for Data Security
Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.
You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property.
This property allows you to filter the logging using a semicolon-separated list of logging modules.
All modules are four characters long. Please note that modules containing three letters have a required trailing blank space. The available modules are:
LogModules=INFO;EXEC;SSL ;SQL ;META;
Note that these modules refine the information as it is pulled after taking the Verbosity into account.
The CData Cloud supports several operations on data, including querying, deleting, modifying, and inserting.
See SELECT Statements for a syntax reference and examples.
See Data Model for information on the capabilities of the YouTube Analytics API.
See INSERT Statements for a syntax reference and examples.
The primary key Id is required to update a record. See UPDATE Statements for a syntax reference and examples.
The primary key Id is required to delete a record. See DELETE Statements for a syntax reference and examples.
Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.
A SELECT statement can consist of the following basic clauses.
The following syntax diagram outlines the syntax supported by the SQL engine of the Cloud:
SELECT {
[ TOP <numeric_literal> | DISTINCT ]
{
*
| {
<expression> [ [ AS ] <column_reference> ]
| { <table_name> | <correlation_name> } .*
} [ , ... ]
}
[ INTO csv:// [ filename= ] <file_path> [ ;delimiter=tab ] ]
{
FROM <table_reference> [ [ AS ] <identifier> ]
} [ , ... ]
[ [
INNER | { { LEFT | RIGHT | FULL } [ OUTER ] }
] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ]
] [ ... ]
[ WHERE <search_condition> ]
[ GROUP BY <column_reference> [ , ... ]
[ HAVING <search_condition> ]
[ UNION [ ALL ] <select_statement> ]
[
ORDER BY
<column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
]
[
LIMIT <expression>
[
{ OFFSET | , }
<expression>
]
]
} | SCOPE_IDENTITY()
<expression> ::=
| <column_reference>
| @ <parameter>
| ?
| COUNT( * | { [ DISTINCT ] <expression> } )
| { AVG | MAX | MIN | SUM | COUNT } ( <expression> )
| NULLIF ( <expression> , <expression> )
| COALESCE ( <expression> , ... )
| CASE <expression>
WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
[ ELSE { <expression> | NULL } ]
END
| <literal>
| <sql_function>
<search_condition> ::=
{
<expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN } [ <expression> ]
} [ { AND | OR } ... ]
SELECT * FROM Groups
SELECT [ContentDetails_ItemType] AS MY_ContentDetails_ItemType FROM Groups
SELECT CAST(Additive_Tax AS VARCHAR) AS Str_Additive_Tax FROM Groups
SELECT * FROM Groups WHERE Id = 'S'
SELECT * FROM Groups WHERE Id = 'S';
SELECT COUNT(*) AS MyCount FROM Groups
SELECT COUNT(DISTINCT ContentDetails_ItemType) FROM Groups
SELECT DISTINCT ContentDetails_ItemType FROM Groups
SELECT ContentDetails_ItemType, MAX(Additive_Tax) FROM Groups GROUP BY ContentDetails_ItemTypeSee Aggregate Functions for details.
SELECT Customers.ContactName, Orders.OrderDate FROM Customers, Orders WHERE Customers.CustomerId=Orders.CustomerIdSee JOIN Queries for details.
SELECT Snippet_Title, ContentDetails_ItemType FROM Groups ORDER BY ContentDetails_ItemType ASC
SELECT Snippet_Title, ContentDetails_ItemType FROM Groups LIMIT 10
SELECT * FROM Groups WHERE Id = @param
Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not
appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from YouTube Analytics.
SELECT * FROM Groups WHERE Pseudo = '@Pseudo'
Returns the number of rows matching the query criteria.
SELECT COUNT(*) FROM Groups WHERE Id = 'S'
Returns the number of distinct, non-null field values matching the query criteria.
SELECT COUNT(DISTINCT Snippet_Title) AS DistinctValues FROM Groups WHERE Id = 'S'
Returns the number of rows matching the query criteria.
SELECT COUNT(*) FROM Groups WHERE Id = 'S'
Returns the number of distinct, non-null field values matching the query criteria.
SELECT COUNT(DISTINCT Snippet_Title) AS DistinctValues FROM Groups WHERE Id = 'S'
Returns the average of the column values.
SELECT ContentDetails_ItemType, AVG(Additive_Tax) FROM Groups WHERE Id = 'S' GROUP BY ContentDetails_ItemType
Returns the minimum column value.
SELECT MIN(Additive_Tax), ContentDetails_ItemType FROM Groups WHERE Id = 'S' GROUP BY ContentDetails_ItemType
Returns the maximum column value.
SELECT ContentDetails_ItemType, MAX(Additive_Tax) FROM Groups WHERE Id = 'S' GROUP BY ContentDetails_ItemType
Returns the total sum of the column values.
SELECT SUM(Additive_Tax) FROM Groups WHERE Id = 'S'
The CData Cloud supports standard SQL joins like the following examples.
An inner join selects only rows from both tables that match the join condition:
SELECT Customers.ContactName, Orders.OrderDate FROM Customers, Orders WHERE Customers.CustomerId=Orders.CustomerId
A left join selects all rows in the FROM table and only matching rows in the JOIN table:
SELECT Customers.ContactName, Orders.OrderDate FROM Customers LEFT OUTER JOIN Orders ON Customers.CustomerId=Orders.CustomerId
The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.
The current day.
SELECT * FROM MyTable WHERE MyDateField = L_TODAY()
The previous day.
SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()
The following day.
SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()
Every day in the preceding week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()
Every day in the current week.
SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()
Every day in the following week.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()Also available:
The previous n days, excluding the current day.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)
The following n days, including the current day.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)Also available:
Every day in every week, starting n weeks before current week, and ending in the previous week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)
Every day in every week, starting the following week, and ending n weeks in the future.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)Also available:
You can use the SELECT INTO statement to export formatted data to a file.
The following query exports data into a file formatted in comma-separated values (CSV):
SELECT Snippet_Title, ContentDetails_ItemType INTO [csv://Groups.txt] FROM [Groups] WHERE Id = 'S'You can specify other formats in the file URI. The possible delimiters are tab, semicolon, and comma with the default being a comma. The following example exports tab-separated values:
SELECT Snippet_Title, ContentDetails_ItemType INTO [csv://Groups.txt;delimiter=tab] FROM [Groups] WHERE Id = 'S'You can specify other file formats in the URI. The following example exports tab-separated values:
The Cloud provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.
The Cloud interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and Cloud syntax for the DATENAME function:
SELECT DATENAME(yy,GETDATE())
SELECT DATENAME('yy',GETDATE())
These functions perform string manipulations and return a string value. See STRING Functions for more details.
SELECT CONCAT(firstname, space(4), lastname) FROM Groups WHERE Id = 'S'
These functions perform date and date time manipulations. See DATE Functions for more details.
SELECT CURRENT_TIMESTAMP() FROM Groups
These functions provide mathematical operations. See MATH Functions for more details.
SELECT RAND() FROM Groups
SELECT CONCAT('Mr.', SPACE(2), firstname, SPACE(4), lastname) FROM Groups
Returns the ASCII code value of the left-most character of the character expression.
SELECT ASCII('0');
-- Result: 48
Converts the integer ASCII code to the corresponding character.
SELECT CHAR(48);
-- Result: '0'
Returns the starting position of the specified expression in the character string.
SELECT CHARINDEX('456', '0123456');
-- Result: 4
SELECT CHARINDEX('456', '0123456', 5);
-- Result: -1
Returns the number of UTF-8 characters present in the expression.
SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
-- Result: 11
Returns the string that is the concatenation of two or more string values.
SELECT CONCAT('Hello, ', 'world!');
-- Result: 'Hello, world!'
Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.
SELECT CONTAINS('0123456', '456');
-- Result: 1
SELECT CONTAINS('0123456', 'Not a number');
-- Result: 0
Returns 1 if character_expression ends with character_suffix; otherwise, 0.
SELECT ENDSWITH('0123456', '456');
-- Result: 1
SELECT ENDSWITH('0123456', '012');
-- Result: 0
Returns the number of bytes present in the file at the specified file path.
SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
-- Result: 23684
Returns the value formatted with the specified format.
SELECT FORMAT(12.34, '#');
-- Result: 12
SELECT FORMAT(12.34, '#.###');
-- Result: 12.34
SELECT FORMAT(1234, '0.000E0');
-- Result: 1.234E3
SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
-- Result: 2019-01-01
SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
-- Result: '2019-01-01'
Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.
SELECT FROM_UNIXTIME(1540495231, 1);
-- Result: 2018-10-25 19:20:31
SELECT FROM_UNIXTIME(1540495357385, 0);
-- Result: 2018-10-25 19:22:37
Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.
SELECT HASHBYTES('MD5', 'Test');
-- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
Returns the starting position of the specified expression in the character string.
SELECT INDEXOF('0123456', '456');
-- Result: 4
SELECT INDEXOF('0123456', '456', 5);
-- Result: -1
Replaces null with the specified replacement value.
SELECT ISNULL(42, 'Was NULL');
-- Result: 42
SELECT ISNULL(NULL, 'Was NULL');
-- Result: 'Was NULL'
Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4.5
Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 2
Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
-- Result: '{"data":1}'
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
-- Result: 1
SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
-- Result: 2
Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
-- Result: 4
Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4
Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.
SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 9
Returns the specified number of characters counting from the left of the specified string.
SELECT LEFT('1234567890', 3);
-- Result: '123'
Returns the number of characters of the specified string expression.
SELECT LEN('12345');
-- Result: 5
Returns an integer representing how many characters into the string the substring appears.
SELECT LOCATE('sample','XXXXXsampleXXXXX');
-- Result: 6
Returns the character expression with the uppercase character data converted to lowercase.
SELECT LOWER('MIXED case');
-- Result: 'mixed case'
Returns the character expression with leading blanks removed.
SELECT LTRIM(' trimmed');
-- Result: 'trimmed'
Replaces the characters between start_index and end_index with the mask_character within the string.
SELECT MASK('1234567890','*',);
-- Result: '**********'
SELECT MASK('1234567890','*', 4);
-- Result: '1234******'
SELECT MASK('1234567890','*', 4, 2);
-- Result: '1234****90'
Returns the Unicode character with the specified integer code as defined by the Unicode standard.
Returns the number of bytes present in the expression.
SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
-- Result: 4
Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.
SELECT PATINDEX('123%', '1234567890');
-- Result: 1
SELECT PATINDEX('%890', '1234567890');
-- Result: 8
SELECT PATINDEX('%456%', '1234567890');
-- Result: 4
Returns the starting position of the specified expression in the character string.
SELECT POSITION('456' IN '123456');
-- Result: 4
SELECT POSITION('x' IN '123456');
-- Result: 0
Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.
SELECT QUOTENAME('table_name');
-- Result: '[table_name]'
SELECT QUOTENAME('table_name', '"');
-- Result: '"table_name"'
SELECT QUOTENAME('table_name', '[');
-- Result: '[table_name]'
Replaces all occurrences of a string with another string.
SELECT REPLACE('1234567890', '456', '|');
-- Result: '123|7890'
SELECT REPLACE('123123123', '123', '.');
-- Result: '...'
SELECT REPLACE('1234567890', 'a', 'b');
-- Result: '1234567890'
Repeats the string value the specified number of times.
SELECT REPLACE('x', 5);
-- Result: 'xxxxx'
Returns the reverse order of the string expression.
SELECT REVERSE('1234567890');
-- Result: '0987654321'
Returns the right part of the string with the specified number of characters.
SELECT RIGHT('1234567890', 3);
-- Result: '890'
Returns the character expression after it removes trailing blanks.
SELECT RTRIM('trimmed ');
-- Result: 'trimmed'
Returns the four-character Soundex code, based on how the string sounds when spoken.
SELECT SOUNDEX('smith');
-- Result: 'S530'
Returns the string that consists of repeated spaces.
SELECT SPACE(5);
-- Result: ' '
Returns a section of the string between to delimiters.
SELECT SPLIT('a/b/c/d', '/', 1);
-- Result: 'a'
SELECT SPLIT('a/b/c/d', '/', -2);
-- Result: 'c'
Returns 1 if character_expression starts with character_prefix; otherwise, 0.
SELECT STARTSWITH('0123456', '012');
-- Result: 1
SELECT STARTSWITH('0123456', '456');
-- Result: 0
Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.
SELECT STR('123.456');
-- Result: '123'
SELECT STR('123.456', 2);
-- Result: '**'
SELECT STR('123.456', 10, 2);
-- Result: '123.46'
Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.
SELECT STUFF('1234567890', 3, 2, 'xx');
-- Result: '12xx567890'
Returns the part of the string with the specified length; starts at the specified index.
SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
-- Result: '34'
SELECT SUBSTRING('1234567890' FROM 3);
-- Result: '34567890'
Converts the value of this instance to its equivalent string representation.
SELECT TOSTRING(123);
-- Result: '123'
SELECT TOSTRING(123.456);
-- Result: '123.456'
SELECT TOSTRING(null);
-- Result: ''
Returns the character expression with leading and/or trailing blanks removed.
SELECT TRIM(' trimmed ');
-- Result: 'trimmed'
SELECT TRIM(LEADING FROM ' trimmed ');
-- Result: 'trimmed '
SELECT TRIM('-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
-- Result: '-----trimmed'
Returns the integer value defined by the Unicode standard of the first character of the input expression.
Returns the character expression with lowercase character data converted to uppercase.
SELECT UPPER('MIXED case');
-- Result: 'MIXED CASE'
Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
-- Result: 'a,e,i,o,u'
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
-- Result: 'a;e;i;o;u'
Returns the current date value.
SELECT CURRENT_DATE();
-- Result: 2018-02-01
Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.
SELECT CURRENT_TIMESTAMP();
-- Result: 2018-02-01 03:04:05
Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.
SELECT DATEADD('d', 5, '2018-02-01');
-- Result: 2018-02-06
SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
-- Result: 2018-02-01 05:00:00
Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.
SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
-- Result: 9
SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
-- Result: 12
Returns the datetime value for the specified year, month, and day.
SELECT DATEFROMPARTS(2018, 2, 1);
-- Result: 2018-02-01
Returns the character string that represents the specified date part of the specified date.
SELECT DATENAME('yy', '2018-02-01');
-- Result: '2018'
SELECT DATENAME('dw', '2018-02-01');
-- Result: 'Thursday'
Returns a character string that represents the specified date part of the specified date.
SELECT DATEPART('yy', '2018-02-01');
-- Result: 2018
SELECT DATEPART('dw', '2018-02-01');
-- Result: 5
Returns the datetime value for the specified date parts.
SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
-- Result: 2018-02-01 01:02:03.456
Returns the datetime value for the specified date parts.
SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
-- Result: 2018-02-01 01:02:03.456
Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.
SELECT DATE_TRUNC('05-04-2005', 'YY');
-- Result: '1/1/2005'
SELECT DATE_TRUNC('05-04-2005', 'MM');
-- Result: '5/1/2005'
Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.
SELECT DATE_TRUNC2('year', '2020-02-04');
-- Result: '2020-01-01'
SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
-- Result: '2020-02-02', which is the previous Monday
Returns the integer that specifies the day component of the specified date.
SELECT DAY('2018-02-01');
-- Result: 1
SELECT DAYOFMONTH('04/15/2000');
-- Result: 15
SELECT DAYOFWEEK('04/15/2000');
-- Result: 7
SELECT DAYOFYEAR('04/15/2000');
-- Result: 106
Returns the last day of the month that contains the specified date with an optional offset.
SELECT EOMONTH('2018-02-01');
-- Result: 2018-02-28
SELECT LAST_DAY('2018-02-01');
-- Result: 2018-02-28
SELECT EOMONTH('2018-02-01', 2);
-- Result: 2018-04-30
SELECT FDWEEK('02-08-2018');
-- Result: 2/4/2018
SELECT FDMONTH('02-08-2018');
-- Result: 2/1/2018
SELECT FDQUARTER('05-08-2018');
-- Result: 4/1/2018
Returns the time stamp associated with the Date Modified of the relevant file.
SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
-- Result: 6/25/2019 10:06:58 AM
Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.
SELECT FROM_DAYS(736000); -- Result: 2/6/2015
Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.
SELECT GETDATE();
-- Result: 2018-02-01 03:04:05
Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.
SELECT GETUTCDATE();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the hour component from the provided datetime.
SELECT HOUR('02-02-2020 11:30:00');
-- Result: 11
Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.
SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
-- Result: 1
SELECT ISDATE('Not a date');
-- Result: 0
Returns a time stamp equivalent to exactly one week before the current date.
SELECT LAST_WEEK(); //Assume the date is 3/17/2020 -- Result: 3/10/2020
Returns a time stamp equivalent to exactly one month before the current date.
SELECT LAST_MONTH(); //Assume the date is 3/17/2020 -- Result: 2/17/2020
Returns a time stamp equivalent to exactly one year before the current date.
SELECT LAST_YEAR(); //Assume the date is 3/17/2020 -- Result: 3/10/2019
Returns the last day of the provided week.
SELECT LDWEEK('02-02-2020');
-- Result: 2/8/2020
Returns the last day of the provided month.
SELECT LDMONTH('02-02-2020');
-- Result: 2/29/2020
Returns the last day of the provided quarter.
SELECT LDQUARTER('02-02-2020');
-- Result: 3/31/2020
Returns a date value from a year and a number of days.
SELECT MAKEDATE(2020, 1);
-- Result: 2020-01-01
Returns the minute component from the provided datetime.
SELECT MINUTE('02-02-2020 11:15:00');
-- Result: 15
Returns the month component from the provided datetime.
SELECT MONTH('02-02-2020');
-- Result: 2
Returns the quarter associated with the provided datetime.
SELECT QUARTER('02-02-2020');
-- Result: 1
Returns the second component from the provided datetime.
SELECT SECOND('02-02-2020 11:15:23');
-- Result: 23
Returns the datetime value for the specified date and time.
SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
-- Result: 2018-02-01 01:02:00
Parses the provided string value and returns the corresponding datetime.
SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
-- Result: 4/3/2020
Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.
SELECT SYSDATETIME();
-- Result: 2018-02-01 03:04:05
Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.
SELECT SYSUTCDATETIME();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the time value for the specified time and with the specified precision.
SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
-- Result: 01:02:03.456
Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.
SELECT TO_DAYS('02-06-2015');
-- Result: 736000
Returns the week (of the year) associated with the provided datetime.
SELECT WEEK('02-17-2020 11:15:23');
-- Result: 8
Returns the integer that specifies the year of the specified date.
SELECT YEAR('2018-02-01');
-- Result: 2018
Returns the absolute (positive) value of the specified numeric expression.
SELECT ABS(15);
-- Result: 15
SELECT ABS(-15);
-- Result: 15
Returns the arc cosine, the angle in radians whose cosine is the specified float expression.
SELECT ACOS(0.5);
-- Result: 1.0471975511966
Returns the arc sine, the angle in radians whose sine is the specified float expression.
SELECT ASIN(0.5);
-- Result: 0.523598775598299
Returns the arc tangent, the angle in radians whose tangent is the specified float expression.
SELECT ATAN(10);
-- Result: 1.47112767430373
Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.
SELECT ATN2(1, 1);
-- Result: 0.785398163397448
Returns the smallest integer greater than or equal to the specified numeric expression.
SELECT CEILING(1.3);
-- Result: 2
SELECT CEILING(1.5);
-- Result: 2
SELECT CEILING(1.7);
-- Result: 2
Returns the trigonometric cosine of the specified angle in radians in the specified expression.
SELECT COS(1);
-- Result: 0.54030230586814
Returns the trigonometric cotangent of the angle in radians specified by float_expression.
SELECT COT(1);
-- Result: 0.642092615934331
Returns the angle in degrees for the angle specified in radians.
SELECT DEGREES(3.1415926);
-- Result: 179.999996929531
Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.
SELECT EXP(2);
-- Result: 7.38905609893065
Evaluates the expression.
SELECT EXPR('1 + 2 * 3');
-- Result: 7
SELECT EXPR('1 + 2 * 3 == 7');
-- Result: true
Returns the largest integer less than or equal to the numeric expression.
SELECT FLOOR(1.3);
-- Result: 1
SELECT FLOOR(1.5);
-- Result: 1
SELECT FLOOR(1.7);
-- Result: 1
Returns the greatest of the supplied integers.
SELECT GREATEST(3,5,8,10,1) -- Result: 10
Returns a the equivalent hex for the input value.
SELECT HEX(866849198);
-- Result: 33AB11AE
SELECT HEX('Sample Text');
-- Result: 53616D706C652054657874
Returns the least of the supplied integers.
SELECT LEAST(3,5,8,10,1) -- Result: 1
Returns the natural logarithm of the specified float expression.
SELECT LOG(7.3890560);
-- Result: 1.99999998661119
Returns the base-10 logarithm of the specified float expression.
SELECT LOG10(10000);
-- Result: 4
Returns the integer value associated with the remainder when dividing the dividend by the divisor.
SELECT MOD(10,3); -- Result: 1
Returns the opposite to the real number input.
SELECT NEGATE(10); -- Result: -10 SELECT NEGATE(-12.4) --Result: 12.4
Returns the constant value of pi.
SELECT PI()
-- Result: 3.14159265358979
Returns the value of the specified expression raised to the specified power.
SELECT POWER(2, 10);
-- Result: 1024
SELECT POWER(2, -2);
-- Result: 0.25
Returns the angle in radians of the angle in degrees.
SELECT RADIANS(180);
-- Result: 3.14159265358979
Returns a pseudorandom float value from 0 through 1, exclusive.
SELECT RAND();
-- This result may be different, since the seed is randomized
-- Result: 0.873159630165044
SELECT RAND(1);
-- This result will always be the same, since the seed is constant
-- Result: 0.248668584157093
Returns the numeric value rounded to the specified length or precision.
SELECT ROUND(1.3, 0);
-- Result: 1
SELECT ROUND(1.55, 1);
-- Result: 1.6
SELECT ROUND(1.7, 0, 0);
-- Result: 2
SELECT ROUND(1.7, 0, 1);
-- Result: 1
SELECT ROUND (1.24);
-- Result: 1.0
Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.
SELECT SIGN(0);
-- Result: 0
SELECT SIGN(10);
-- Result: 1
SELECT SIGN(-10);
-- Result: -1
Returns the trigonometric sine of the angle in radians.
SELECT SIN(1);
-- Result: 0.841470984807897
Returns the square root of the specified float value.
SELECT SQRT(100);
-- Result: 10
Returns the square of the specified float value.
SELECT SQUARE(10);
-- Result: 100
SELECT SQUARE(-10);
-- Result: 100
Returns the tangent of the input expression.
SELECT TAN(1);
-- Result: 1.5574077246549
Returns the supplied decimal number truncated to have the supplied decimal precision.
SELECT TRUNC(10.3423,2); -- Result: 10.34
To create new records, use INSERT statements.
The INSERT statement specifies the columns to be inserted and the new column values. You can specify the column values in a comma-separated list in the VALUES clause, as shown in the following example:
INSERT INTO <table_name>
( <column_reference> [ , ... ] )
VALUES
( { <expression> | NULL } [ , ... ] )
<expression> ::=
| @ <parameter>
| ?
| <literal>
The following is an example query:
INSERT INTO Groups (ContentDetails_ItemType) VALUES ('youtube#playlist')
To modify existing records, use UPDATE statements.
The UPDATE statement takes as input a comma-separated list of columns and new column values as name-value pairs in the SET clause, as shown in the following example:
UPDATE <table_name> SET { <column_reference> = <expression> } [ , ... ] WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
The following is an example query:
UPDATE Groups SET ContentDetails_ItemType='youtube#playlist' WHERE Id = @myId
To delete information from a table, use DELETE statements.
The DELETE statement requires the table name in the FROM clause and the row's primary key in the WHERE clause, as shown in the following example:
<delete_statement> ::= DELETE FROM <table_name> WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
The following is an example query:
DELETE FROM Groups WHERE Id = @myId
To execute stored procedures, you can use EXECUTE or EXEC statements.
EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.
To execute a stored procedure as an SQL statement, use the following syntax:
{ EXECUTE | EXEC } <stored_proc_name>
{
[ @ ] <input_name> = <expression>
} [ , ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
Reference stored procedure inputs by name:
EXECUTE my_proc @second = 2, @first = 1, @third = 3;
Execute a parameterized stored procedure statement:
EXECUTE my_proc second = @p1, first = @p2, third = @p3;
PIVOT and UNPIVOT can be used to change a table-valued expression into another table.
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"
For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)
The CData Cloud models YouTube Analytics entities in relational Tables, Views, and Stored Procedures. YouTube Analytics allows for Dimensions and Metrics to be queried in a large number of arrangements. Some sample views are provided based on common YouTube Analytics reports. You can however also create your own custom views based on any combination of Dimensions and Metrics you need.
Creating view schemas as well as API limitations and requirements are documented in this section.
You can access Groups and Group Items as Tables.
Stored Procedures are function-like interfaces to the data source. They can be used to access additional capabilities of the YouTube Analytics API.
Reports are shown as views, tables that cannot be modified. Unlike traditional database views, however, it is not very helpful to select all metrics and dimensions in a given table. The provider thus interprets the SELECT * query to mean a default set of metrics and dimensions are requested. This includes queries that explicitly select all columns.
Additionally, the YouTube Analytics API limits the number and combinations of columns that can be projected over the data or used to restrict the results returned. You can find these limitations and the default fields for each schema in Views. Refer to these sections when defining your own view, as well.
To create a view on a query, you can use the CreateCustomSchema stored procedure. The CreateCustomSchema stored procedure provides an easy way to generate new view definitions with a custom combination of Dimensions and Metrics. Calling it will create a new schema file that you can query like any other view.
The stored procedure takes a view name, a comma-separated list of metrics, a comma-separated list of dimensions, and an output folder as inputs. You will need to set the Location connection property to the folder containing the new script files in order to access them; the Location can be set instead of the output folder.
For example, to use a new schema along with the default schemas, set the Location property to the db subfolder in the installation folder and make the following call:
EXEC CreateCustomSchema Dimensions='Day,DeviceType', Metrics='Views,EstimatedMinutesWatched', TableName='DailyDeviceReports'
The Cloud models the data in YouTube Analytics into a list of tables that can be queried using standard SQL statements.
Generally, querying YouTube Analytics tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.
| Name | Description |
| GroupItems | Create, delete, and query Items that compose a Group. |
| Groups | Create, update, delete, and query YouTube Analytics Groups. |
Create, delete, and query Items that compose a Group.
The following query returns the items that compose the YouTube Analytics groups:
SELECT * FROM GroupItems
The following query returns the items that compose a specific YouTube Analytics group:
SELECT * FROM GroupItems WHERE GroupId='239_65GrkKS6kRL'Additionally, OnBehalfOfContentOwner can optionally be used in the WHERE clause.
GroupId and Resource_Id are required to insert an Item into a Group.
INSERT INTO GroupItems (GroupId, Resource_Id) VALUES ('fjgeeljgio54','dkhgjio5sfff')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The Id that YouTube uses to uniquely identify the channel, video, playlist, or asset that is included in the group. Note that this Id refers specifically to the inclusion of that entity in a particular group and is different than the channel Id, video Id, playlist Id, or asset Id that uniquely identifies the entity itself. |
| Kind | String | False |
Identifies the type of the group item. The value will be youtube#groupItem. |
| Etag | String | False |
The Etag of this item. |
| GroupId | String | False |
The Id that YouTube uses to uniquely identify the group that contains the item. |
| Resource_Kind | String | False |
The type of the group item. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset. |
| Resource_Id | String | False |
The channel, video, playlist, or asset Id that YouTube uses to uniquely identify the group item. |
| OnBehalfOfContentOwner | String | False |
This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. |
Create, update, delete, and query YouTube Analytics Groups.
A Group is a custom collection of up to 200 channels, videos, playlists, or assets. All of the Items in a Group must represent the same type of entity. For example, you cannot create a Group that contains 100 videos and 100 playlists. An Analytics Group can only contain entities that you have uploaded or claimed or that are linked to a channel that you administer. As a result, content owners can create groups of videos, playlists, channels, or assets. Channel owners can create groups of videos and playlists.
The following columns can be used in the WHERE clause: OnBehalfOfContentOwner and Mine.
ContentDetails_ItemType is required to insert a Group.
INSERT INTO Groups (Snippet_Title, ContentDetails_ItemType) VALUES ('test2', 'youtube#channel')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The Id that YouTube uses to uniquely identify the group. |
| Kind | String | False |
Identifies the type of the YouTube Analytics entity. The value will be youtube#group. |
| Etag | String | False |
The Etag of this resource. |
| Snippet_PublishedAt | DateTime | True |
The date and time that the group was created. |
| Snippet_Title | String | False |
The group name. The value must be a nonempty string. |
| ContentDetails_ItemCount | String | False |
The number of items in the group. |
| ContentDetails_ItemType | String | False |
The type of entities that the group contains. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset. |
| Mine | String | False |
Set this to true to retrieve all groups owned by the authenticated user. |
| PageToken | String | False |
The PageToken parameter identifies a specific page in the result set that should be returned. |
| OnBehalfOfContentOwner | String | False |
This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. |
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.
Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.
| Name | Description |
| Activities | Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube. |
| AdPerformanceReports | Query Ad Performance Reports. Ad Performance Reports provide impression-based metrics for ads that ran during video playbacks. These metrics account for each ad impression, and each video playback can yield multiple impressions. |
| Captions | Query YouTube Captions. A Caption resource represents a YouTube caption track. |
| Channels | Query YouTube Channels. |
| ChannelSections | Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature. |
| Comments | Query YouTube Comments. |
| CommentThreads | Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment. |
| Demographics | Query YouTubeAnalytics Demographics grouped by age groups and gender. |
| Devices | Query YouTubeAnalytics Devices or Operating System statistics. This table allows you to aggregate viewing statistics based on the manner in which viewers reached your video content. For example, you can identify the number of views that occurred on mobile devices or game consoles. |
| EngagementReports | Query Engagement Reports info. For example, how many times a user shared a video. |
| Languages | Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language. |
| PlayListItems | Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList. |
| PlayLists | Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users. |
| Regions | Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale. |
| Subscriptions | Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video. |
| TimeBasedReports | Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time. |
| TopVideos | Query the TopVideos for a channel or the TopPlaylists if you are a content owner. You can also use this view to query playback detail and geographic filters. |
| TrafficSources | Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content. |
| VideoAbuseReportReasons | Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content. |
| VideoCategories | Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos. |
| Videos | Query YouTube Videos. |
Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube.
YouTube Analytics allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Home. Additionally, extra optional columns supported are PublishedAt and Region.
All columns support the '=' operator. PublishedAt also supports '>', '>=', '<', and '<='.
By default, if no filters are specified, the driver will return activities generated by authenticated user.
SELECT * FROM Activities WHERE Home = true LIMIT 2 SELECT * FROM Activities WHERE ChannelId = "abc123" AND PublishedAt < '2016-01-01T10:00:00Z'
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the activity. | |||
| PublishedAt | Datetime | The date and time that the activity occurred. The value is in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| ChannelId | String | The Id that YouTube uses to uniquely identify the channel associated with the activity. | |||
| Title | String | The title of the resource primarily associated with the activity. | |||
| Description | String | The description of the resource primarily associated with the activity. | |||
| ChannelTitle | String | Channel title for the channel responsible for this activity. | |||
| Type | String | The type of activity that the resource describes. Valid values: channelItem, comment (not currently returned), favorite, like, playlistItem, recommendation, social, subscription, and upload. | |||
| GroupId | String | The group Id associated with the activity. | |||
| ThumbnailsDefaultUrl | String | The URL of the default image thumbnail. | |||
| UploadVideoId | String | The Id that YouTube uses to uniquely identify the uploaded video. | |||
| LikeResourceIdKind | String | The type of the resource that received a positive (like) rating. | |||
| LikeResourceIdVideoId | String | The Id that YouTube uses to uniquely identify the video, if the rated resource is a video. This column is only present if the ResourceIdKind is youtube#video. | |||
| FavoriteResourceIdKind | String | The type of the YouTube entity marked as a favorite. | |||
| FavoriteResourceIdVideoId | String | The Id that YouTube uses to uniquely identify the favorite video. | |||
| CommentResourceIdKind | String | The comment on the API resource. | |||
| CommentResourceIdVideoId | String | The Id that YouTube uses to uniquely identify the video associated with a comment. | |||
| CommentResourceIdChannelId | String | The Id that YouTube uses to uniquely identify the channel associated with a comment. | |||
| SubscriptionResourceIdKind | String | The type of the subscription. A subscription is a channel that a user subscribed to. | |||
| SubscriptionResourceIdChannelId | String | The Id that YouTube uses to uniquely identify the channel that the user subscribed to. | |||
| PlaylistItemResourceIdKind | String | The type of the playlist item. | |||
| PlaylistItemResourceIdVideoId | String | The Id that YouTube uses to uniquely identify the video that was added to the playlist. | |||
| PlaylistItemPlaylistId | String | The value that YouTube uses to uniquely identify the playlist. | |||
| PlaylistItemPlaylistItemId | String | The value that YouTube uses to uniquely identify the item in the playlist. | |||
| RecommendationResourceIdKind | String | The type of the recommendation. | |||
| RecommendationResourceIdVideoId | String | The Id that YouTube uses to uniquely identify the video, if the recommended resource is a video. | |||
| RecommendationResourceIdChannelId | String | The Id that YouTube uses to uniquely identify the channel, if the recommended resource is a channel. | |||
| RecommendationReason | String | The reason that the YouTube entity was recommended to the user. Valid values for this column : unspecified, videoFavorited, videoLiked, and videoWatched. | |||
| RecommendationSeedResourceIdKind | String | The type of the YouTube entity that caused the recommendation. | |||
| RecommendationSeedResourceIdVideoId | String | The Id that YouTube uses to uniquely identify the video, if the recommendation was caused by a particular video. | |||
| RecommendationSeedResourceIdChannelId | String | The Id that YouTube uses to uniquely identify the channel, if the recommendation was caused by a particular channel. | |||
| RecommendationSeedResourceIdPlaylistId | String | The Id that YouTube uses to uniquely identify the playlist, if the recommendation was caused by a particular playlist. | |||
| SocialType | String | The name of the social network post. Valid values for this column: facebook, googlePlus, twitter, and unspecified. | |||
| SocialResourceIdKind | String | The type of the social network post. | |||
| SocialResourceIdVideoId | String | The Id that YouTube uses to uniquely identify the video featured in a social network post, if the post refers to a video. | |||
| SocialResourceIdChannelId | String | The Id that YouTube uses to uniquely identify the channel featured in a social network post, if the post refers to a channel. | |||
| SocialResourceIdPlaylistId | String | The Id that YouTube uses to uniquely identify the playlist featured in a social network post. | |||
| SocialAuthor | String | The author of the social network post. | |||
| SocialReferenceUrl | String | The URL of the social network post. | |||
| SocialImageUrl | String | An image of the author of the post. | |||
| ChannelItemResourceId | String | The Id of the YouTube entity that was added to the channel. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Region | String | Instructs the API to filter by region. The parameter value is an ISO 3166-1 alpha-2 country code. |
Query Ad Performance Reports. Ad Performance Reports provide impression-based metrics for ads that ran during video playbacks. These metrics account for each ad impression, and each video playback can yield multiple impressions.
Get GrossRevenue for a video in a specific country grouped by ad type and day:
SELECT Country, AdType, Day, GrossRevenue, StartDate, EndDate FROM AdPerformanceReports WHERE video='vid123' AND continent = '019'
Ad performance reports for content owners:
| Dimensions | Required | adType |
| Optional | day | |
| Metrics | Use 1 or more | grossRevenue,adImpressions,cpm |
| Filter | Use exactly one | video, group, or a supported combination of uploaderType and claimedStatus |
| Use 0 or one | country,continent,subContinent |
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Video | String | True | The Id of a YouTube video. | ||
| Group | String | True | (filter only) The Id of a YouTube Analytics group. | ||
| Country | String | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |||
| Continent | String | (filter only) A United Nations (U.N.) statistical region code. The allowed values are 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |||
| SubContinent | String | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |||
| AdType | String | True | The AdType dimension is used in ad performance reports and aggregates the requested metrics based on the types of ads that ran during video playbacks: auctionDisplay, auctionInstream, auctionTrueviewInslate, auctionTrueviewInstream, auctionUnknown, reservedClickToPlay, reservedDisplay, reservedInstream, reservedInstreamSelect, reservedMasthead, reservedUnknown. | ||
| Day | String | True | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | ||
| ClaimedStatus | String | (only used in content owner reports) This dimension lets you indicate that a result set should only contain metrics for claimed content. The allowed value is claimed. | |||
| UploaderType | String | (only used in content owner reports) This dimension lets you indicate whether a result set should contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |||
| GrossRevenue | Decimal | False | The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements. | ||
| Cpm | Decimal | False | The estimated gross revenue per thousand ad impressions. | ||
| AdImpressions | Double | False | The number of verified ad impressions served. | ||
| StartDate | Date | Start date for fetching Analytics data. | |||
| EndDate | Date | End date for fetching Analytics data. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Segments | String | Segments the data returned for your request. Either a SegmentId or a custom segment. |
Query YouTube Captions. A Caption resource represents a YouTube caption track.
YouTube Analytics allows only a subset of columns to be used as filter criteria. The VideoId column must be specified. Extra optional columns supported are Id and OnBehalfOfContentOwner.
All columns support the '=' operator.
SELECT * FROM Captions WHERE VideoId = '123456789'
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the caption track. | |||
| VideoId | String | The Id that YouTube uses to uniquely identify the video associated with the caption track. | |||
| LastUpdated | Datetime | The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| TrackKind | String | The type of the caption track. Valid values for this column: ASR (a caption track generated using automatic speech recognition); Forced (a caption track that plays when no other track is selected in the player. For example, a video that shows aliens speaking in an alien language might have a forced caption track to only show subtitles for the alien language); standard (a regular caption track. This is the default value). | |||
| Language | String | The language of the caption track. The column value is a BCP-47 language tag. | |||
| Name | String | The name of the caption track. The name is intended to be visible to the user as an option during playback. | |||
| AudioTrackType | String | The type of audio track associated with the caption track. Valid values for this column: commentary (the caption track corresponds to an alternate audio track that includes commentary, such as director commentary); descriptive (the caption track corresponds to an alternate audio track that includes additional descriptive audio); primary (the caption track corresponds to the primary audio track for the video, which is the audio track normally associated with the video); unknown (this is the default value). | |||
| IsCC | Boolean | Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false. | |||
| IsLarge | Boolean | Indicates whether the caption track uses large text for the vision-impaired. The default value is false. | |||
| IsEasyReader | Boolean | Indicates whether the caption track is formatted for easy reader, meaning it is at a third-grade level for language learners. The default value is false. | |||
| IsDraft | Boolean | Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. | |||
| IsAutoSynced | Boolean | Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions. | |||
| Status | String | The status of the caption track. Valid values for this column: failed, serving, syncing. | |||
| FailureReason | String | The reason that YouTube failed to process the caption track. Valid values: processingFailed (YouTube failed to process the uploaded caption track); unknownFormat (the format of the caption track was not recognized); unsupportedFormat (the format of the caption track is not supported). |
Query YouTube Channels.
By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube Analytics if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
By default, if no filters are specified, the driver will return all channels owned by the authenticated user.
YouTube Analytics allows only a subset of columns to be used as filter criteria. The channels can be filtered by the Id. Extra optional columns supported are Language and ChannelId.
A search against all channels in YouTube Analytics may be triggered by specifying one or more of SearchTerms, ChannelId, Region, SafeSearch, Rating, or Relevance to search all channels.
All columns support the '=' operator. 'PublishedAt', also supports '>', '>=', '<', and '<='.
Order by is supported for the Rating, Relevance, and Title columns.
SELECT * FROM Channels WHERE Id = 'abc123' SELECT * FROM Channels WHERE ChannelId = 'abc123' AND SearchTerms = 'music|movies-horror' ORDER BY Rating LIMIT 10
Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the channel. | |||
| Title | String | The title of the channel. | |||
| Description | String | The description of the channel. The value of the column has a maximum length of 1000 characters. | |||
| CustomUrl | String | The channel's custom URL. | |||
| PublishedAt | Datetime | The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| ThumbnailsDefaultUrl | String | The URL of the default image thumbnail. | |||
| DefaultLanguage | String | This column is confidential to trusted testers. | |||
| LiveBroadcastContent | String | An indication of whether a video or channel resource has live broadcast content. | |||
| LocalizedTitle | String | This column is confidential to trusted testers. The localized video title. | |||
| LocalizedDescription | String | This column is confidential to trusted testers. The localized video description. | |||
| Country | String | The country with which the channel is associated. | |||
| ViewCount | Long | The number of times the channel has been viewed. | |||
| SubscriberCount | Long | The number of subscribers that the channel has. This value is rounded down to three significant figures. | |||
| HiddenSubscriberCount | Boolean | Indicates whether the subscriber count of the channel is publicly visible. | |||
| VideoCount | Long | The number of videos uploaded to the channel. | |||
| RelatedPlaylistsLikes | String | The Id of the playlist that contains the liked videos of the channel. | |||
| RelatedPlaylistsUploads | String | The Id of the playlist that contains the uploaded videos of the channel. | |||
| PrivacyStatus | String | Privacy status of the channel. Valid values for this column: private, public, unlisted. | |||
| IsLinked | Boolean | Indicates whether the channel data identifies a user who is already linked to either a YouTube username or a Google+ account. A user who has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos. | |||
| LongUploadsStatus | String | Indicates whether the channel is eligible to upload videos that are more than 15 minutes long. This column is only returned if the channel owner authorized the API request. See the YouTube Help Center for more information about this feature. | |||
| MadeForKids | Boolean | This value indicates whether the channel is designated as child-directed, and it contains the current 'made for kids' status of the channel. | |||
| Keywords | String | Keywords associated with your channel. The value is a space-separated list of strings. | |||
| TrackingAnalyticsAccountId | String | The Id for a Google Analytics account that you want to use to track and measure traffic to your channel. | |||
| ModerateComments | Boolean | This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false. | |||
| SearchTerms | String | The SearchTerms parameter specifies the query term to search for. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ForUsername | String | The username associated with the channel. |
| Language | String | Retrieve localized resource metadata for a specific application language that the YouTube website supports. |
| Language | String | Retrieve localized resource metadata for a specific application language that the YouTube website supports. |
| ManagedByMe | String | This parameter is intended exclusively for YouTube content partners. Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. |
| OnBehalfOfContentOwner | String | This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| ChannelId | String | The Id that YouTube uses to uniquely identify a channel. |
| Region | String | The country associated with the channel. |
| SafeSearch | String | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. |
| Rating | String | Resources are sorted from highest to lowest rating. |
| Relevance | String | Resources are sorted based on their relevance to the search query. This is the default value for this parameter. |
Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature.
YouTube Analytics allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are Language and OnBehalfOfContentOwner.
All columns support the '=' operator.
By default, if no channel id is specified, the driver will return channel sections for the channel owned by authenticated user.
SELECT * FROM ChannelSections WHERE ChannelId = '123456789'
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the channel section. | |||
| Type | String | The type of the channel section. | |||
| ChannelId | String | The Id that YouTube uses to uniquely identify the channel. | |||
| Title | String | The title of the section. | |||
| Position | Integer | The position of the section on the channel page. | |||
| PlaylistsAggregate | String | A list of one or more playlist Ids that are featured in a channel section. You must specify a list of playlist Ids if the type of the ChannelSection is either singlePlaylist or multiplePlaylists, and this column should not be specified for other types of sections. If the type is singlePlaylist, this list must specify exactly one playlist Id. | |||
| ChannelsAggregate | String | A list of one or more channel Ids that are featured in a channel section. You must specify a list of channel Ids if the Type of the ChannelSection is multipleChannels, and this column should not be specified for other types of sections. You cannot include your own channel in the list. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Language | String | Retrieve localized resource metadata for a specific application language that the YouTube website supports. |
| OnBehalfOfContentOwner | String | This parameter is intended exclusively for YouTube content partners. |
Query YouTube Comments.
YouTube Analytics allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: Id or ParentId. Extra optional columns supported are TextFormat.
All columns support the '=' operator.
SELECT * FROM Comments WHERE Id = '123456789'
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the comment. | |||
| ChannelId | String | The Id of the YouTube channel associated with the comment. If the comment is a video comment, then this column identifies the channel of the video, and the VideoId column identifies the video. If the comment is a channel comment, then this column identifies the channel that the comment is about. | |||
| VideoId | String | The Id of the video that the comment refers to. | |||
| TextDisplay | String | The text of the comment. The text can be retrieved in either plaintext or HTML. The TextFormat pseudo column specifies the desired text format. | |||
| TextOriginal | String | The original, raw text of the comment as it was initially posted or last updated. The original text is only returned if it is accessible to the authenticated user, which is only guaranteed if the user is the author of the comment. | |||
| ParentId | String | The unique Id of the parent comment. This column value is only set if the comment was submitted as a reply to another comment. | |||
| AuthorDisplayName | String | The display name of the user who posted the comment. | |||
| AuthorProfileImageUrl | String | The URL for the avatar of the user who posted the comment. | |||
| AuthorChannelUrl | String | The URL of the YouTube channel of the comment author, if available. | |||
| AuthorChannelIdValue | String | The Id of the YouTube channel of the comment author, if available. | |||
| AuthorGoogleplusProfileUrl | String | The URL of the Google+ profile of the comment author, if available. | |||
| CanRate | Boolean | This setting indicates whether the current viewer can rate the comment. | |||
| ViewerRating | String | The rating the viewer has given to this comment. Valid values for this column: like, none. Note that this column does not currently identify dislike ratings. The column value is like if the viewer has rated the comment positively. The value is none in all other cases, including the user having given the comment a negative rating or not having rated the comment. | |||
| LikeCount | Integer | The total number of likes (positive ratings) the comment has received. | |||
| ModerationStatus | String | The moderation status of the comment. This value is only returned if the API request was authorized by the owner of the channel or the video on which the requested comments were made. In addition, note that this value is not set if the query filtered on the Id column. Valid values: heldForReview, likelySpam, published, rejected. | |||
| PublishedAt | Datetime | The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| UpdatedAt | Datetime | The date and time when the comment was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| TextFormat | String | This parameter indicates whether the API should return comments formatted as HTML or as plaintext. |
Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment.
YouTube Analytics allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: AllThreadsRelatedToChannelId, ChannelId, Id, or VideoId.
Extra optional columns supported are ModerationStatus, SearchTerms, and TextFormat. All columns support the '=' operator.
Order is supported for CommentThreads. Relevance are the supported order columns.
SELECT * FROM CommentThreads WHERE VideoId = 'abcdef123456' ORDER BY Relevance DESC LIMIT 10
Note: Ordering is not supported for use in conjunction with the Id parameter.
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the comment thread. | |||
| ChannelId | String | The YouTube channel that is associated with the comments in the thread. The VideoId column identifies the video. If the comments are about a video, then the value identifies the channel that uploaded the video. If the comments refer to the channel itself, the VideoId column will not have a value. | |||
| VideoId | String | The Id of the video that the comments refer to, if any. If this column is not present or does not have a value, then the thread applies to the channel and not to a specific video. | |||
| TopCommentId | String | The Id of the top-level comment of the thread. | |||
| PublishedAt | Datetime | The publish date of the top-level comment of the thread. | |||
| UpdatedAt | Datetime | The last update date of the top-level comment of the thread. | |||
| TopCommentChannelId | String | The Id of the channel associated with the top-level comment of the thread. | |||
| TopCommentVideoId | String | The Id of the video associated with the top-level comment of the thread. | |||
| TopCommentTextDisplay | String | The display text of the top-level comment of the thread. | |||
| TopCommentTextOriginal | String | The original text of the top-level comment of the thread. | |||
| TopCommentParentId | String | The Id of the parent of the top-level comment of the thread. | |||
| TopCommentAuthorDisplayName | String | The display name of the author of the top-level comment of the thread. | |||
| TopCommentAuthorChannelIdValue | String | The Id of the channel of the author of the top-level comment of the thread. | |||
| TopCommentCanRate | Boolean | Whether the current user can rate the top-level comment of the thread. | |||
| TopCommentViewerRating | String | The viewer rating of the top-level comment of the thread. | |||
| TopCommentLikeCount | Integer | The like count of the top-level comment of the thread. | |||
| TopCommentModerationStatus | String | The moderation status of the top-level comment of the thread. | |||
| CanReply | Boolean | This setting indicates whether the current viewer can reply to the thread. | |||
| TotalReplyCount | Integer | The total number of replies that have been submitted in response to the top-level comment. | |||
| IsPublic | Boolean | This setting indicates whether the thread, including all of its comments and comment replies, is visible to all YouTube users. | |||
| CommentsAggregate | String | A list of one or more replies to the top-level comment. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| AllThreadsRelatedToChannelId | String | Instructs the API to return all comment threads associated with the specified channel. |
| ModerationStatus | String | Set this parameter to limit the returned comment threads to a particular moderation state. |
| TextFormat | String | Set the value of this parameter to HTML or plainText. |
Query YouTubeAnalytics Demographics grouped by age groups and gender.
Aggregate viewing statistics for videos based on viewers' age group and gender:
SELECT * FROM Demographics
Trim down Demographics for just one Video:
SELECT * FROM Demographics WHERE Video = 'video_Id'
Aggregate viewing statistics for playlists based on viewers' age group and gender:
SELECT * FROM Demographics WHERE IsCurated=true
You can use the following tables to build other queries to Top Videos.
Demographics for videos:
| Dimensions | Use 1 or more | ageGroup,gender,video |
| Use 0 or more | liveOrOnDemand,subscribedStatus,youtubeProduct | |
| Metrics | Use 1 or more | viewerPercentage |
| Filter | Use 0 or one | country,province,continent,subContinent |
| Use 0 or one | video,group | |
| Use 0 or more | liveOrOnDemand,subscribedStatus,youtubeProduct |
Demographics for playlists:
| Dimensions | Use 1 or more | ageGroup,gender |
| Use 0 or more | subscribedStatus,youtubeProduct | |
| Metrics | Required | viewerPercentage |
| Filter | Required | isCurated=true |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or one | video,group | |
| Use 0 or more | subscribedStatus,youtubeProduct |
Demographics for content owners:
| Dimensions | Use 1 or more | ageGroup,gender |
| Use 0 or more | liveOrOnDemand,subscribedStatus,youtubeProduct | |
| Metrics | Use 1 or more | viewerPercentage |
| Filter | Use exactly one | video,channel,group |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or more | liveOrOnDemand,subscribedStatus,youtubeProduct |
Demographics for content owner playlists:
| Dimensions | Use 1 or more | ageGroup,gender |
| Use 0 or more | subscribedStatus,youtubeProduct | |
| Metrics | Required | viewerPercentage |
| Filter | Required | isCurated=true |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or one | playlist,channel,group | |
| Use 0 or more | subscribedStatus,youtubeProduct |
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Video | String | True | False | The Id of a YouTube video. | |
| Playlist | String | True | The Id of a YouTube playlist. | ||
| Group | String | True | (filter only) The Id of a YouTube Analytics group. | ||
| Country | String | True | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | ||
| Province | String | True | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | ||
| Continent | String | True | (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. | ||
| SubContinent | String | True | (filter only) A U.N. statistical region code that identifies a geographical subregion. | ||
| LiveOrOnDemand | String | True | This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND. | ||
| SubscribedStatus | String | True | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | ||
| YoutubeProduct | String | True | This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN. | ||
| IsCurated | Boolean | True | This filter indicates that the request is retrieving data about video views that occurred in the context of a playlist. This filter is required for any playlist report and its value must be set to 1. | ||
| ClaimedStatus | String | True | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | ||
| UploaderType | String | True | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | ||
| AgeGroup | String | True | True | This dimension identifies the age group of the logged-in users associated with the report data. The allowed values are age13-17, age18-24, age25-34, age35-44, age45-54, age55-64, age65- | |
| Gender | String | True | False | This dimension identifies the gender of the logged-in users associated with the query. The allowed values are female, male and user_specified. | |
| ViewerPercentage | Double | False | True | The percentage of viewers who were logged in when watching the video or playlist. The viewerPercentage values in this report are not normalized for different values or combinations of values for playback detail dimensions (subscribedStatus and youtubeProduct). For example, a report that uses the subscribedStatus dimension returns viewerPercentage data adding up to 100 percent for subscribed views and viewerPercentage data adding up to 100 percent for unsubscribed views. (The total value of all viewerPercentage fields in the report is 200 percent.) You can use filters to ensure that the report only contains viewerPercentage data for one value (or combination of values) for playback detail dimensions. | |
| StartDate | Date | Start date for fetching Analytics data. | |||
| EndDate | Date | End date for fetching Analytics data. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Segments | String | Segments the data returned for your request. Either a SegmentId or a custom segment. |
Query YouTubeAnalytics Devices or Operating System statistics. This table allows you to aggregate viewing statistics based on the manner in which viewers reached your video content. For example, you can identify the number of views that occurred on mobile devices or game consoles.
By default, grouping is done by Device Type:
SELECT * FROM Devices
However, you can group views by other dimensions such as Operating System:
SELECT OperatingSystem, Views, EstimatedMinutesWatched FROM DevicesNotice that you cannot mix both Device Type and Operating System in the same query due to limitations in the YouTube Analytics API.
You can use the following tables to build other queries to Devices:
Devices for videos:
| Dimensions | Use exactly one | deviceType,operatingSystem |
| Use 0 or more | day,liveOrOnDemand,subscribedStatus,youtubeProduct | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched |
| Filter | Use 0 or one | country,province,continent,subContinent |
| Use 0 or one | video,group | |
| Use 0 or more | operatingSystem,liveOrOnDemand,subscribedStatus,youtubeProduct |
Device data for playlists:
| Dimensions | Use exactly one | deviceType,operatingSystem |
| Use 0 or more | day,subscribedStatus,youtubeProduct | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist |
| Filter | Required | isCurated=true |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or one | playlist,channel,group | |
| Use 0 or more | operatingSystem,subscribedStatus,youtubeProduct |
Device data for content owners:
| Dimensions | Required | deviceType |
| Use 0 or more | day,liveOrOnDemand,subscribedStatus,youtubeProduct | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched |
| Filter | Use exactly one | video,channel,group |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or more | operatingSystem,liveOrOnDemand,subscribedStatus,youtubeProduct |
Device data for content owner playlists:
| Dimensions | Required | deviceType |
| Use 0 or more | day,subscribedStatus,youtubeProduct | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist |
| Filters | Required | isCurated=true |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or one | playlist,channel,group | |
| Use 0 or more | operatingSystem,subscribedStatus,youtubeProduct |
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Video | String | True | The Id of a YouTube video. | ||
| Group | String | True | (filter only) The Id of a YouTube Analytics group. | ||
| Channel | String | True | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | ||
| Playlist | String | True | The Id of a YouTube playlist. | ||
| Country | String | True | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | ||
| Province | String | True | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | ||
| Continent | String | True | (filter only) A United Nations (U.N.) statistical region code: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | ||
| SubContinent | String | True | (filter only) A U.N. statistical region code that identifies a geographical subregion. | ||
| Day | String | True | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | ||
| LiveOrOnDemand | String | True | This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND. | ||
| SubscribedStatus | String | True | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | ||
| YoutubeProduct | String | True | This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN. | ||
| DeviceType | String | True | True | This dimension identifies the physical form factor of the device on which the view occurred. The allowed values are DESKTOP, GAME_CONSOLE, MOBILE, TABLET, TV, UNKNOWN_PLATFORM. | |
| OperatingSystem | String | True | False | This dimension identifies the software system of the device on which the view occurred. The allowed values are ANDROID, BADA, BLACKBERRY, DOCOMO, HIPTOP, IOS, LINUX, MACINTOSH, MEEGO, NINTENDO_3DS, OTHER, PLAYSTATION, PLAYSTATION_VITA, SMART_TV, SYMBIAN, WEBOS. | |
| IsCurated | Boolean | True | This filter indicates that the request is retrieving data about video views that occurred in the context of a playlist. This filter is required for any playlist report and its value must be set to 1. | ||
| ClaimedStatus | String | True | (only used in content owner reports) This dimension lets you indicate that the result set will only contain metrics for claimed content. The allowed value is claimed. | ||
| UploaderType | String | True | (only used in content owner reports) This dimension lets you indicate whether the result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | ||
| Views | Double | False | True | The number of times that a video was viewed. | |
| EstimatedMinutesWatched | Double | False | True | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| PlaylistStarts | Double | False | False | The number of times that viewers initiated playback of a playlist. | |
| ViewsPerPlaylistStart | Double | False | False | The average number of video views that occurred each time a playlist was initiated. | |
| AverageTimeInPlaylist | Double | False | False | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. | |
| StartDate | Date | Start date for fetching Analytics data. | |||
| EndDate | Date | End date for fetching Analytics data. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Segments | String | Segments the data returned for your request. Either a SegmentId or a custom segment. |
Query Engagement Reports info. For example, how many times a user shared a video.
By default, results are grouped by Day. The following query returns Comments, Likes, Dislikes, etc., grouped by Day:
SELECT * FROM EngagementReports
The following query returns how frequently the channel's videos were shared on different social platforms:
SELECT SharingService, Shares FROM EngagementReportsYou can use the following tables to build other queries to Engagement Reports:
Engagement Reports for videos:
| Dimensions | Required | sharingService |
| Optional | subscribedStatus | |
| Metrics | Use 1 or more | shares |
| Filter | Use 0 or one | country,continent,subContinent |
| Use 0 or one | video,group | |
| Optional | subscribedStatus |
Engagement Reports for content owners:
| Dimensions | Required | sharingService |
| Optional | subscribedStatus | |
| Metrics | Use 1 or more | shares |
| Filter | Use exactly one | video,channel,group |
| Use 0 or one | country,continent,subContinent | |
| Optional | subscribedStatus |
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| SharingService | String | True | This dimension identifies the service that was used to share videos. Videos can be shared on YouTube (or via the YouTube player) using the Share button. | ||
| Channel | String | True | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | ||
| Video | String | True | The Id of a YouTube video. | ||
| Group | String | True | (filter only) The Id of a YouTube Analytics group. | ||
| Country | String | True | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | ||
| Continent | String | True | (filter only) A United Nations (U.N.) statistical region code: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | ||
| SubContinent | String | True | (filter only) A U.N. statistical region code that identifies a geographical subregion. | ||
| SubscribedStatus | String | True | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | ||
| ClaimedStatus | String | True | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | ||
| UploaderType | String | True | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | ||
| Shares | Double | False | True | The number of times that users shared a video through the Share button. | |
| StartDate | Date | Start date for fetching Analytics data. | |||
| EndDate | Date | End date for fetching Analytics data. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Segments | String | Segments the data returned for your request. Either a SegmentId or a custom segment. |
Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language.
There are no required filters for this table. An optional column supported is Language.
All columns support the '=' operator.
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the i18n language. | |||
| Language | String | A BCP-47 code that uniquely identifies a language. | |||
| Name | String | The name of the language as it is written in that language. |
Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList.
You must specify exactly one of the following columns in the WHERE clause: Id or PlayListId. Extra optional columns supported are OnBehalfOfContentOwner and VideoId.
All columns support the '=' operator.
SELECT * FROM PlaylistItems WHERE PlaylistId = 'abcdef123456'
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the playlist item. | |||
| PublishedAt | Datetime | The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| ChannelId | String | The Id that YouTube uses to uniquely identify the user that added the item to the playlist. | |||
| Title | String | The title of the item. | |||
| Description | String | The description of the item. | |||
| ThumbnailsDefaultUrl | String | The URL of the item. | |||
| ChannelTitle | String | The channel title of the channel that the playlist item belongs to. | |||
| VideoOwnerChannelTitle | String | The channel title of the channel that uploaded this video. | |||
| VideoOwnerChannelId | String | The channel ID of the channel that uploaded this video. | |||
| PlaylistId | String | The Id that YouTube uses to uniquely identify the playlist that the playlist item is in. | |||
| Position | String | The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth. | |||
| ResourceIdKind | String | The kind, or type, of the referred resource. | |||
| ResourceIdVideoId | String | If the ResourceIdKind value of the column is youtube#video, then this column will be present and its value will contain the Id that YouTube uses to uniquely identify the video in the playlist. | |||
| VideoId | String | The Id that YouTube uses to uniquely identify a video. To retrieve the video resource, set the Id column to this value. | |||
| Note | String | A user-generated note for this item. | |||
| VideoOwnerPublishedAt | Datetime | The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| PrivacyStatus | String | The privacy status of the playlist item. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| OnBehalfOfContentOwner | String | This parameter is intended exclusively for YouTube content partners. |
Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users.
By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube Analytics if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
By default, if no filters are specified, the CData Cloud will return all playlists for the channel owned by authenticated user.
YouTube Analytics allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are PublishedAt, Language, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel.
A search against all channels in YouTube Analytics may be triggered by specifying one or more of SearchTerms, ForContentOwner, Region, SafeSearch, Rating and Rating to search all playlists.
All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='.
Order by is supported for the Rating, Relevance, and Title columns.
SELECT * FROM PlayLists WHERE Id = 'abcdef123456' SELECT title FROM PlayLists WHERE PublishedAt >= '2016-01-01' ORDER BY Title LIMIT 10
Note: Ordering is not supported when specifying one of the colums used for searching playlists such as SearchTerms.
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the playlist. | |||
| PublishedAt | Datetime | The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| ChannelId | String | The Id that YouTube uses to uniquely identify the channel that published the playlist. | |||
| Title | String | The title of the playlist. | |||
| Description | String | The description of the playlist. | |||
| ThumbnailsDefaultUrl | String | The URL of the image. | |||
| ChannelTitle | String | Channel title of the channel that the video belongs to. | |||
| DefaultLanguage | String | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |||
| LocalizedTitle | String | This column is confidential to trusted testers. The localized playlist title. | |||
| LocalizedDescription | String | This column is confidential to trusted testers. The localized playlist description. | |||
| PrivacyStatus | String | The privacy status of the playlist. Valid values for this column: private, public, unlisted. | |||
| VideoCount | Integer | The number of videos in the playlist. | |||
| EmbedHtml | String | An iframe tag that embeds a player that will play the playlist. | |||
| SearchTerms | String | The SearchTerms parameter specifies the query term to search for. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Language | String | A value of hl instructs the API to retrieve localized resource metadata for a specific application language that the YouTube supports. |
| OnBehalfOfContentOwner | String | This parameter is intended exclusively for YouTube content partners. |
| OnBehalfOfContentOwnerChannel | String | Specifies the YouTube channel Id of the channel to which a video is being added. |
| ForContentOwner | String | Restricts the search to only retrieve playlists owned by the content owner specified by the OnBehalfOfContentOwner column. |
| Region | String | Instructs the API to return search results for the specified country. |
| SafeSearch | String | Indicates whether the search results should include restricted content as well as standard content. Valid values: moderate, none, or strict. |
| Rating | String | Specifies that playlists are sorted from highest to lowest rating. |
Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale.
There are no required filters for this table. An optional column supported is Language.
All columns support the '=' operator.
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the i18n region. | |||
| Country | String | The two-letter ISO country code that identifies the region. | |||
| Name | String | The name of the region. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Language | String | The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US. |
Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video.
You can specify exactly one of the following columns: ChannelId, Id, MyRecentSubscribers, or MySubscribers.
Extra optional columns supported are ForChannelId, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel. All columns support the '=' operator.
Order is supported for Subscriptions. 'Alphabetical', 'Relevance', and 'Unread' are the supported order columns.
By default, if no filters are specified, the driver will return a list of channels subscribed by authenticated user.
SELECT Title FROM Subscriptions WHERE ChannelId = 'abc123' ORDER BY Unread DESC
The default value is SUBSCRIPTION_ORDER_RELEVANCE.
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the subscription. | |||
| PublishedAt | Datetime | The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| ChannelTitle | String | The title of the channel that the subscription belongs to. | |||
| Title | String | The title of the subscription. | |||
| Description | String | The details of the subscription. | |||
| ResourceIdKind | String | The type of the API resource. | |||
| ResourceIdChannelId | String | The value that YouTube uses to uniquely identify the channel that the user subscribed to. | |||
| ChannelId | String | The Id that YouTube uses to uniquely identify the channel of the subscriber. | |||
| ThumbnailsDefaultUrl | String | The URL of the default image. | |||
| TotalItemCount | Integer | The approximate number of items that the subscription points to. | |||
| NewItemCount | Integer | The number of new items in the subscription since its content was last read. | |||
| ActivityType | String | The type of activity this subscription is for. Valid values: all, uploads. | |||
| SubscriberTitle | String | The title of the channel of the subscriber. | |||
| SubscriberDescription | String | The description of the channel of the subscriber. | |||
| SubscriberChannelId | String | The Id that YouTube assigns to uniquely identify the channel of the subscriber. | |||
| SubscriberThumbnailsDefaultUrl | String | The URL of the default image. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| MySubscribers | String | Set this value of this parameter to true to retrieve a feed of the subscribers of the authenticated user. |
| ForChannelId | String | The ForChannelId column specifies a comma-separated list of channel Ids. |
| OnBehalfOfContentOwner | String | This column is intended exclusively for YouTube content partners. |
| OnBehalfOfContentOwnerChannel | String | Specifies the YouTube ChannelId of the channel to which a video is being added. |
| Alphabetical | String | Sort alphabetically |
| Relevance | String | Sort by relevance. |
| Unread | String | Sort by order of activity. |
Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time.
| Dimensions | Use 0 or more | day, month, video |
| Metrics | Use 1 or more | views, comments, likes, dislikes, videosAddedToPlaylists, videosRemovedFromPlaylists, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, subscribersGained, subscribersLost, uniques, earnings, adEarnings, grossRevenue, redPartnerRevenue, monetizedPlaybacks, playbackBasedCpm, impressions, impressionBasedCpm |
| Filter | Use 0 or one | country, continent, subContinent |
| Use 0 or one | video, group |
Timebased Reports for playlist rules:
| Dimensions | Use exactly one | day, month |
| Use 0 or more | subscribedStatus, youtubeProduct | |
| Metrics | Use 1 or more | views, estimatedMinutesWatched, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist |
| Filter | Required | isCurated=true |
| Use 0 or one | country, province, continent, subContinent | |
| Use 0 or one | playlist, channel, group | |
| Use 0 or more | subscribedStatus, youtubeProduct |
Timebased Reports for content owner rules:
| Dimensions | Use exactly one | day, month |
| Metrics | Use 1 or more | views, comments, likes, dislikes, videosAddedToPlaylists, videosRemovedFromPlaylists, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, subscribersGained, subscribersLost, uniques, earnings, adEarnings, grossRevenue, redPartnerRevenue, monetizedPlaybacks, playbackBasedCpm, impressions, impressionBasedCpm |
| Filter | Use exactly one | video, channel, group |
| Use 0 or one | country, continent, subContinent |
Timebased Reports for content owner playlist rules:
| Dimensions | Use exactly one | day, month |
| Use 0 or more | subscribedStatus, youtubeProduct | |
| Metrics | Use 1 or more | views, estimatedMinutesWatched, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylis |
| Filter | Required | isCurated=true |
| Use 0 or one | country, province, continent, subContinent | |
| Use 0 or one | playlist, channel, group | |
| Use 0 or more | subscribedStatus, youtubeProduct |
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Channel | String | True | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | ||
| Video | String | True | The Id of a YouTube video. | ||
| Group | String | True | (filter only) The Id of a YouTube Analytics group. | ||
| Playlist | String | True | The Id of a YouTube playlist. | ||
| Country | String | True | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | ||
| Province | String | True | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | ||
| Continent | String | True | (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | ||
| SubContinent | String | True | (filter only) A U.N. statistical region code that identifies a geographical subregion. | ||
| Day | String | True | True | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | |
| Month | String | True | Data in the report is aggregated by calendar month. In the report, dates are listed in YYYY-MM format. Note: If your SQL query uses the Month dimension, then the StartDate and EndDate parameters must both be set to the first day of the month. | ||
| IsCurated | Boolean | True | This filter indicates that the request is retrieving data about video views that occurred in the context of a playlist. This filter is required for any playlist report and its value must be set to 1. | ||
| ClaimedStatus | String | True | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | ||
| UploaderType | String | True | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | ||
| SubscribedStatus | String | True | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | ||
| YoutubeProduct | String | True | This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN. | ||
| Views | Double | False | True | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| ViewerPercentage | Double | False | False | The percentage of viewers who were logged in when watching the video or playlist. | |
| EstimatedMinutesWatched | Double | False | True | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| AverageViewDuration | Double | False | True | The average length, in seconds, of video playbacks. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageViewPercentage | Double | False | True | The average percentage of a video watched during a video playback. | |
| Comments | Double | False | True | The number of times that users commented on a video. | |
| Likes | Double | False | True | The number of times that users indicated that they liked a video by giving it a positive rating. | |
| Dislikes | Double | False | True | The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy. | |
| Shares | Double | False | True | The number of times that users shared a video through the Share button. | |
| SubscribersGained | Double | False | True | The number of times that users subscribed to a channel or video. | |
| SubscribersLost | Double | False | True | The number of times that users unsubscribed from a channel or video. | |
| VideosAddedToPlaylists | Double | False | True | The number of times that videos were added to the video owner playlist or other channel playlists like the Watch Later playlist. Channel uploads playlists and user watch history are not reported. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, and then adds it again, the metric value reflects the video being added to a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| VideosRemovedFromPlaylists | Double | False | True | The number of times that videos were removed from the video owner playlist and other YouTube playlists like the Watch Later playlist. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, adds it again, and then removes it again, the metric value reflects the video being removed from a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| PlaylistStarts | Double | False | False | The number of times that viewers initiated playback of a playlist. | |
| ViewsPerPlaylistStart | Double | False | False | The average number of video views that occurred each time a playlist was initiated. | |
| AverageTimeInPlaylist | Double | False | False | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. | |
| AnnotationImpressions | Double | False | True | The total number of annotation impressions. | |
| AnnotationClickableImpressions | Double | False | True | The number of annotations that appeared and could be clicked. | |
| AnnotationClicks | Double | False | True | The number of clicked annotations. | |
| AnnotationClickThroughRate | Double | False | True | The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. | |
| AnnotationClosableImpressions | Double | False | True | The number of annotations that appeared and could be closed. | |
| AnnotationCloses | Double | False | True | The number of closed annotations. | |
| AnnotationCloseRate | Double | False | True | The ratio of annotations that viewers closed to the total number of annotation impressions. | |
| EstimatedRevenue | Decimal | False | False | The total estimated earnings (net revenue) from all Google-sold advertising sources as well as from nonadvertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| EstimatedAdRevenue | Decimal | False | False | The total estimated earnings (net revenue) from all Google-sold advertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| EstimatedRedPartnerRevenue | Decimal | False | False | The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The value of the metric reflects earnings from both music and nonmusic content and is subject to month-end adjustment. | |
| GrossRevenue | Decimal | False | False | The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements. | |
| Cpm | Decimal | False | False | The estimated gross revenue per thousand ad impressions. | |
| AdImpressions | Double | False | False | The number of verified ad impressions served. | |
| MonetizedPlaybacks | Double | False | False | The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ±2.0%. | |
| PlaybackBasedCpm | Decimal | False | False | The estimated gross revenue per thousand playbacks. | |
| StartDate | Date | Start date for fetching Analytics data. | |||
| EndDate | Date | End date for fetching Analytics data. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Segments | String | Segments the data returned for your request. Either a SegmentId or a custom segment. |
Query the TopVideos for a channel or the TopPlaylists if you are a content owner. You can also use this view to query playback detail and geographic filters.
The following query returns a channel's top videos by most minutes watched:
SELECT * FROM TopVideos
The following query returns a channel's top videos by most minutes watched in a specific country:
SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country = 'US'
The following query returns a channel's top playlists by most minutes watched:
SELECT Playlist, Views, EstimatedMinutesWatched, PlaylistStarts, AverageViewDuration FROM TopVideos WHERE IsCurated=true
You can use the following tables to build other queries to Top Videos:
Top Videos for videos:
| Dimensions | Required | video |
| Metrics | Use 1 or more | views,comments,likes,dislikes,videosAddedToPlaylists,videosRemovedFromPlaylists,shares,estimatedMinutesWatched,averageViewDuration,averageViewPercentage,annotationClickThroughRate,annotationCloseRate,annotationImpressions,annotationClickableImpressions,annotationClosableImpressions,annotationClicks,annotationCloses,subscribersGained,subscribersLost |
| Filter | Use 0 or one | country,continent,subContinent |
| Sort | Use 0 or more (only descending order) | views,estimatedMinutesWatched,subscribersGained,subscribersLost |
Top Videos for playlists:
| Dimensions | Required | playlist |
| Metrics | Use 1 or more | views,estimatedMinutesWatched,averageViewDuration,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist |
| Filter | Required | isCurated=true |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or more | playlist,subscribedStatus,youtubeProduct | |
| Sort | Use 0 or more (only descending order) | views,estimatedMinutesWatched,playlistStarts |
Top Videos for content owners:
| Dimensions | Required | video |
| Metrics | Use 1 or more | views,comments,likes,dislikes,videosAddedToPlaylists,videosRemovedFromPlaylists,shares,estimatedMinutesWatched,averageViewDuration,averageViewPercentage,annotationClickThroughRate,annotationCloseRate,annotationImpressions,annotationClickableImpressions,annotationClosableImpressions,annotationClicks,annotationCloses,subscribersGained,subscribersLost,earnings,adEarnings,grossRevenue,redPartnerRevenue,monetizedPlaybacks,playbackBasedCpm,impressions,impressionBasedCpm |
| Filter | Use exactly one | channel |
| Use 0 or one | country,continent,subContinent | |
| Sort | Use 0 or more (only descending order) | views,earnings,redPartnerRevenue,estimatedMinutesWatched,subscribersGained,subscribersLost |
Top Videos for content owner playlists:
| Dimensions | Required | playlist |
| Metrics | Use 1 or more | views,estimatedMinutesWatched,averageViewDuration,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist |
| Filter | Required | isCurated=true |
| Use 0 or one | playlist,channel | |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or more | subscribedStatus,youtubeProduct | |
| Sort | Use 0 or more (only descending order) | views,estimatedMinutesWatched,playlistStarts |
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Channel | String | True | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | ||
| Video | String | True | True | The Id of a YouTube video. | |
| Playlist | String | True | The Id of a YouTube playlist. | ||
| Group | String | True | (filter only) The Id of a YouTube Analytics group. | ||
| Country | String | True | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | ||
| Province | String | True | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | ||
| Continent | String | True | (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | ||
| SubContinent | String | True | (filter only) A U.N. statistical region code that identifies a geographical subregion. | ||
| IsCurated | Boolean | True | This filter indicates that the request is retrieving data about video views that occurred in the context of a playlist. This filter is required for any playlist report and its value must be set to 1. | ||
| ClaimedStatus | String | True | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | ||
| UploaderType | String | True | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | ||
| SubscribedStatus | String | True | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | ||
| YoutubeProduct | String | True | This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN. | ||
| Views | Double | False | True | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| EstimatedMinutesWatched | Double | False | True | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| AverageViewDuration | Double | False | True | The average length, in seconds, of video playbacks. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageViewPercentage | Double | False | False | The average percentage of a video watched during a video playback. | |
| PlaylistStarts | Double | False | False | The number of times that viewers initiated playback of a playlist. | |
| Likes | Double | False | False | The number of times that users indicated that they liked a video by giving it a positive rating. | |
| ViewerPercentage | Double | False | False | The percentage of viewers who were logged in when watching the video or playlist. | |
| Comments | Double | False | True | The number of times that users commented on a video. | |
| Dislikes | Double | False | True | The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy. | |
| Shares | Double | False | True | The number of times that users shared a video through the Share button. | |
| SubscribersGained | Double | False | True | The number of times that users subscribed to a channel or video. | |
| SubscribersLost | Double | False | True | The number of times that users unsubscribed from a channel or video. | |
| VideosAddedToPlaylists | Double | False | True | The number of times that videos were added to the video owner playlist or other channel playlists like the Watch Later playlist. Channel uploads playlists and user watch history are not reported. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, and then adds it again, the metric value reflects the video being added to a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| VideosRemovedFromPlaylists | Double | False | True | The number of times that videos were removed from the video owner playlist and other YouTube playlists like the Watch Later playlist. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, adds it again, and then removes it again, the metric value reflects the video being removed from a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| ViewsPerPlaylistStart | Double | False | False | The average number of video views that occurred each time a playlist was initiated. | |
| AverageTimeInPlaylist | Double | False | False | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. | |
| AnnotationImpressions | Double | False | True | The total number of annotation impressions. | |
| AnnotationClickableImpressions | Double | False | True | The number of annotations that appeared and could be clicked. | |
| AnnotationClicks | Double | False | True | The number of clicked annotations. | |
| AnnotationClickThroughRate | Double | False | True | The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. | |
| AnnotationClosableImpressions | Double | False | True | The number of annotations that appeared and could be closed. | |
| AnnotationCloses | Double | False | True | The number of closed annotations. | |
| AnnotationCloseRate | Double | False | True | The ratio of annotations that viewers closed to the total number of annotation impressions. | |
| EstimatedRevenue | Decimal | False | False | The total estimated earnings (net revenue) from all Google-sold advertising sources as well as from nonadvertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| EstimatedAdRevenue | Decimal | False | False | The total estimated earnings (net revenue) from all Google-sold advertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| EstimatedRedPartnerRevenue | Decimal | False | False | The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The value of the metric reflects earnings from both music and nonmusic content and is subject to month-end adjustment. | |
| GrossRevenue | Decimal | False | False | The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements. | |
| Cpm | Decimal | False | False | The estimated gross revenue per thousand ad impressions. | |
| AdImpressions | Double | False | False | The number of verified ad impressions served. | |
| MonetizedPlaybacks | Double | False | False | The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ±2.0%. | |
| PlaybackBasedCpm | Decimal | False | False | The estimated gross revenue per thousand playbacks. | |
| StartDate | Date | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
| EndDate | Date | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Segments | String | Segments the data returned for your request. Either a SegmentId or a custom segment. |
Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content.
The following query aggregates viewing statistics based on the manner in which viewers reached your video content; for example, to identify the number of views that stemmed from a Google search or from a link to a related video.
SELECT * FROM TrafficSources
The following query displays the Views and EstimatedMinutesWatched metrics grouped by the Day and InsightTrafficSourceType dimensions:
SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources
The following query filters the statistics to be compiled for a specific Video and Country:
SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources WHERE Video = 'video_id' AND Country = 'US'
The following query aggregates viewing statistics based on the manner in which viewers reached your playlist content; for example, to identify the number of views that stemmed from a Google search.
SELECT InsightTrafficSourceType, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated=true
The following query returns search terms that generated the most views from YouTube search results for videos located in playlists. Notice that ordering and limiting are required for such a query due to restrictions in the YouTube Analytics API.
SELECT InsightTrafficSourceDetail, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated=true AND InsightTrafficSourceType='YT_SEARCH' ORDER BY Views DESC LIMIT 25
You can use the following tables to build other queries to Traffic Sources:
Traffic Sources for videos:
| Dimensions | Use exactly one | insightTrafficSourceType,insightTrafficSourceDetail |
| Use 0 or more | day,liveOrOnDemand,subscribedStatus | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched |
| Filter | Use 0 or one | country,province,continent,subContinent |
| Use 0 or one | video,group | |
| Use 0 or more | liveOrOnDemand,subscribedStatus | |
| Sort | Use 0 or more(only descending order) | views,estimatedMinutesWatched |
Traffic Sources for playlists:
| Dimensions | Use exactly one | insightTrafficSourceType,insightTrafficSourceDetail |
| Use 0 or more | day,subscribedStatus | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist |
| Filter | Required | isCurated=true |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or one | playlist,channel,group | |
| Optional | subscribedStatus | |
| Sort | Use 0 or more(only descending order) | views,estimatedMinutesWatched,playlistStarts |
Traffic Sources for content owners:
| Dimensions | Required | insightTrafficSourceType |
| Use 0 or more | day,liveOrOnDemand,subscribedStatus | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched |
| Filter | Use exactly one | video,channel,group |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or more | liveOrOnDemand,subscribedStatus |
Traffic Sources for content owner playlists:
| Dimensions | Required | insightTrafficSourceType |
| Use 0 or more | day,subscribedStatus | |
| Metrics | Use 1 or more | views,estimatedMinutesWatched,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist |
| Filter | Required | isCurated=true |
| Use 0 or one | country,province,continent,subContinent | |
| Use 0 or one | playlist,channel,group | |
| Optional | subscribedStatus |
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Channel | String | True | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | ||
| Video | String | True | The Id of a YouTube video. | ||
| Playlist | String | True | The Id of a YouTube playlist. | ||
| Group | String | True | (filter only) The Id of a YouTube Analytics group. | ||
| Country | String | True | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | ||
| Province | String | True | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | ||
| Continent | String | True | (filter only) A United Nations (U.N.) statistical region code. The allowed values are 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | ||
| SubContinent | String | True | (filter only) A U.N. statistical region code that identifies a geographical subregion. | ||
| Day | String | True | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | ||
| LiveOrOnDemand | String | True | This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ONDEMAND. | ||
| SubscribedStatus | String | True | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | ||
| InsightTrafficSourceType | String | True | True | Data in the report is aggregated based on the referrer type, which describes the manner in which users reached the video. The allowed values are ADVERTISING, ANNOTATION, EXT_URL, NO_LINK_EMBEDDED, NO_LINK_OTHER, NOTIFICATION, PLAYLIST, PROMOTED, RELATED_VIDEO, SUBSCRIBER, YT_CHANNEL, YT_OTHER_PAGE, YT_SEARCH. | |
| InsightTrafficSourceDetail | String | True | Details about the InsightTrafficSourceType. | ||
| IsCurated | Boolean | True | This filter indicates that the request is retrieving data about video views that occurred in the context of a playlist. This filter is required for any playlist report and its value must be set to 1. | ||
| ClaimedStatus | String | True | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | ||
| UploaderType | String | True | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | ||
| Views | Double | False | True | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| EstimatedMinutesWatched | Double | False | True | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| PlaylistStarts | Double | False | False | The number of times that viewers initiated playback of a playlist. | |
| ViewsPerPlaylistStart | Double | False | False | The average number of video views that occurred each time a playlist was initiated. | |
| AverageTimeInPlaylist | Double | False | False | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. | |
| StartDate | Date | Start date for fetching Analytics data. | |||
| EndDate | Date | End date for fetching Analytics data. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Segments | String | Segments the data returned for your request. Either a SegmentId or a custom segment. |
Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content.
There are no required filters for this table. An optional column is Language.
The '=' operator is supported for this column.
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to identify the reason. | |||
| Label | String | The label text for the reason. | |||
| SecondaryReasonsAggregate | String | A list of secondary reasons associated with the reason, if any available. There might be 0 or more. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Language | String | The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US. |
Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos.
You can specify exactly one of the following columns: Id or Region.
If you do not specify any filtering criteria, by default you will get results for the US Region.
An extra optional parameter is Language.
SELECT * FROM VideoCategories WHERE Region = 'JP'The IN operator can be used to filter on multiple Ids:
SELECT Id, Kind, Etag, ChannelId, Title, Assignable
FROM VideoCategories
WHERE (ID IN ('1', '2', '10'))
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The unique identifier for the video category. | |||
| ChannelId | String | The YouTube channel that created the video category. | |||
| Title | String | The title of the video category. | |||
| Assignable | Boolean | Indicates whether videos can be associated with the category. | |||
| Region | String | The country from which to retrieve video categories. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Language | String | Specifies the language that should be used for text values in the API response. The default value is en_US. |
Query YouTube Videos.
By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube Analytics if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
By default, if no filters are specified, the driver will return all videos owned by the authenticated user.
Only one of the following columns may be filtered by at a time: Id, MyRating, ChannelId, or Chart. Extra columns supported are ForMine, Language, ForContentOwner, OnBehalfOfContentOwner.
A search against all videos on Youtube may be executed by specifying SearchTerms, RelatedToVideoId, VideoDuration, VideoCategoryId, or Region.
All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='. Id and ChannelId supports IN.
Order by is supported for the Date, Rating, Relevance and Title columns.
SELECT * FROM Videos WHERE Id = '12345679' SELECT * FROM Videos WHERE PublishedAt >= '2016-01-01T20:30:00Z' LIMIT 10 SELECT Description FROM Videos WHERE ForMine = True ORDER BY Date
Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.
The IN operator can be used to specify a list of channels. This call returns a list of videos for each specified channel.
SELECT * FROM Videos WHERE ChannelId IN (a, b, c) SELECT * FROM Videos WHERE ChannelId IN (SELECT Id FROM Channels)
IN operator can also be used for getting data for multiple videos.
SELECT * FROM Videos WHERE Id IN (a, b, c)
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the video. | |||
| ChannelId | String | The Id that YouTube uses to uniquely identify the channel that the video was uploaded to. | |||
| CategoryId | String | The YouTube video category associated with the video. | |||
| Title | String | The title of the video. | |||
| ChannelTitle | String | Channel title for the channel that the video belongs to. | |||
| PublishedAt | Datetime | The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| Description | String | The description of the video. | |||
| Duration | String | The length of the video. The property value is an ISO 8601 duration. | |||
| ViewCount | Long | The number of times the video has been viewed. | |||
| LikeCount | Long | The number of users who have indicated that they liked the video. | |||
| DislikeCount | Long | The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner. | |||
| CommentCount | Long | The number of comments for the video. | |||
| EmbedHtml | String | An iframe tag that embeds a player that will play the video. | |||
| PublicStatsViewable | Boolean | This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false. | |||
| TagsAggregate | String | A list of keyword tags associated with the video. | |||
| LiveBroadcastContent | String | Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming. | |||
| Dimension | String | Indicates whether the video is available in 3D or in 2D. | |||
| Definition | String | Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd. | |||
| Caption | String | Indicates whether captions are available for the video. Valid values for this column: false, true. | |||
| LicensedContent | Boolean | Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner. | |||
| AllowedAggregate | String | A list of region codes that identify countries where the video is viewable. | |||
| BlockedAggregate | String | A list of region codes that identify countries where the video is blocked. | |||
| Projection | String | Specifies the projection format of the video. Valid values: 360, rectangular. | |||
| PrivacyStatus | String | The privacy status of the playlist. Valid values: private, public, unlisted. | |||
| MadeForKids | Boolean | This value indicates whether the video is Made For Kids. | |||
| License | String | The license. Valid values: creativeCommon, youtube. | |||
| Embeddable | Boolean | This value indicates whether the video can be embedded on another website. | |||
| ThumbnailsDefaultUrl | String | The URL of the default image. | |||
| DefaultLanguage | String | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |||
| DefaultAudioLanguage | String | The default_audio_language column specifies the language spoken in the default audio track of the video. | |||
| UploadStatus | String | The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded. | |||
| FailureReason | String | This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted. | |||
| RejectionReason | String | This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended. | |||
| RecordingDate | Datetime | The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. | |||
| SearchTerms | String | The query term to search for. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| SafeSearch | String | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. |
| EventType | String | The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING.
The allowed values are COMPLETED, LIVE, UPCOMING. |
| RelatedToVideoId | String | Retrieves a list of videos that are related to the video that the column value identifies. |
| VideoDuration | String | Filters video search results based on their duration. Acceptable values: any, long, medium or short. |
| VideoCategoryId | String | The videoCategoryId parameter identifies the video category for which the chart should be retrieved. |
| Region | String | Instructs the API to select a video chart available in the specified region. This column can only be used in conjunction with the chart column. The parameter value is an ISO 3166-1 alpha-2 country code. |
| ForMine | String | Restricts the search to only retrieve videos owned by the authenticated user. It is false by default. |
| Chart | String | The chart parameter identifies the chart that you want to retrieve. Acceptable values are: mostPopular - Return the most popular videos for the specified content region and video category.
The allowed values are mostPopular. |
| MyRating | String | The rating of the authenticated user. Acceptable values: like or dislike.
The allowed values are like, dislike. |
| Language | String | Retrieve localized resource metadata for a specific application language that the YouTube website supports. |
| ForContentOwner | String | Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter. |
| OnBehalfOfContentOwner | String | This parameter is intended exclusively for YouTube content partners. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with YouTube Analytics.
Stored procedures accept a list of parameters, perform their intended function, and then return, if applicable, any relevant response data from YouTube Analytics, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CreateCustomSchema | Creates a custom schema file based on the specified Dimensions and Metrics. |
Creates a custom schema file based on the specified Dimensions and Metrics.
Creates a custom schema file based on the specified Dimensions and Metrics.
A custom schema may be used for a more tailored approach to your data. Custom options may include comma-separated lists for specific data.
| Name | Type | Required | Accepts Output Streams | Description |
| TableName | String | True | False | The name for the new table. |
| FileName | String | False | False | The full file path and name of the schema to generate. Ex : 'C:\\Users\\User\\Desktop\\JiraSD\\DataSetTest.rsd' |
| Description | String | False | False | An optional description for the table. |
| Dimensions | String | False | False | A comma-separated list of dimensions to include in the schema file. |
| Metrics | String | True | False | A comma-separated list of metrics to include in the schema file. |
| FileStream | String | False | True | Stream containing the downloaded schema if no FileName is specified |
| Name | Type | Description |
| Success | String | Whether or not the schema was created successfully. |
| SchemaFile | String | The generated schema file. |
| FileData | String | The generated schema encoded in Base64. Only returned if FileName or FileStream is not set. |
Obtains the OAuth access token to be used for authentication with various Google services.
| Name | Type | Required | Description |
| AuthMode | String | True | The type of authentication mode to use.
The allowed values are APP, WEB. The default value is WEB. |
| Verifier | String | False | The verifier code returned by Google after permission for the app to connect has been granted. WEB AuthMode only. |
| Scope | String | True | The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified.
The default value is https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtubepartner https://www.googleapis.com/auth/yt-analytics-monetary.readonly https://www.googleapis.com/auth/yt-analytics.readonly https://www.googleapis.com/auth/youtube.force-ssl. |
| CallbackURL | String | False | This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, capitalization, and trailing forward slash ('/'). |
| Prompt | String | True | This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user.
The default value is SELECT_ACCOUNT. |
| AccessType | String | True | This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to ONLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.
The allowed values are ONLINE, OFFLINE. The default value is OFFLINE. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
Obtains the OAuth authorization URL used for authentication with various Google services.
| Name | Type | Required | Description |
| Scope | String | True | The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified.
The default value is https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtubepartner https://www.googleapis.com/auth/yt-analytics-monetary.readonly https://www.googleapis.com/auth/yt-analytics.readonly https://www.googleapis.com/auth/youtube.force-ssl. |
| CallbackURL | String | False | This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, case, and trailing forward slash ('/'). |
| Prompt | String | True | This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user.
The default value is SELECT_ACCOUNT. |
| AccessType | String | True | This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to ONLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.
The allowed values are ONLINE, OFFLINE. The default value is OFFLINE. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Google authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to complete user authentication. |
Obtains the OAuth access token to be used for authentication with various Google services.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service. |
| ExpiresIn | String | The remaining lifetime on the access token. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for YouTube Analytics:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Groups table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Groups'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataTypeName | String | The name of the data type. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Groups table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Groups'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:youtubeanalytics:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the Cloud can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to YouTube Analytics. |
| ChannelId | The Id of a channel belonging to the authenticated user. |
| ContentOwnerId | The Id of the copyright holder for content in YouTube's rights management system. |
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| DefaultFilter | A default filter to be applied to all queries. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Readonly | You can use this property to enforce read-only access to YouTube Analytics from the provider. |
| RTK | The runtime key used for licensing. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to YouTube Analytics. |
| ChannelId | The Id of a channel belonging to the authenticated user. |
| ContentOwnerId | The Id of the copyright holder for content in YouTube's rights management system. |
The type of authentication to use when connecting to YouTube Analytics.
string
"Auto"
The Id of a channel belonging to the authenticated user.
string
""
The Id of a channel belonging to the authenticated user. You can find this on the advanced account settings page for your channel. If not specified, MINE will be used; this returns data for the authenticated user's YouTube channel.
The Id of the copyright holder for content in YouTube's rights management system.
string
""
The Id of the copyright holder for content in YouTube's rights management system. The content owner is the person or organization that claims videos and sets their monetization policy.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
The access token for connecting using OAuth.
string
""
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
The verifier code returned from the OAuth authorization URL.
string
""
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
See to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the Cloud exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
The OAuth refresh token for the corresponding OAuth access token.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
The lifetime in seconds of the OAuth AccessToken.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
The Unix epoch timestamp in milliseconds when the current Access Token was created.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
string
""
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
string
"USER"
This property can take one of the following values:
| USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
| GOOGLEJSON | The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service. |
| GOOGLEJSONBLOB | The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service. |
The password for the OAuth JWT certificate.
string
""
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.
The subject of the OAuth JWT certificate.
string
"*"
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma it must be quoted.
The issuer of the Java Web Token.
string
""
The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
The user subject for which the application is requesting delegated access.
string
""
The user subject for which the application is requesting delegated access. Typically, the user account name or email address.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
string
"NONE"
This property specifies the protocol that the Cloud will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Cloud connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Cloud opens a connection to YouTube Analytics and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Cloud sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Cloud sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
string
""
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Cloud uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
int
0
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
bool
true
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
string
""
The hostname or IP address of a proxy to route HTTP traffic through. The Cloud can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Cloud uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
int
80
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
string
"BASIC"
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Cloud will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
string
""
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Cloud uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
string
"AUTO"
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Cloud will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Cloud uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
A filepath which designates the name and location of the log file.
string
""
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
Core modules to be included in the log file.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
string
"100MB"
When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
A string specifying the maximum file count of log files.
int
-1
When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
string
"%APPDATA%\\CData\\YouTubeAnalytics Data Provider\\Schema"
The path to a directory which contains the schema files for the Cloud (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\YouTubeAnalytics Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Cloud.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Cloud.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Caching properties you can configure in the connection string for this provider.
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
bool
false
When AutoCache = true, the Cloud automatically maintains a cache of your table's data in the database of your choice.
When AutoCache = true, the Cloud caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
Specifies the path to the cache when caching to a file.
string
"%APPDATA%\\CData\\YouTubeAnalytics Data Provider"
The CacheLocation is a simple, file-based cache.
If left unspecified, the default location is "%APPDATA%\\CData\\YouTubeAnalytics Data Provider" with %APPDATA% being set to the user's configuration directory:
The tolerance for stale data in the cache specified in seconds when using AutoCache .
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The Cloud checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
Use offline mode to get the data from the cache instead of the live source.
bool
false
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
This property determines whether or not to cache the table metadata to a file store.
bool
false
As you execute queries with this property set, table metadata in the YouTube Analytics catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
The Cloud automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| DefaultFilter | A default filter to be applied to all queries. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Readonly | You can use this property to enforce read-only access to YouTube Analytics from the provider. |
| RTK | The runtime key used for licensing. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
A default filter to be applied to all queries.
string
"EndDate=Today"
A default filter to be applied to all queries. Convenient for setting default Dimensions, StartDate, EndDate, and Segments for all queries. These values will be overridden if set in the query. Example value: Dimensions=Year AND EndDate=Today
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
These hidden properties are used only in specific use cases.
string
""
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
You can use this property to enforce read-only access to YouTube Analytics from the provider.
bool
false
If this property is set to true, the Cloud will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
The runtime key used for licensing.
string
""
The RTK property may be used to license a build.
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Cloud automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Cloud.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Groups WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"