Skip to Content

YouTube Analytics Connection Details

Introduction

Connector Version

This documentation is based on version 22.0.8676 of the connector.

Get Started

YouTube Analytics Version Support

The connector uses version 2 of the YouTube Analytics API.

Establish a Connection

Connect to YouTube Analytics

Provide the following connection properties before adding the authentication properties.

  • ChannelId: Set to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set if you want to generate content owner reports.

Authenticate to YouTube Analytics

All connections to YouTube Analytics are authenticated using OAuth. The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

User Accounts

AuthScheme must be set to OAuth in all of the user account flows.

For desktop applications, the connector's embedded application is the simplest way to authenticate. The only additional requirement is to set InitiateOAuth to GETANDREFRESH.

When the driver starts, it will open a browser and YouTube Analytics will request your login information. The connector will use the credentials you provide to access your YouTube Analytics data. These credentials will be saved and automatically refreshed as needed. For desktop applications, the connector's default application is the simplest way to authenticate. The only additional requirement is to set InitiateOAuth to GETANDREFRESH.

When the driver starts, it will open a browser and YouTube Analytics will request your login information. The connector will use the credentials you provide to access your YouTube Analytics data. These credentials will be saved and automatically refreshed as needed.

Service Accounts

To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate.

For a JSON file, you will need to set these properties:

  • AuthScheme: Required. Set this to OAuthJWT.
  • InitiateOAuth: Required. Set this to GETANDREFRESH.
  • OAuthJWTCertType: Required. Set this to GOOGLEJSON.
  • OAuthJWTCert: Required. Set this to the path to the .json file provided by Google.
  • OAuthJWTSubject: Optional. Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, you will need to set these properties instead:

  • AuthScheme: Required. Set this to OAuthJWT.
  • InitiateOAuth: Required. Set this to GETANDREFRESH.
  • OAuthJWTCertType: Required. Set this to PFXFILE.
  • OAuthJWTCert: Required. Set this to the path to the .pfx file provided by Google.
  • OAuthJWTCertPassword: Optional. Set this to the .pfx file password. In most cases this will need to be provided since Google encrypts PFX certificates.
  • OAuthJWTCertSubject: Optional. Set this only if you are using a OAuthJWTCertType which stores multiple certificates. Should not be set for PFX certificates generated by Google.
  • OAuthJWTIssuer: Required. Set this to the email address of the service account. This address will usually include the domain iam.gserviceaccount.com.
  • OAuthJWTSubject: Optional. Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

If you do not already have a service account, you can create one by following the procedure in Creating a Custom AzureAD App.

GCP Instance Accounts

When running on a GCP virtual machine, the connector can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Use OAuth Authentication

Use the OAuth authentication standard to connect to YouTube Analytics. You can authenticate with a user account or a service account. The connector facilitates this as described below.

User Accounts

The user account flow requires the authenticating user to interact with YouTube Analytics via the browser.

Embedded Credentials

See Embedded Credentials to connect with the connector's embedded credentials and skip creating a custom OAuth app.

Custom Credentials

Instead of connecting with the connector's embedded credentials, you can register an app to obtain the OAuthClientId and OAuthClientSecret.

When to Create a Custom OAuth App

Creating a custom OAuth app is optional as the connector is already registered with YouTube Analytics and you can connect with its embedded credentials. You might want to create a custom OAuth app to change the information displayed when users log into the YouTube Analytics OAuth endpoint to grant permissions to the connector.

Use a Service Account to Connect to YouTube Analytics

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 connector.

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.

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Embedded Credentials

Embedded OAuth Credentials
Desktop Authentication with the Embedded OAuth App

You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this to the ID of the content owner if you want to generate content owner reports.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process.

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Custom Credentials

You can use a custom OAuth app to authenticate with a service account or a user account. See Using OAuth Authentication for more information.

User Accounts
Desktop Authentication with a Custom OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: Set this to the client ID assigned when you registered your app.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your app.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this if you want to generate content owner reports.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Refreshes the access token when it expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Service Accounts

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 connector.

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:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the Client ID in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthJWTCertType: Set this to "PEMKEY_FILE".
  • OAuthJWTCert: Set this to the path to the .pem file you generated.
  • OAuthJWTCertPassword: Set this to the password of the .pem file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTSubject: Set this to the email address of the user for whom the application is requesting delegate access. Note that delegate access must be granted by an administrator.
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this if you want to generate content owner reports.

When you connect the connector completes the OAuth flow for a service account.

  1. Creates and signs the JWT with the claim set required by the connector.
  2. Exchanges the JWT for the access token.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Submits the JWT for a new access token when the token expires.

Headless Machines

Use OAuth on a Headless Machine

The following sections show how to authenticate a headless server or another machine on which the connector cannot open a browser. You can authenticate with a user account or with a service account.

User Accounts

To authenticate with a user account, you need to authenticate from another machine. Authentication is a two-step process.

  1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the connector's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Use the Embedded OAuth Credentials

Obtain a Verifier Code

Follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property:

  1. Click the following link to open the YouTube Analytics OAuth endpoint in your browser.
  2. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values.

  • OAuthVerifier: Set this to the verifier code.
  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this to the ID of the content owner if you want to generate content owner reports.

Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable text file.
  • InitiateOAuth: Set this to GETANDREFRESH.

Test the connection to authenticate in the browser. 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:

  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this to the ID of the content owner if you want to generate content owner reports.
Use the Credentials for a Custom OAuth App

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 connector'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 connector.

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:

  • InitiateOAuth: Set this to OFF.
  • OAuthClientId: Set this to the Client ID in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

  1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
  2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
  • InitiateOAuth: Set this to REFRESH.

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this to the ID of the content owner if you want to generate content owner reports.

Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable text file.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the client ID assigned when you registered your app.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your app.

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:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this to the ID of the content owner if you want to generate content owner reports.
Service Accounts

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 connector.

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:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the Client ID in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthJWTCertType: Set this to "PEMKEY_FILE".
  • OAuthJWTCert: Set this to the path to the .pem file you generated.
  • OAuthJWTCertPassword: Set this to the password of the .pem file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTSubject: Set this to your enterprise ID if your subject type is set to "enterprise" or your app user ID if your subject type is set to "user".
  • ChannelId: Set this to the ID of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
  • ContentOwnerId: Set this to the ID of the content owner if you want to generate content owner reports.

When you connect the connector completes the OAuth flow for a service account.

  1. Creates and signs the JWT with the claim set required by the connector.
  2. Exchanges the JWT for the access token.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Submits the JWT for a new access token when the token expires.

Create a Custom OAuth App

You can use a custom OAuth app to authenticate a service account or a user account. See Using OAuth Authentication for more information.

Create an OAuth App for User Account Authentication

Follow the procedure below to register an app and obtain the OAuthClientId and OAuthClientSecret.

Create a Custom OAuth App: Desktop
  1. Log into the Google API Console and open a project.

    Select the API Manager from the main menu.

  2. In the user consent flow, click Credentials -> Create Credentials -> OAuth Client Id. Click Other. After creating the app, the OAuthClientId and OAuthClientSecret are displayed.

  3. Click Library -> YouTube Analytics API -> Enable API.

Create an OAuth App for Service Account Authentication

Follow the steps below to create an OAuth application and generate a private key. You will then authorize the service account.

  1. Log into the Google API Console and open a project. Select the API Manager from the main menu.
  2. Click Create Credentials -> Service Account Key.
  3. In the Service Account menu, select New Service Account or select an existing service account.
  4. If you are creating a new service account, additionally select one or more roles. You can assign primitive roles at the project level in the IAM and Admin section; other roles enable you to further customize access to Google APIs.
  5. In the Key Type section, select the P12 key type.
  6. Create the app to download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.
  7. In the service accounts section, click Manage Service Accounts and set OAuthJWTIssuer to the email address displayed in the service account ID field.
  8. Click Library -> YouTube Analytics API -> Enable API.

Retrieve YouTube Analytics Data

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 connector surfaces some of the most commonly used combinations as relational views for ease of use.

Additionally, the connector 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.

Select Dimensions and Measures

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'

Execute SELECT * Queries

Unlike most database tables, it is not very helpful to select all metrics and dimensions in a given table. The connector 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.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the YouTube Analytics connector.

User Defined Views

The connector 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.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector 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.

