Package 'tubern'

Title: R Client for the YouTube Analytics and Reporting API
Description: Provides access to YouTube Analytics API v2 for retrieving YouTube Analytics data including views, engagement metrics, demographics, and revenue data. Supports OAuth 2.0 authentication and channel group management. See <https://developers.google.com/youtube/analytics/> for API documentation.
Authors: Gaurav Sood [aut, cre]
Maintainer: Gaurav Sood <[email protected]>
License: MIT + file LICENSE
Version: 0.5.0
Built: 2026-05-12 08:34:02 UTC
Source: https://github.com/gojiplus/tubern

Help Index

Add Group Item

Description

Add Group Item

Usage

add_group_item(resource_details, ...)

Arguments

resource_details

Named nested list. Required. Must provide: groupId, resource.id
...

Additional arguments passed to tubern_POST.

Value

named list

References

https://developers.google.com/youtube/analytics/reference/groupItems/insert

Examples

## Not run: 
add_group_item(list(groupId = "", resource.id ="hello"))

## End(Not run)

Add Groups

Description

Creates a new channel group.

Usage

add_groups(resource_details, ...)

Arguments

resource_details

Named nested list. Required. Must provide: snippet with title (required), and optionally description and contentDetails with itemType
...

Additional arguments passed to tubern_POST.

Value

named list

References

https://developers.google.com/youtube/analytics/reference/groups/insert

Examples

## Not run: 
add_groups(list(
  snippet = list(
    title = "My Channel Group",
    description = "A group for organizing channels"
  ),
  contentDetails = list(itemType = "youtube#channel")
))

## End(Not run)

Check API quota status and provide guidance

Description

Check API quota status and provide guidance

Usage

check_api_quota()

Value

Message about current quota usage (if available)

Examples

## Not run: 
check_api_quota()

## End(Not run)

Data Transformation Utilities

Description

Functions to transform YouTube Analytics API responses into common R data formats

Date Helper Functions for tubern

Description

Convenience functions for handling dates in YouTube Analytics API requests

Delete Group

Description

Delete Group

Usage

delete_group(id, ...)

Arguments

id

String. Required. “The id parameter specifies the YouTube group ID of the group that is being deleted.”
...

Additional arguments passed to tubern_DELETE.

Value

named list

References

https://developers.google.com/youtube/analytics/reference/groups/delete

Examples

## Not run: 
delete_group(id="ABZZzGSIAAA")

## End(Not run)

Delete Group Item

Description

Delete Group Item

Usage

delete_group_item(id, ...)

Arguments

id

String. Required. “The id parameter specifies the YouTube group item ID for the group that is being deleted.”
...

Additional arguments passed to tubern_DELETE.

Value

named list

References

https://developers.google.com/youtube/analytics/reference/groupItems/delete

Examples

## Not run: 
delete_group_item(id="ABZZzGSIAAA")

## End(Not run)

Diagnose common tubern issues

Description

Diagnose common tubern issues

Usage

diagnose_tubern()

Value

Diagnostic information about tubern setup

Examples

## Not run: 
diagnose_tubern()

## End(Not run)

Enhanced Error Handling for tubern

Description

Custom error classes and improved error handling for YouTube Analytics API using rlang for modern error handling patterns.

Get audience demographics report

Description

Retrieves demographic breakdown of your audience by age and gender.

Usage

get_audience_demographics(
  date_range,
  end_date = NULL,
  ids = "channel==MINE",
  dimension = c("ageGroup", "gender"),
  metrics = c("views", "estimatedMinutesWatched"),
  ...
)

Arguments

date_range

Date range string or start date
end_date

End date (only needed if date_range is a specific start date)
ids

Channel identifier (default: "channel==MINE")
dimension

Demographic dimension: "ageGroup", "gender", or both (default: both)
metrics

Vector of metrics to include (default: views, estimatedMinutesWatched)
...

Additional arguments passed to get_report()

Value

API response with demographic data

Examples

## Not run: 
# Full demographic breakdown
get_audience_demographics("last_90_days")

# Age groups only
get_audience_demographics("this_month", dimension = "ageGroup")

# Gender breakdown only  
get_audience_demographics("this_quarter", dimension = "gender")

