Establishing a Connection
Creating a JDBC Data Source
You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for YouTube Analytics consists of three basic steps:
- Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
- Provide the driver class. For example:
cdata.jdbc.youtubeanalytics.YouTubeAnalyticsDriver
- Provide the JDBC URL. For example:
jdbc:youtubeanalytics:InitiateOAuth=GETANDREFRESH;ContentOwnerId=MyContentOwnerId;ChannelId=ChannelId; or jdbc:cdata:youtubeanalytics:InitiateOAuth=GETANDREFRESH;ContentOwnerId=MyContentOwnerId;ChannelId=ChannelId;
The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:youtubeanalytics:" or "jdbc:cdata:youtubeanalytics:" and can include any of the connection properties in name-value pairs separated with semicolons.
Connecting 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.
Authenticating to YouTube Analytics
All connections to YouTube Analytics are authenticated using OAuth. The driver 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 driver'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 driver 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 driver'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 driver 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 driver can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.