User Defined Views

The YouTube Analytics connector 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 Jitterbit. 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:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector 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 connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

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"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

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.

Data Model

The YouTube Analytics connector 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.

Tables

You can access Groups and Group Items as Tables.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to access additional capabilities of the YouTube Analytics API.

Views

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.

Defining Custom Views

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'

Tables

The connector 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.

YouTube Analytics Connector Tables

Name Description
GroupItems Create, delete, and query Items that compose a Group.
Groups Create, update, delete, and query YouTube Analytics Groups.

GroupItems

Create, delete, and query Items that compose a Group.

Table-Specific Information
Select

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.

Insert

GroupId and Resource_Id are required to insert an Item into a Group.

INSERT INTO GroupItems (GroupId, Resource_Id) VALUES ('fjgeeljgio54','dkhgjio5sfff')
Columns
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.

Groups

Create, update, delete, and query YouTube Analytics Groups.

Table-Specific Information

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.

Select

The following columns can be used in the WHERE clause: OnBehalfOfContentOwner and Mine.

Insert

ContentDetails_ItemType is required to insert a Group.

INSERT INTO Groups (Snippet_Title, ContentDetails_ItemType) VALUES ('test2', 'youtube#channel')
Columns
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

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.

YouTube Analytics Connector Views

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.

Activities

Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube.

Table Specific Information
Select

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'
Columns
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πŸ‡²πŸ‡²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-Columns

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.

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.

Table Specific Information
Select

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'
Select Rules

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 |

Columns
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-Columns

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.

Captions

Query YouTube Captions. A Caption resource represents a YouTube caption track.

Table Specific Information
Select

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'
Columns
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πŸ‡²πŸ‡²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).

Channels

Query YouTube Channels.

Table Specific Information
Select

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.

Columns
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πŸ‡²πŸ‡²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-Columns

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.

ChannelSections

Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature.

Table Specific Information
Select

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'
Columns
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-Columns

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.

Comments

Query YouTube Comments.

Table Specific Information
Select

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'
Columns
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πŸ‡²πŸ‡²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πŸ‡²πŸ‡²ss.sZ) format.
Pseudo-Columns

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.

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.

Table Specific Information
Select

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.

Columns
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-Columns

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.

Demographics

Query YouTubeAnalytics Demographics grouped by age groups and gender.

Table Specific Information
Select

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
Select Rules

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 |

Columns
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-Columns

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.

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.

Table Specific Information
Select

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 Devices

Notice that you cannot mix both Device Type and Operating System in the same query due to limitations in the YouTube Analytics API.

Select Rules

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 |

Columns
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-Columns

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.

EngagementReports

Query Engagement Reports info. For example, how many times a user shared a video.

Table Specific Information
Select

By default, results are grouped by Day. The following query returns Comments, Likes, Dislikes, etc., grouped by Day:

SELECT * FROM EngagementReports
Select Rules

The following query returns how frequently the channel's videos were shared on different social platforms:

SELECT SharingService, Shares FROM EngagementReports

You 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 |

Columns
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-Columns

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.

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.

Table Specific Information
Select

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns
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.

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.

Table Specific Information
Select

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'
Columns
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πŸ‡²πŸ‡²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πŸ‡²πŸ‡²ss.sZ) format.
PrivacyStatus String The privacy status of the playlist item.
Pseudo-Columns

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.

PlayLists

Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users.

Table Specific Information
Select

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 YouTube Analytics connector 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.

Columns
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πŸ‡²πŸ‡²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-Columns

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.

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.

Table Specific Information
Select

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns
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-Columns

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.

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.

Table Specific Information
Select

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.

Columns
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πŸ‡²πŸ‡²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-Columns

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.

TimeBasedReports

Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time.

Table-Specific Information
Select Rules

You can use the following tables to build queries to TimeBased Reports: TimeBased Reports for videos:

| 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 |

Columns
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-Columns

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.

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.

Table Specific Information
Select

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
Select Rules

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 |

Columns
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-Columns

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.

TrafficSources

Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content.

Table Specific Information
Select

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
Select Rules

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 |

Columns
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-Columns

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.

VideoAbuseReportReasons

Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content.

Table Specific Information
Select

