How to Get report — YouTube Connector for SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Get report in SSIS

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

    In the new SSIS project screen you will find the following:

    • SSIS ToolBox on left side bar
    • Solution Explorer and Property Window on right bar
    • Control flow, data flow, event Handlers, Package Explorer in tab windows
    • Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop

  4. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:

    SSIS API Source (Predefined Templates) - Drag and Drop

  5. Select New Connection to create a new connection:

    API Source - New Connection

  6. Use a preinstalled YouTube Connector from Popular Connector List or press Search Online radio button to download YouTube Connector. Once downloaded simply use it in the configuration:

    YouTube
    YouTube Connector Selection

  7. Now it's time to configure authentication. Firstly, configure authentication settings in YouTube service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

    API Key

    YouTube authentication
    This walkthrough will help you create an API Key which you will be able to use in all requests and authenticate accordingly.

    1. Go to Google API Console
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. On Project Popup click CREATE PROJECT
    4. Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
    5. Click ENABLE APIs AND SERVICES
    6. Now we need to Enable three APIs one by one (YouTube Data API, YouTube Analytics API, YouTube Reporting API).
    7. Search YouTube Data API. Select and click ENABLE
    8. Search YouTube Analytics API. Select and click ENABLE
    9. Search YouTube Reporting API. Select and click ENABLE
    10. Go to back to main screen of Google API Console
    11. Click OAuth Consent Screen Tab. Enter necessary details and Save.
    12. Click Credentials Tab
    13. Click CREATE CREDENTIALS (some where in topbar) and select API key option.
    14. In the popup, copy API Key from the field "Your API key", close this window, and use it in the UI configuration, "key" field
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to API Key [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    YouTube
    API Key [Http]
    https://youtube.googleapis.com/youtube/v3
    Required Parameters
    key Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 403|429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

    User Account

    YouTube authentication
    To register a custom app, perform the following steps (detailed steps found in the help link at the end)
    1. Go to Google API Console
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. On Project Popup click CREATE PROJECT
    4. Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
    5. Click ENABLE APIs AND SERVICES
    6. Now we need to Enable three APIs one by one (YouTube Data API, YouTube Analytics API, YouTube Reporting API).
    7. Search YouTube Data API. Select and click ENABLE
    8. Search YouTube Analytics API. Select and click ENABLE
    9. Search YouTube Reporting API. Select and click ENABLE
    10. Go to back to main screen of Google API Console
    11. Click OAuth Consent Screen Tab. Enter necessary details and Save.
    12. Click Credentials Tab
    13. Click CREATE CREDENTIALS (some where in topbar) and select OAuth Client ID option.
    14. When prompted Select Application Type as Desktop App and click Create to receive your ClientID and Secret. Later on you can use this information now to configure Connection.
    15. Go to OAuth Consent Screen tab. Under Publishing Status click PUBLISH APP to ensure your refresh token doesnt expire often. If you planning to use App for Private use then do not have to worry about Verification Status after Publish.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to User Account [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    YouTube
    User Account [OAuth]
    https://youtube.googleapis.com/youtube/v3
    Optional Parameters
    ClientId
    ClientSecret
    Scope https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtubepartner https://www.googleapis.com/auth/youtube.force-ssl https://www.googleapis.com/auth/youtube.upload https://www.googleapis.com/auth/youtubepartner-channel-audit https://www.googleapis.com/auth/yt-analytics-monetary.readonly https://www.googleapis.com/auth/yt-analytics.readonly
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 403|429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    Redirect URL (Only for Web App)
    ZappySys OAuth Connection

    Service Account (Using *.json OR *.p12 key file)

    YouTube authentication
    Use these steps to authenticate as service account rather than Google / GSuite User. Learn more about service account here

    Basically to call Google API as Service account we need to perform following steps listed in 3 sections (Detailed steps found in the help link at the end)

    Create Project

    First thing is create a Project so we can call Google API. Skip this section if you already have Project (Go to next section)
    1. Go to Google API Console
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. On Project Popup click CREATE PROJECT
    4. Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
    5. Click ENABLE APIs AND SERVICES
    6. Now we need to Enable three APIs one by one (YouTube Data API, YouTube Analytics API, YouTube Reporting API)
    7. Search YouTube Data API. Select and click ENABLE
    8. Search YouTube Analytics API. Select and click ENABLE
    9. Search YouTube Reporting API. Select and click ENABLE

    Create Service Account

    Once Project is created and APIs are enabled we can now create a service account under that project. Service account has its ID which looks like some email ID (not to confuse with Google /Gmail email ID)
    1. Go to Create Service Account
    2. From the Project Dropdown (usually found at the top bar) click Select Project
    3. Enter Service account name and Service account description
    4. For Role, do not select anything for now and Click Continue and then click Done. Next we will create Key.

    Create Key

    Once service account is created we need to create key file (i.e. credentials).
    1. In the Cloud Console, click the email address for the service account that you created.
    2. Click Keys.
    3. Click Add key, then click Create new key.
    4. Click Create and select P12 format. A P12 key file is downloaded to your computer. We will use this file in our API connection.
    5. Click Close.
    6. Now you may use downloaded *.p12 key file as secret file and Service Account Email as Client ID (e.g. some-service-account-name@your-project-id.iam.gserviceaccount.com ).

    Add Permission

    Now last thing is give read/write permission to Service Account. Basically you can create or open Google Sheet and add the Service Account as an editor to it as below.
    1. Copy the email address of your service account we created in previous step (its usually like this some-service-account-name@your-project-id.iam.gserviceaccount.com).
    2. Create or select an existing Google Sheet.
    3. Navigate to Sheet for which you like to give read/write access to Service Account.
    4. Click on the Share button in the top right, and add the email address of the service account as an editor. Here is how to share file(s) with specific people. Juse share with Service Account (use Service Account Email found on previous section)
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Service Account (Using *.json OR *.p12 key file) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    YouTube
    Service Account (Using *.json OR *.p12 key file) [OAuth]
    https://youtube.googleapis.com/youtube/v3
    Required Parameters
    Service Account Email Fill-in the parameter...
    Service Account Private Key Path (i.e. *.p12) Fill-in the parameter...
    Optional Parameters
    Scope https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtubepartner https://www.googleapis.com/auth/youtube.force-ssl https://www.googleapis.com/auth/youtube.upload https://www.googleapis.com/auth/youtubepartner-channel-audit https://www.googleapis.com/auth/yt-analytics-monetary.readonly https://www.googleapis.com/auth/yt-analytics.readonly
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 403|429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

  8. Select Get report endpoint from the dropdown and hit Preview Data:

    API Source - YouTube
    Read / write YouTube data inside your app, perform many Youtube operations without coding using easy to use high performance API Connector for YouTube
    YouTube
    Get report
    Required Parameters
    ids Fill-in the parameter...
    metrics Fill-in the parameter...
    Start Date (yyyy-MM-dd) Fill-in the parameter...
    End Date (yyyy-MM-dd) Fill-in the parameter...
    Optional Parameters
    ArrayTransformType TransformSimpleTwoDimensionalArray
    ArrayTransColumnNameFilter $.columnHeaders[*].name
    ArrayTransRowValueFilter $.rows[*]
    currency
    dimensions
    filters
    includeHistoricalChannelData
    maxResults 50
    sort
    SSIS API Source - Read from table or endpoint

  9. That's it! We are done! Just in a few clicks we configured the call to YouTube using YouTube Connector.

    You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from YouTube and load into target
Download YouTube Connector for SSIS Documentation

More actions supported by YouTube Connector

Learn how to perform other actions directly in SSIS with these how-to guides:

More integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications