garf for YouTube Data API

garf-youtube-data-api simplifies fetching data from YouTube Data API using SQL-like queries.

Prerequisites

YouTube Data API

• YouTube Data API enabled.
• API key to access to access YouTube Data API.

  Once generated expose API key as export GARF_YOUTUBE_DATA_API_KEY=<YOUR_API_KEY>

YouTube Reporting API

• YouTube Reporting API enabled.

• Client ID, client secret and refresh token generated. \

  Please note you'll need to use another OAuth2 credentials type - Web application, and set "https://developers.google.com/oauthplayground" as redirect url in it.

• Refresh token. You can use OAuth Playground to generate refresh token.

  • Select https://www.googleapis.com/auth/yt-analytics.readonly scope
  • Enter OAuth Client ID and OAuth Client secret under Use your own OAuth credentials;
  • Click on Authorize APIs

• Expose client id, client secret and refresh token as environmental variables:

export GARF_YOUTUBE_REPORTING_API_CLIENT_ID=
export GARF_YOUTUBE_REPORTING_API_CLIENT_SECRET=
export GARF_YOUTUBE_REPORTING_API_REFRESH_TOKEN=

Installation

pip install garf-youtube

Usage

Run as a library

from garf.community.google.youtube import report_fetcher
from garf.io import writer


# Specify query
query = 'SELECT id, snippet.title AS channel_name FROM channels'

# Fetch report
fetched_report = (
  report_fetcher.YouTubeDataApiReportFetcher()
  .fetch(query, id=[<YOUR_CHANNEL_ID_HERE>])
)

# Write report to console
console_writer = writer.create_writer('console')
console_writer.write(fetched_report, 'output')

Learn more on library usage.

Run via CLI

Install garf-executors package to run queries via CLI (pip install garf-executors).

garf <PATH_TO_QUERIES> --source youtube-data-api \
  --output <OUTPUT_TYPE> \
  --source.<SOURCE_PARAMETER=VALUE>

where:

• <PATH_TO_QUERIES> - local or remove files containing queries
• <OUTPUT_TYPE> - output supported by garf-io library.
• <SOURCE_PARAMETER=VALUE - key-value pairs to refine fetching, check available source parameters.

Learn more on CLI usage.

Documentation

You can find a documentation on garf-youtube here.

Samples

Sample queries for interacting with YouTube Data API are located in examples folder.