Advanced Settings
Establishing a Connection
Authenticate via OAuth Authentication
Use the OAuth authentication standard to connect to YouTube. You can authenticate with a user account or with a service account. A service account is required to grant organization-wide access scopes to the provider. The provider facilitates these authentication flows as described below.
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 provider.
You need to create an OAuth application in this flow. You can then connect to YouTube data that the service account has permission to access.
After setting the following connection properties, you are ready to connect:
- InitiateOAuth: Set to GETANDREFRESH.
- OAuthClientId: Set to the Client Id in your app settings.
- OAuthClientSecret: Set to the Client Secret in your app settings.
- OAuthJWTCertType: Set to "PEMKEY_FILE".
- OAuthJWTCert: Set to the path to the .pem file you generated.
- OAuthJWTCertPassword: Set to the password of the .pem file.
- OAuthJWTCertSubject: Set to "*" to pick the first certificate in the certificate store.
- OAuthJWTSubject: Set 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.
- ContentOwnerId: Set if you are a YouTube partner and want to access a content owner's data. The ContentOwnerId property is 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.
When you connect, the provider completes the following OAuth flow for a service account.
- Creates and signs the JWT with the claim set required by the provider.
- Exchanges the JWT for the access token.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
- Submits the JWT for a new access token when the token expires.
Accessing Content Owner Reports
YouTube partners can query content owner reports by setting the ContentOwnerId property or by specifying the OnBehalfOfContentOwner field in the WHERE clause. You can generate content owner reports by querying the following tables:
- ChannelSections
- PlayListItems
- Subscriptions
- PlayLists
- Videos
The ContentOwnerId property specifies 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.
Creating a Custom OAuth App
You can use a custom OAuth app to authenticate a service account or a user account.
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
- Log into the Google API Console and open a project. Select the API Manager from the main menu.
-
In the user consent flow, click Credentials -> Create Credentials -> OAuth Client Id. Click Other. After creating the app, the OAuthClientId and OAuthClientSecret are displayed.
- Click Library -> YouTube Data API -> Enable API.
Create a Custom OAuth App: Web Apps
- Log into the Google API Console and open a project. Select the API Manager from the main menu.
- Click Credentials -> Create Credentials -> OAuth Client Id -> Web Application. In the Authorized Redirect URIs box, enter the URL you want to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. After creating the app, the OAuthClientId and OAuthClientSecret are displayed.
- Click Library -> YouTube Data API -> Enable API.
Create a Custom OAuth App: Headless Machines
Follow the procedure below to register an app and obtain the OAuth client credentials.
- Log into the Google API Console and open a project. Select the API Manager from the main menu.
- Click Credentials -> Create Credentials -> OAuth Client Id. Click Other. After creating the app, the OAuthClientId and OAuthClientSecret are displayed.
- Click Library -> YouTube Data 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.
- Log into the Google API Console and open a project. Select the API Manager from the main menu.
- Click Create Credentials -> Service Account Key.
- In the Service Account menu, select New Service Account or select an existing service account.
- 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.
- In the Key Type section, select the P12 key type.
- Create the app to download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.
- In the service accounts section, click Manage Service Accounts and set OAuthJWTIssuer to the email address displayed in the service account Id field.
- Click Library -> YouTube Data API -> Enable API.
Connecting Through a Firewall or Proxy
HTTP Proxies
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Other Proxies
Set the following properties:
- To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
- To tunnel the connection, set FirewallType to TUNNEL.
- To authenticate, specify FirewallUser and FirewallPassword.
- To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.
Troubleshooting the Connection
To show provider activity from query execution to network traffic, use Logfile and Verbosity. The examples of common connection errors below show how to use these properties to get more context. Contact the support team for help tracing the source of an error or circumventing a performance issue.
- Authentication errors: Typically, recording a Logfile at Verbosity 4 is necessary to get full details on an authentication error.
- Queries time out: A server that takes too long to respond will exceed the provider's client-side timeout. Often, setting the Timeout property to a higher value will avoid a connection error. Another option is to disable the timeout by setting the property to 0. Setting Verbosity to 2 will show where the time is being spent.