## End(Not run)

Get available dimensions with descriptions

Description

Get available dimensions with descriptions

Usage

get_available_dimensions(pattern = NULL)

Arguments

pattern

Optional regex pattern to filter dimensions

Value

Named character vector of dimensions and descriptions

Examples

# Get all dimensions
get_available_dimensions()

# Get only geographic dimensions
get_available_dimensions("country|city")

Get available metrics with descriptions

Description

Get available metrics with descriptions

Usage

get_available_metrics(pattern = NULL)

Arguments

pattern

Optional regex pattern to filter metrics

Value

Named character vector of metrics and descriptions

Examples

# Get all metrics
get_available_metrics()

# Get only view-related metrics
get_available_metrics("view")

Get channel overview report

Description

Retrieves key channel performance metrics for a specified time period.

Usage

get_channel_overview(
  date_range,
  end_date = NULL,
  ids = "channel==MINE",
  include_engagement = TRUE,
  include_subscribers = TRUE,
  ...
)

Arguments

date_range

Date range string like "last_30_days" or start date for custom range
end_date

End date (only needed if date_range is a specific start date)
ids

Channel identifier (default: "channel==MINE")
include_engagement

Logical. Include likes, dislikes, comments, shares (default: TRUE)
include_subscribers

Logical. Include subscriber metrics (default: TRUE)
...

Additional arguments passed to get_report()

Value

API response with channel overview data

Examples

## Not run: 
# Channel performance for last 30 days
get_channel_overview("last_30_days")

# Channel performance for specific date range
get_channel_overview("2024-01-01", end_date = "2024-01-31")

# Basic metrics only
get_channel_overview("this_month", include_engagement = FALSE, include_subscribers = FALSE)

## End(Not run)

Get common date ranges

Description

Get common date ranges

Usage

get_common_date_ranges()

Value

Named list of common date ranges

Examples

get_common_date_ranges()

Get daily performance time series

Description

Retrieves day-by-day performance metrics for trend analysis.

Usage

get_daily_performance(
  date_range,
  end_date = NULL,
  ids = "channel==MINE",
  metrics = c("views", "estimatedMinutesWatched"),
  ...
)

Arguments

date_range

Date range string or start date
end_date

End date (only needed if date_range is a specific start date)
ids

Channel identifier (default: "channel==MINE")
metrics

Vector of metrics to include (default: views, estimatedMinutesWatched)
...

Additional arguments passed to get_report()

Value

API response with daily time series data

Examples

## Not run: 
# Daily views for last 30 days
get_daily_performance("last_30_days")

# Daily performance with engagement metrics
get_daily_performance("this_month", metrics = c("views", "likes", "comments", "shares"))

## End(Not run)

Get geographic performance report

Description

Retrieves performance metrics broken down by country or other geographic dimensions.

Usage

get_geographic_performance(
  date_range,
  end_date = NULL,
  ids = "channel==MINE",
  dimension = "country",
  metrics = c("views", "estimatedMinutesWatched"),
  max_results = 25,
  ...
)

Arguments

date_range

Date range string or start date
end_date

End date (only needed if date_range is a specific start date)
ids

Channel identifier (default: "channel==MINE")
dimension

Geographic dimension: "country", "province", or "city" (default: "country")
metrics

Vector of metrics to include (default: views, estimatedMinutesWatched)
max_results

Number of results to return (default: 25)
...

Additional arguments passed to get_report()

Value

API response with geographic data

Examples

## Not run: 
# Top countries by views
get_geographic_performance("last_30_days")

# US states/provinces (requires US-only data)
get_geographic_performance("this_month", dimension = "province", 
                          filters = "country==US")

## End(Not run)

Get Reports

Description

Retrieves YouTube Analytics reports containing YouTube Analytics data.

Usage

get_report(
  ids,
  metrics,
  start_date = NULL,
  end_date = NULL,
  currency = NULL,
  dimensions = NULL,
  filters = NULL,
  include_historical_channel_data = NULL,
  max_results = NULL,
  sort = NULL,
  start_index = NULL,
  ...
)

Arguments

ids