There are no required filters for this table. An optional column is Language.

The '=' operator is supported for this column.

Columns
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-Columns

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.

VideoCategories

Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos.

Table Specific Information
Select

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'))
Columns
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-Columns

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.

Videos

Query YouTube Videos.

Table Specific Information
Select

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)
Columns
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πŸ‡²πŸ‡²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πŸ‡²πŸ‡²ss.sssZ) format.
SearchTerms String The query term to search for.
Pseudo-Columns

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

Stored procedures are function-like interfaces that extend the functionality of the connector 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.

YouTube Analytics Connector Stored Procedures

Name Description
CreateCustomSchema Creates a custom schema file based on the specified Dimensions and Metrics.
GetOAuthAccessToken Obtains the OAuth access token to be used for authentication with various Google services.
GetOAuthAuthorizationURL Obtains the OAuth authorization URL used for authentication with various Google services.
RefreshOAuthAccessToken Obtains the OAuth access token to be used for authentication with various Google services.

CreateCustomSchema

Creates a custom schema file based on the specified Dimensions and Metrics.

CreateCustomSchema

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.

Input
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
Result Set Columns
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.

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with various Google services.

Input
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.
Result Set Columns
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.

GetOAuthAuthorizationURL

Obtains the OAuth authorization URL used for authentication with various Google services.

Input
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.
Result Set Columns
Name Type Description
URL String The URL to complete user authentication.

RefreshOAuthAccessToken

Obtains the OAuth access token to be used for authentication with various Google services.

Input
Name Type Required Description
OAuthRefreshToken String True The refresh token returned from the original authorization code exchange.
Result Set Columns
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.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for YouTube Analytics:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
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.

sys_tablecolumns

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'
Columns
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.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
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.

sys_procedureparameters

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
Columns
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.

sys_keycolumns

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'
Columns
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.

sys_foreignkeys

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'
Columns
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.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
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.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

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'
Columns
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.

sys_connection_props

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 <> ''
Columns
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.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector 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
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 Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The 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.

Columns
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.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
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.

Advanced Configurations Properties

The advanced configurations 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. Click the links for further details.

Authentication

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.

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
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.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
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.

JWT OAuth

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.

Schema

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.

Miscellaneous

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.
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.

Authentication

This section provides a complete list of authentication properties you can configure.

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.

AuthScheme

The type of authentication to use when connecting to YouTube Analytics.

Possible Values

Auto, OAuth, OAuthJWT

Data Type

string

Default Value

Auto

Remarks
  • Auto: Lets the driver decide automatically based on the other connection properties you have set.
  • OAuth: Set this to perform OAuth authentication using a standard user account.
  • OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.

ChannelId

The ID of a channel belonging to the authenticated user.

Data Type

string

Default Value

""

Remarks

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.

ContentOwnerId

The ID of the copyright holder for content in YouTube's rights management system.

Data Type

string

Default Value

""

Remarks

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.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
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.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
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.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

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.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

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.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

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.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.

Data Type

string

Default Value

%APPDATA%\YouTubeAnalytics Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\YouTubeAnalytics Data Provider\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

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.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

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.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

JWT OAuth

This section provides a complete list of JWT OAuth properties you can configure.

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.

OAuthJWTCert

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

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:

Property Description
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).

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Possible Values

GOOGLEJSONBLOB, USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, GOOGLEJSON

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

Property Description
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.

OAuthJWTCertPassword

The password for the OAuth JWT certificate.

Data Type

string

Default Value

""

Remarks

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.

OAuthJWTCertSubject

The subject of the OAuth JWT certificate.

Data Type

string

Default Value

*

Remarks

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, E=support@jitterbit.com". 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.

OAuthJWTIssuer

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

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.

OAuthJWTSubject

The user subject for which the application is requesting delegated access.

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

Schema

This section provides a complete list of schema properties you can configure.

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.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\YouTubeAnalytics Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.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%\YouTubeAnalytics Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

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.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

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.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

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.
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.

DefaultFilter

A default filter to be applied to all queries.

Data Type

string

Default Value

EndDate=Today

Remarks

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

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.

Data Type

int

Default Value

-1

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Integration and Formatting
Property Description
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.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

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, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

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 connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector 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 connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

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"