String. Channel or content owner identifier. For channels: "channel==MINE" (for authenticated user's channel) or "channel==UCxxxxxxxxxxxxxxx" (for specific channel ID). For content owners: "contentOwner==ownerName".
metrics

String. Comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes.
start_date

String. Start date for the report. Can be in YYYY-MM-DD format or relative date like "last_30_days", "this_month", "yesterday".
end_date

String. End date for the report. Can be in YYYY-MM-DD format or relative date. If NULL and start_date is relative, will be calculated automatically.
currency

Optional. String. Default is USD. Specifies what earnings metrics like earnings, adEarnings, grossRevenue, playbackBasedCpm, impressionBasedCpm will be reported in.
dimensions

String. Optional. Comma-separated list of YouTube Analytics dimensions, such as video or ageGroup,gender.
filters

String. Optional. Dimension value filters. Multiple filters can be separated by semicolons. For video filtering: "video==videoId1,videoId2" (comma-separated video IDs). For country filtering: "country==US". Combined example: "video==videoId1,videoId2;country==US". Note: When filtering by video IDs, ensure the dimensions parameter includes "video".
include_historical_channel_data

Boolean. Default is FALSE. “Whether the API response should include channels' watch time and view data from the time period prior to when the channels were linked to the content owner.”
max_results

Integer. Optional. The maximum number of rows to include in the response.
sort

String. Optional A comma-separated list of dimensions or metrics that determine the sort order for YouTube
start_index

Integer. Optional. “The 1-based index of the first entity to retrieve.”
...

Additional arguments passed to tubern_GET.

Value

named list

Troubleshooting 404 Errors

If you encounter a 404 "Not Found" error, check the following:

  • Ensure YouTube Analytics API is enabled in your Google Cloud Console project

  • Verify your authentication token is valid and has the correct scopes

  • Check that the channel ID (if using specific channel ID) exists and you have access to it

  • Use "channel==MINE" to access your own authenticated channel's data

References

https://developers.google.com/youtube/analytics/reference/reports/query

Examples

## Not run: 
# Basic channel report
get_report(ids = "channel==MINE", metrics = "views",
           start_date = "2020-01-01", end_date = "2020-01-31")

# Report with video filtering (requires dimensions = "video")
get_report(ids = "channel==MINE",
           metrics = "views,likes,comments",
           dimensions = "video",
           filters = "video==videoId1,videoId2",
           start_date = "2020-01-01", end_date = "2020-01-31")

# Report with country filtering
get_report(ids = "channel==MINE",
           metrics = "views",
           filters = "country==US",
           start_date = "2020-01-01", end_date = "2020-01-31")

## End(Not run)

Get revenue report (requires monetary scope)

Description

Retrieves revenue and monetization metrics.

Usage

get_revenue_report(
  date_range,
  end_date = NULL,
  ids = "channel==MINE",
  currency = "USD",
  include_cpm = TRUE,
  ...
)

Arguments

date_range

Date range string or start date
end_date

End date (only needed if date_range is a specific start date)
ids

Channel identifier (default: "channel==MINE")
currency

Currency code (default: "USD")
include_cpm

Logical. Include CPM metrics (default: TRUE)
...

Additional arguments passed to get_report()

Value

API response with revenue data

Examples

## Not run: 
# Revenue report for last month
get_revenue_report("last_month")

# Revenue in different currency
get_revenue_report("this_quarter", currency = "EUR")

## End(Not run)

Get top videos report

Description

Retrieves performance metrics for individual videos, sorted by views.

Usage

get_top_videos(
  date_range,
  end_date = NULL,
  ids = "channel==MINE",
  max_results = 10,
  metrics = c("views", "likes", "comments"),
  ...
)

Arguments

date_range

Date range string or start date
end_date

End date (only needed if date_range is a specific start date)
ids

Channel identifier (default: "channel==MINE")
max_results

Number of top videos to return (default: 10)
metrics

Vector of metrics to include (default: views, likes, comments)
...

Additional arguments passed to get_report()

Value

API response with top videos data

Examples

## Not run: 
# Top 10 videos by views in last 30 days
get_top_videos("last_30_days")

# Top 25 videos with more metrics
get_top_videos("this_month", max_results = 25, 
               metrics = c("views", "likes", "comments", "shares", "estimatedMinutesWatched"))

## End(Not run)

List Group Items

Description

List Group Items

Usage

list_group_items(group_id, ...)

Arguments

group_id

String. Required. ID of the group
...

Additional arguments passed to tubern_GET.

Value

named list

References

https://developers.google.com/youtube/analytics/reference/groupItems/list

Examples

## Not run: 
list_group_items(group_id = "vponEBg8hrR1yBUX0Hz66Uc5WMk/vyGp6PvFo4RvsFtPoIWeCReyIC8")

## End(Not run)

List Groups

Description

List Groups

Usage

list_groups(filter, page_token = NULL, ...)

Arguments

filter

Named Vector. Required. Only one of the two: id or mine. id: Comma-separated list of YouTube group ID(s) to retrieve. mine: Set to TRUE to retrieve all groups owned by the authenticated user.
page_token

String. Optional. Identifies a specific page in the result set that should be returned.
...

Additional arguments passed to tubern_GET.

Value

named list

References

https://developers.google.com/youtube/analytics/reference/groups/list

Examples

## Not run: 
list_groups(filter = c(mine = TRUE))

## End(Not run)

Common Report Helper Functions

Description

Pre-configured functions for common YouTube Analytics report types

Resolve date range with support for relative dates

Description

Resolve date range with support for relative dates

Usage

resolve_date_range(start_date, end_date = NULL)

Arguments

start_date

Start date (can be relative like "last_30_days" or absolute like "2024-01-01")
end_date

End date (can be relative or absolute). If NULL and start_date is relative, will be calculated automatically

Value

List with resolved start_date and end_date as YYYY-MM-DD strings

Examples

# Relative date ranges
resolve_date_range("last_30_days")
resolve_date_range("this_month")
resolve_date_range("last_quarter")

# Absolute date ranges  
resolve_date_range("2024-01-01", "2024-01-31")

tubern provides access to the YouTube Analytics and Reporting API

Description

Provides access to YouTube Analytics API v2 for retrieving YouTube Analytics data including views, engagement metrics, demographics, and revenue data. Supports OAuth 2.0 authentication and channel group management. See https://developers.google.com/youtube/analytics/ for API documentation.

Author(s)

Maintainer: Gaurav Sood [email protected]

See Also

Useful links:

DELETE

Description

DELETE

Usage

tubern_DELETE(path, query = NULL, body = "", ...)

Arguments

path

path to specific API request URL
query

query list
body

passing image through body
...

Additional arguments passed to DELETE.

Value

list

Base POST AND GET functions. Not exported.

Description

GET

Usage

tubern_GET(path, query = NULL, ...)

Arguments

path

path to specific API request URL
query

query list
...

Additional arguments passed to GET.

Value

list

POST

Description

POST

Usage

tubern_POST(path, query = NULL, body = "", ...)

Arguments

path

path to specific API request URL
query

query list
body

passing image through body
...

Additional arguments passed to POST.

Value

list

PUT

Description

PUT

Usage

tubern_PUT(path, query = NULL, body = "", ...)

Arguments

path

path to specific API request URL
query

query list
body

passing image through body
...

Additional arguments passed to PUT.

Value

list

Update Groups

Description

Update Groups

Usage

update_group(resource_details, ...)

Arguments

resource_details

Named nested list. Required. Must provide: id, snippet title
...

Additional arguments passed to tubern_PUT.

Value

named list

References

https://developers.google.com/youtube/analytics/reference/groups/update

Examples

## Not run: 
update_group(list(id="ABZZzGSIAAA", snippet = list(title ="hello")))

## End(Not run)

YouTube Analytics API Validation Helpers

Description

Internal validation functions for metrics, dimensions, and parameters using checkmate for robust parameter validation.

Check if authentication token is in options

Description

Check if authentication token is in options

Usage

yt_check_token()

Export data to CSV

Description

Export data to CSV

Usage

yt_export_csv(api_response, filename = NULL, ...)

Arguments

api_response

API response from YouTube Analytics
filename

Output filename (default: auto-generated based on timestamp)
...

Additional arguments passed to yt_to_dataframe()

Value

Path to saved file

Examples

## Not run: 
report <- get_daily_performance("last_30_days")
file_path <- yt_export_csv(report, "daily_performance.csv")

## End(Not run)

Extract summary statistics from API response

Description

Extract summary statistics from API response

Usage

yt_extract_summary(api_response)

Arguments

api_response

API response from YouTube Analytics

Value

Named list with summary statistics

Examples

## Not run: 
report <- get_channel_overview("last_30_days")
summary <- yt_extract_summary(report)
print(summary)

## End(Not run)

Set up Authorization

Description

Simplified OAuth2 setup for YouTube Analytics API. This function will automatically detect the required scope based on your needs and provide helpful setup guidance.

Usage

yt_oauth(
  app_id = NULL,
  app_secret = NULL,
  scope = "analytics",
  token = ".httr-oauth",
  setup_guide = interactive(),
  ...
)

Arguments

app_id

Client ID from Google Cloud Console; required; no default
app_secret

Client secret from Google Cloud Console; required; no default
scope

Character. One of:

  • "analytics" - Basic analytics data (views, likes, etc.) - Default

  • "monetary" - Includes revenue and monetization data

  • "auto" - Automatically detect scope based on first API call

token

Path to file containing the token. Default is .httr-oauth in working directory.
setup_guide

Logical. Show setup guide for first-time users (default: TRUE for interactive sessions)
...

Additional arguments passed to oauth2.0_token

Details

The function looks for .httr-oauth in the working directory. If it doesn't find it, it expects an application ID and a secret. The function launches a browser to allow you to authorize the application.

Value

Sets the google_token option and saves .httr-oauth in working directory

References

https://developers.google.com/youtube/analytics/reference/

Examples

## Not run: 
   # Basic setup (will show setup guide first time)
   yt_oauth("your-client-id.apps.googleusercontent.com", "your-client-secret")

   # Setup with monetary scope for revenue data
   yt_oauth("your-client-id.apps.googleusercontent.com", "your-client-secret",
            scope = "monetary")

   # Skip setup guide
   yt_oauth("your-client-id.apps.googleusercontent.com", "your-client-secret",
            setup_guide = FALSE)

## End(Not run)

Create a quick visualization of the data (if ggplot2 is available)

Description

Create a quick visualization of the data (if ggplot2 is available)

Usage

yt_quick_plot(api_response, x_col = NULL, y_col = NULL, chart_type = "auto")

Arguments

api_response

API response from YouTube Analytics
x_col

Column name for x-axis (auto-detected if NULL)
y_col

Column name for y-axis (auto-detected if NULL)
chart_type

Type of chart: "line", "bar", "point" (default: auto)

Value

ggplot object or base R plot if ggplot2 not available

Examples

## Not run: 
# Daily views over time
daily_report <- get_daily_performance("last_30_days")
yt_quick_plot(daily_report)

# Top videos by views
top_videos <- get_top_videos("last_7_days")
yt_quick_plot(top_videos, chart_type = "bar")

## End(Not run)

Convert API response to data frame

Description

Transforms YouTube Analytics API response into a clean data.frame with proper column names and types.

Usage

yt_to_dataframe(api_response, clean_names = TRUE, parse_dates = TRUE)

Arguments

api_response

List returned from get_report() or other API functions
clean_names

Logical. Clean column names by removing special characters (default: TRUE)
parse_dates

Logical. Parse date columns to Date objects (default: TRUE)

Value

data.frame with transformed data, or NULL if no data available

Examples

## Not run: 
# Get data and convert to data.frame
report <- get_channel_overview("last_30_days")
df <- yt_to_dataframe(report)

# Keep original column names
df <- yt_to_dataframe(report, clean_names = FALSE)

## End(Not run)

Convert API response to tibble (if tibble is available)

Description

Convert API response to tibble (if tibble is available)

Usage

yt_to_tibble(api_response, ...)

Arguments

api_response

API response from YouTube Analytics
...

Additional arguments passed to yt_to_dataframe()

Value

tibble or data.frame if tibble not available

Examples

## Not run: 
report <- get_top_videos("last_7_days")
tbl <- yt_to_tibble(report)

## End(Not run)