Movatterモバイル変換

tuber: Client for the YouTube API

Description

Get comments posted on YouTube videos, information on how many times a video has been liked, search for videos with particular content, and much more. You can also scrape captions from a few videos. To learn more about the YouTube API, seehttps://developers.google.com/youtube/v3/.

Author(s)

Maintainer: Gaurav Soodgsood07@gmail.com

Other contributors:

• Kate Lyonsk.lyons7@gmail.com [contributor]

• John Muschellimuschellij2@gmail.com [contributor]

See Also

Useful links:

• https://gojiplus.github.io/tuber/

• https://github.com/gojiplus/tuber

• Report bugs athttps://github.com/gojiplus/tuber/issues

Pipe operator

Description

Seemagrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

Value

The result of calling 'rhs(lhs)'.

Add Video to Playlist

Description

Add Video to Playlist

Usage

add_video_to_playlist(playlist_id, video_id, position = NULL, ...)

Arguments

Value

Details of the added video in the playlist.

References

https://developers.google.com/youtube/v3/docs/playlistItems/insert

Examples

## Not run: # Set API token via yt_oauth() firstadd_video_to_playlist(playlist_id = "YourPlaylistID", video_id = "2_gLD1jarfU")## End(Not run)

Change the title of a YouTube playlist.

Description

This function updates the title of an existing YouTube playlist using the YouTube Data API.

Usage

change_playlist_title(playlist_id, new_title)

Arguments

Value

A list containing the server response after the update attempt.

Examples

## Not run: change_playlist_title(playlist_id = "YourPlaylistID", new_title = "New Playlist Title")## End(Not run)

Clean and Normalize YouTube Text Data

Description

Applies consistent cleaning to YouTube text fields

Usage

clean_youtube_text(  text,  remove_html = TRUE,  normalize_whitespace = TRUE,  max_length = NULL)

Arguments

Value

Cleaned character vector

Create New Playlist

Description

Create New Playlist

Usage

create_playlist(title, description, status, ...)

Arguments

Value

The created playlist's details.

References

https://developers.google.com/youtube/v3/docs/playlists/insert

Examples

## Not run: # Set API token via yt_oauth() firstcreate_playlist(title = "My New Playlist", description = "This is a test playlist.")## End(Not run)

Delete a Particular Caption Track

Description

Delete a Particular Caption Track

Usage

delete_captions(id = NULL, ...)

Arguments

References

https://developers.google.com/youtube/v3/docs/captions/delete

Examples

## Not run: # Set API token via yt_oauth() firstdelete_captions(id = "y3ElXcEME3lSISz6izkWVT5GvxjPu8pA")## End(Not run)

Delete Channel Sections

Description

Delete a Channel Section

Usage

delete_channel_sections(id = NULL, ...)

Arguments

References

https://developers.google.com/youtube/v3/docs/channelSections/delete

Examples

## Not run: # Set API token via yt_oauth() firstdelete_channel_sections(c(channel_id = "UCRw8bIz2wMLmfgAgWm903cA"))## End(Not run)

Delete a Particular Comment

Description

Delete a Particular Comment

Usage

delete_comments(id = NULL, ...)

Arguments

References

https://developers.google.com/youtube/v3/docs/comments/delete

Examples

## Not run: # Set API token via yt_oauth() firstdelete_comments(id = "y3ElXcEME3lSISz6izkWVT5GvxjPu8pA")## End(Not run)

Delete a Playlist Item

Description

Delete a Playlist Item

Usage

delete_playlist_items(id = NULL, ...)

Arguments

References

https://developers.google.com/youtube/v3/docs/playlistItems/delete

Examples

## Not run: # Set API token via yt_oauth() firstdelete_playlist_items(id = "YourPlaylistItemID")## End(Not run)

Delete a Playlist

Description

Delete a Playlist

Usage

delete_playlists(id = NULL, ...)

Arguments

References

https://developers.google.com/youtube/v3/docs/playlists/delete

Examples

## Not run: # Set API token via yt_oauth() firstdelete_playlists(id = "y3ElXcEME3lSISz6izkWVT5GvxjPu8pA")## End(Not run)

Delete a Video

Description

Delete a Video

Usage

delete_videos(id = NULL, ...)

Arguments

References

https://developers.google.com/youtube/v3/docs/playlistItems/delete

Examples

## Not run: # Set API token via yt_oauth() firstdelete_videos(id = "y3ElXcEME3lSISz6izkWVT5GvxjPu8pA")## End(Not run)

Add Exponential Backoff

Description

Internal function to handle rate limiting with exponential backoff

Usage

exponential_backoff(attempt_number, max_attempts = 5, base_delay = 1)

Arguments

Get statistics on all the videos in a Channel

Description

Iterates through the channel's uploads playlist, collecting video IDs fromeach page until no further pages are available. Statistics and details arethen fetched for every video.

Usage

get_all_channel_video_stats(channel_id = NULL, mine = FALSE, ...)

Arguments

Value

Adata.frame containing video metadata along with view, like,dislike and comment counts.

If thechannel_id is mistyped or there is no information, an empty list is returned

References

https://developers.google.com/youtube/v3/docs/channels/list

Examples

## Not run: # Set API token via yt_oauth() firstget_all_channel_video_stats(channel_id="UCxOhDvtaoXDAB336AolWs3A")get_all_channel_video_stats(channel_id="UCMtFAi84ehTSYSE9Xo") # Incorrect channel ID## End(Not run)

Get all the comments for a video including replies

Description

Get all the comments for a video including replies

Usage

get_all_comments(video_id = NULL, ...)

Arguments

Value

adata.frame with the following columns:authorDisplayName, authorProfileImageUrl, authorChannelUrl, authorChannelId.value, videoId, textDisplay,canRate, viewerRating, likeCount, publishedAt, updatedAt,id, moderationStatus, parentId

References

https://developers.google.com/youtube/v3/docs/commentThreads/list

Examples

## Not run: # Set API token via yt_oauth() firstget_all_comments(video_id = "a-UQz7fqR3w")## End(Not run)

Get Particular Caption Track

Description

For getting captions from the v3 API, you must specify the id resource.Checklist_caption_tracks for more information.

Usage

get_captions(id = NULL, lang = "en", format = "sbv", as_raw = TRUE, ...)

Arguments

Value

String.

References

https://developers.google.com/youtube/v3/docs/captions/download

Examples

## Not run: # Set API token via yt_oauth() firstget_captions(id = "y3ElXcEME3lSISz6izkWVT5GvxjPu8pA")## End(Not run)

Get statistics of a Channel

Description

Get statistics of a Channel

Usage

get_channel_stats(channel_id = NULL, mine = NULL, ...)list_my_channel(...)

Arguments

Value

nested named list with top element names:kind, etag, id, snippet (list of details of the channelincluding title), statistics (list of 5)

If thechannel_id is mistyped or there is no information, an empty list is returned

References

https://developers.google.com/youtube/v3/docs/channels/list

Examples

## Not run: # Set API token via yt_oauth() firstget_channel_stats(channel_id="UCMtFAi84ehTSYSE9XoHefig")get_channel_stats(channel_id="UCMtFAi84ehTSYSE9Xo") # Incorrect channel ID## End(Not run)

Get Comments Threads

Description

Get Comments Threads

Usage

get_comment_threads(  filter = NULL,  part = "snippet",  text_format = "html",  simplify = TRUE,  max_results = 100,  page_token = NULL,  ...)

Arguments

Value

Nested named list. The entryitems is a list of commentsalong with meta information.Within each of theitems is an itemsnippet whichhas an itemtopLevelComment$snippet$textDisplaythat contains the actual comment.

If simplify isTRUE, adata.frame with the following columns:authorDisplayName, authorProfileImageUrl, authorChannelUrl,authorChannelId.value, videoId, textDisplay,canRate, viewerRating, likeCount, publishedAt, updatedAt

References

https://developers.google.com/youtube/v3/docs/commentThreads/list

Examples

## Not run: # Set API token via yt_oauth() firstget_comment_threads(filter = c(video_id = "N708P-A45D0"))get_comment_threads(filter = c(video_id = "N708P-A45D0"), max_results = 101)## End(Not run)

Get Comments

Description

Get Comments

Usage

get_comments(  filter = NULL,  part = "snippet",  max_results = 100,  text_format = "html",  page_token = NULL,  simplify = TRUE,  ...)

Arguments

Value

Nested named list. The entryitems is a list of comments alongwith meta information.Within each of theitems is an itemsnippet which has anitemtopLevelComment$snippet$textDisplaythat contains the actual comment.

When filter iscomment_id, andsimplify isTRUE,and there is a correct comment id,it returns adata.frame with the following cols:id, authorDisplayName, authorProfileImageUrl, authorChannelUrl,value, textDisplay, canRate, viewerRating, likeCountpublishedAt, updatedAt

References

https://developers.google.com/youtube/v3/docs/comments/list

Examples

## Not run: # Set API token via yt_oauth() firstget_comments(filter = c(comment_id = "z13dh13j5rr0wbmzq04cifrhtuypwl4hsdk"))get_comments(filter = c(parent_id = "z13ds5yxjq3zzptyx04chlkbhx2yh3ezxtc0k"))get_comments(filter =c(comment_id = "z13dh13j5rr0wbmzq04cifrhtuypwl4hsdk,             z13dh13j5rr0wbmzq04cifrhtuypwl4hsdk"))## End(Not run)

Get Playlist Item IDs

Description

Get Playlist Item IDs

Usage

get_playlist_item_ids(  filter = NULL,  part = "contentDetails",  max_results = 50,  video_id = NULL,  page_token = NULL,  simplify = TRUE,  ...)

Arguments

Value

playlist items

References

https://developers.google.com/youtube/v3/docs/playlists/list

Examples

## Not run: # Set API token via yt_oauth() firstget_playlist_items(filter =                       c(playlist_id = "PLrEnWoR732-CN09YykVof2lxdI3MLOZda"))get_playlist_items(filter =                       c(playlist_id = "PL0fOlXVeVW9QMO3GoESky4yDgQfK2SsXN"),                       max_results = 51)## End(Not run)

Get Playlist Item Video IDs

Description

Get Playlist Item Video IDs

Usage

get_playlist_item_videoids(  filter = NULL,  part = "contentDetails",  max_results = 50,  video_id = NULL,  page_token = NULL,  simplify = TRUE,  ...)

Arguments

Value

playlist items

References

https://developers.google.com/youtube/v3/docs/playlists/list

Examples

## Not run: # Set API token via yt_oauth() firstget_playlist_items(filter =                       c(playlist_id = "YourPlaylistID"))get_playlist_items(filter =                       c(playlist_id = "YourPlaylistID"),                       max_results = 51)## End(Not run)

Get Playlist Items

Description

Get Playlist Items

Usage

get_playlist_items(  filter = NULL,  part = "contentDetails",  max_results = 50,  video_id = NULL,  page_token = NULL,  simplify = TRUE,  ...)

Arguments

Value

playlist items

References

https://developers.google.com/youtube/v3/docs/playlists/list

Examples

## Not run: # Set API token via yt_oauth() firstget_playlist_items(filter =                       c(playlist_id = "PLrEnWoR732-CN09YykVof2lxdI3MLOZda"))get_playlist_items(filter =                       c(playlist_id = "PL0fOlXVeVW9QMO3GoESky4yDgQfK2SsXN"),                       max_results = 51)## End(Not run)

Get Playlists

Description

Get Playlists

Usage

get_playlists(  filter = NULL,  part = "snippet",  max_results = 50,  hl = NULL,  page_token = NULL,  simplify = TRUE,  ...)

Arguments

Value

playlistsWhensimplify isTRUE, adata.frame with 4columns is returned:kind, etag, id, contentDetails.itemCount

References

https://developers.google.com/youtube/v3/docs/playlists/list

Examples

## Not run: # Set API token via yt_oauth() firstget_playlists(filter=c(channel_id="UCMtFAi84ehTSYSE9XoHefig"))get_playlists(filter=c(channel_id="UCMtFAi84ehTSYSE9X")) # incorrect Channel ID## End(Not run)

Get Related Videos

Description

Takes a video id and returns related videos

Usage

get_related_videos(  video_id = NULL,  max_results = 50,  safe_search = "none",  ...)

Arguments

Value

data.frame with 16 columns:video_id, rel_video_id,publishedAt, channelId, title, description,thumbnails.default.url, thumbnails.default.width, thumbnails.default.height,thumbnails.medium.url,thumbnails.medium.width, thumbnails.medium.height, thumbnails.high.url,thumbnails.high.width,thumbnails.high.height, channelTitle, liveBroadcastContent

References

https://developers.google.com/youtube/v3/docs/search/list

Examples

## Not run: # Set API token via yt_oauth() firstget_related_videos(video_id = "yJXTXN4xrI8")## End(Not run)

Get statistics of a Video

Description

Get statistics of a Video

Usage

get_stats(video_id = NULL, ...)

Arguments

Value

list with 6 elements:id, viewCount, likeCount,dislikeCount, favoriteCount, commentCount

References

https://developers.google.com/youtube/v3/docs/videos/list#parameters

Examples

## Not run: # Set API token via yt_oauth() firstget_stats(video_id="N708P-A45D0")## End(Not run)

Get Subscriptions

Description

Get Subscriptions

Usage

get_subscriptions(  filter = NULL,  part = "contentDetails",  max_results = 50,  for_channel_id = NULL,  order = NULL,  page_token = NULL,  ...)

Arguments

Value

named list of subscriptions

References

https://developers.google.com/youtube/v3/docs/subscriptions/list

Examples

## Not run: # Set API token via yt_oauth() firstget_subscriptions(filter = c(channel_id = "UChTJTbr5kf3hYazJZO-euHg"))## End(Not run)

Get Details of a Video or Videos

Description

Get details such as when the video was published, the title, description,thumbnails, category etc.

Usage

get_video_details(  video_id = NULL,  part = "snippet",  as.data.frame = FALSE,  ...)

Arguments

Value

list. If part is snippet, the list will have the following elements:id (video id that was passed),publishedAt, channelId, title, description, thumbnails,channelTitle, categoryId, liveBroadcastContent, localized,defaultAudioLanguage

References

https://developers.google.com/youtube/v3/docs/videos/list

Examples

## Not run: # Set API token via yt_oauth() firstget_video_details(video_id = "yJXTXN4xrI8")get_video_details(video_id = "yJXTXN4xrI8", part = "contentDetails")# retrieve multiple parametersget_video_details(video_id = "yJXTXN4xrI8", part = c("contentDetails", "status"))# get details for multiple videos as data frameget_video_details(video_id = c("LDZX4ooRsWs", "yJXTXN4xrI8"), as.data.frame = TRUE)## End(Not run)

List reasons that can be used to report abusive videos

Description

List reasons that can be used to report abusive videos

Usage

list_abuse_report_reasons(part = "id, snippet", hl = "en-US", ...)

Arguments

Value

If no results, empty data.frame returnedIf part requested = "id, snippet" or "snippet",data.frame with 4 columns:etag, id, label, secReasonsIf part requested = "id", data.frame with 2 columns:etag, id

References

https://developers.google.com/youtube/v3/docs/videoAbuseReportReasons/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_abuse_report_reasons()list_abuse_report_reasons(part="id")list_abuse_report_reasons(part="snippet")## End(Not run)

List Captions of a Video

Description

List Captions of a Video

Usage

list_caption_tracks(  part = "snippet",  video_id = NULL,  lang = "en",  id = NULL,  simplify = TRUE,  ...)

Arguments

Value

list of caption tracks. Whensimplify isTRUE, adata.frame is returned withfollowing columns:videoId, lastUpdated, trackKind, language, name,audioTrackType, isCC,isLarge, isEasyReader, isDraft, isAutoSynced, status, id (caption id)

References

https://developers.google.com/youtube/v3/docs/captions/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_caption_tracks(video_id = "yJXTXN4xrI8")## End(Not run)

Upload Video to Youtube

Description

Upload Video to Youtube

Usage

list_captions(video_id, query = NULL, ...)

Arguments

Value

A list of the response object from theGET and contentabout captions

Examples

## Not run: video_id <- "M7FIvfx5J10"list_captions(video_id)## End(Not run)

List Channel Activity

Description

Returns a list of channel events that match the request criteria.

Usage

list_channel_activities(  filter = NULL,  part = "snippet",  max_results = 50,  page_token = NULL,  published_after = NULL,  published_before = NULL,  region_code = NULL,  simplify = TRUE,  ...)

Arguments

Value

named listIfsimplify isTRUE, a data.frame is returned with 18 columns:publishedAt, channelId, title, description, thumbnails.default.url,thumbnails.default.width, thumbnails.default.height,thumbnails.medium.url, thumbnails.medium.width, thumbnails.medium.height,thumbnails.high.url, thumbnails.high.width,thumbnails.high.height, thumbnails.standard.url, thumbnails.standard.width,thumbnails.standard.height, channelTitle, type

References

https://developers.google.com/youtube/v3/docs/activities/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_channel_activities(filter = c(channel_id = "UCRw8bIz2wMLmfgAgWm903cA"))list_channel_activities(filter = c(channel_id = "UCRw8bIz2wMLmfgAgWm903cA", regionCode="US"))list_channel_activities(filter = c(channel_id = "UCMtFAi84ehTSYSE9XoHefig"),                        published_before = "2016-02-10T00:00:00Z",                        published_after = "2016-01-01T00:00:00Z")## End(Not run)

Returns List of Requested Channel Resources

Description

Returns List of Requested Channel Resources

Usage

list_channel_resources(  filter = NULL,  part = "contentDetails",  max_results = 50,  page_token = NULL,  hl = "en-US",  ...)

Arguments

Value

list. Ifusername is used infilter,a data frame with columnsusername andchannel_id is returned.

References

https://developers.google.com/youtube/v3/docs/channels/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_channel_resources(filter = c(channel_id = "UCT5Cx1l4IS3wHkJXNyuj4TA"))list_channel_resources(filter = c(username = "latenight"), part = "id")list_channel_resources(filter = c(username = c("latenight", "PBS")),                       part = "id")## End(Not run)

List Channel Sections

Description

Returns list of channel sections that channel id belongs to.

Usage

list_channel_sections(filter = NULL, part = "snippet", hl = NULL, ...)

Arguments

Value

captions for the video from one of the first track

References

https://developers.google.com/youtube/v3/docs/activities/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_channel_sections(c(channel_id = "UCRw8bIz2wMLmfgAgWm903cA"))## End(Not run)

Returns List of Requested Channel Videos

Description

Iterate through themax_results number of playlists in channel and getthe videos for each of the playlists.

Usage

list_channel_videos(  channel_id = NULL,  max_results = 50,  page_token = NULL,  hl = "en-US",  ...)

Arguments

Value

list ofdata.frame with each list corresponding to a differentplaylist

References

https://developers.google.com/youtube/v3/docs/channels/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_channel_videos(channel_id = "UCXOKEdfOFxsHO_-Su3K8SHg")list_channel_videos(channel_id = "UCXOKEdfOFxsHO_-Su3K8SHg", max_results = 10)## End(Not run)

Get list of categories that can be associated with YouTube channels

Description

Get list of categories that can be associated with YouTube channels

Usage

list_guidecats(filter = NULL, hl = NULL, ...)

Arguments

Value

data.frame with 5 columns:region_code, channelId, title,etag, id

References

https://developers.google.com/youtube/v3/docs/guideCategories/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_guidecats(c(region_code = "JP"))## End(Not run)

List Languages That YouTube Currently Supports

Description

List Languages That YouTube Currently Supports

Usage

list_langs(hl = NULL, ...)

Arguments

Value

data.frame with 3 columns:hl (two letter abbreviation),name (of the language),etag

References

https://developers.google.com/youtube/v3/docs/i18nLanguages/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_langs()## End(Not run)

List My videos

Description

List My videos

Usage

list_my_videos(...)

Arguments

Value

data.frame with each list corresponding to a differentplaylist

Examples

## Not run:   list_my_videos()## End(Not run)

List Content Regions That YouTube Currently Supports

Description

List Content Regions That YouTube Currently Supports

Usage

list_regions(hl = NULL, ...)

Arguments

Value

data.frame with 3 columns:gl (two letter abbreviation),name (of the region),etag

References

https://developers.google.com/youtube/v3/docs/i18nRegions/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_regions()## End(Not run)

List of Categories That Can be Associated with Videos

Description

List of Categories That Can be Associated with Videos

Usage

list_videocats(filter = NULL, ...)

Arguments

Value

data.frame with 6 columns:region_code, channelId, title, assignable, etag, id

References

https://developers.google.com/youtube/v3/docs/videoCategories/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_videocats(c(region_code = "JP"))list_videocats() # Will throw an error asking for a valid filter with valid region_code## End(Not run)

List (Most Popular) Videos

Description

List (Most Popular) Videos

Usage

list_videos(  part = "contentDetails",  max_results = 50,  page_token = NULL,  hl = NULL,  region_code = NULL,  video_category_id = NULL,  ...)

Arguments

Value

data.frame with 5 columns:channelId, title, assignable, etag, id

References

https://developers.google.com/youtube/v3/docs/search/list

Examples

## Not run: # Set API token via yt_oauth() firstlist_videos()## End(Not run)

Apply Unicode Handling to YouTube API Response

Description

Applies consistent Unicode handling to common YouTube API response fields

Usage

process_youtube_text(  response,  text_fields = c("title", "description", "textDisplay", "textOriginal", "channelTitle",    "authorDisplayName", "categoryId"))

Arguments

Value

Processed response with proper Unicode handling

YouTube API Quota Management

Description

Functions to track and manage YouTube API quota usage

Read SBV file

Description

Read SBV file

Usage

read_sbv(file)

Arguments

Value

Adata.frame with start/stop times and the text

Examples

if (yt_authorized()){vids <- list_my_videos()res <- list_caption_tracks(video_id = vids$contentDetails.videoId[1])cap <- get_captions(id = res$id, as_raw = FALSE)tfile <- tempfile(fileext = ".sbv")writeLines(cap, tfile)x <- read_sbv(tfile)if (requireNamespace("hms", quietly = TRUE)) {  x$start <- hms::as_hms(x$start)  x$stop <- hms::as_hms(x$stop)}}

Safely Convert Text to UTF-8

Description

Ensures text fields are properly encoded in UTF-8

Usage

safe_utf8(text, fallback_encoding = "latin1")

Arguments

Value

Character vector with UTF-8 encoding

Track Quota Usage

Description

Internal function to track API usage

Usage

track_quota_usage(endpoint, parts = NULL, additional_cost = 0)

Arguments

tuber provides access to the YouTube API V3.

Description

tuber provides access to the YouTube API V3 viaRESTful calls.

DELETE

Description

DELETE

Usage

tuber_DELETE(path, query, ...)

Arguments

Value

list

GET

Description

GET

Usage

tuber_GET(path, query, auth = "token", ...)

Arguments

Value

list

POST

Description

POST

Usage

tuber_POST(path, query, body = "", ...)

Arguments

Value

list

POST encoded in json

Description

POST encoded in json

Usage

tuber_POST_json(path, query, body = "", ...)

Arguments

Value

list

Request Response Verification

Description

Request Response Verification

Usage

tuber_check(req)

Arguments

Value

in case of failure, a message

Unicode and Text Processing Utilities

Description

Internal functions for consistent text and Unicode handling across tuber

Update a YouTube Video's Metadata

Description

This function updates the metadata of an existing YouTube video using the YouTube Data API.

Usage

update_video_metadata(  video_id,  title,  category_id,  description,  privacy_status,  made_for_kids)

Arguments

Value

A list containing the server response after the update attempt.

Examples

## Not run: update_video_metadata(video_id = "YourVideoID",                      title = "New Video Title",                      category_id = "24",                      description = "New Description",                      privacy_status = "public",                      made_for_kids = FALSE)## End(Not run)

Upload Video Caption to Youtube

Description

Upload Video Caption to Youtube

Usage

upload_caption(  file,  video_id,  language = "en-US",  caption_name,  is_draft = FALSE,  query = NULL,  open_url = FALSE,  ...)

Arguments

Value

A list of the response object from thePOST, content,and the URL of the video

Note

Seehttps://developers.google.com/youtube/v3/docs/captions#resource forfull specification

Examples

## Not run: xx = list_my_videos()video_id = xx$contentDetails.videoId[1]video_id = as.character(video_id)language = "en-US"## End(Not run)

Upload Video to Youtube

Description

Upload Video to Youtube

Usage

upload_video(  file,  snippet = NULL,  status = list(privacyStatus = "public"),  query = NULL,  open_url = FALSE,  ...)

Arguments

Value

A list of the response object from thePOST, content,and the URL of the uploaded

Note

The information for 'status' and 'snippet' are athttps://developers.google.com/youtube/v3/docs/videos#resourcebut the subset of these fields to pass in are located at:https://developers.google.com/youtube/v3/docs/videos/insertThe 'part“ parameter serves two purposes in this operation.It identifies the properties that the write operation will set, this will beautomatically detected by the names of 'body'.Seehttps://developers.google.com/youtube/v3/docs/videos/insert#usage

Examples

snippet = list(title = "Test Video",description = "This is just a random test.",tags = c("r language", "r programming", "data analysis"))status = list(privacyStatus = "private")

Get Current Quota Usage

Description

Returns the current estimated quota usage for the day

Usage

yt_get_quota_usage()

Value

List with quota_used, quota_limit, quota_remaining, and reset_time

Examples

## Not run: quota_status <- yt_get_quota_usage()cat("Used:", quota_status$quota_used, "/", quota_status$quota_limit)## End(Not run)

Manage YouTube API key

Description

These functions manage your YouTube API key and package key in.Renviron.

Usage

yt_get_key(decrypt = FALSE)yt_set_key(key, type)

Arguments

Value

'yt_get_key()' returns a character vector with the YouTube API key stored in '.Renviron'. If this value is not stored in '.Renviron', the functions return 'NULL'.

When the ‘type' argument is set to ’api', ‘yt_set_key()' assigns a YouTube API key to 'YOUTUBE_KEY' in '.Renviron' and invisibly returns 'NULL'. When the 'type' argument is set to ’package', 'yt_set_key()' assigns a package key to 'TUBER_KEY' in '.Renviron' and invisibly returns 'NULL'.

Examples

## Not run: ## for interactive useyt_get_key()list_channel_videos(  channel_id = "UCDgj5-mFohWZ5irWSFMFcng",  max_results = 3,  part = "snippet",  auth = "key")## for continuous integration and testingyt_set_key(httr2::secret_make_key(), type = "package")x <- httr2::secret_encrypt("YOUR_YOUTUBE_API_KEY", "TUBER_KEY")yt_set_key(x, type = "api")yt_get_key(decrypt = TRUE)list_channel_videos(  channel_id = "UCDgj5-mFohWZ5irWSFMFcng",  max_results = 3,  part = "snippet",  auth = "key")## End(Not run)

Set up Authorization

Description

The function looks for.httr-oauth in the working directory. If itdoesn't find it, it expects an application ID and a secret.If you want to remove the existing.httr-oauth, set remove_old_oauthto TRUE. By default, it is set to FALSE.The function launches a browser to allow you to authorize the application

Usage

yt_oauth(  app_id = NULL,  app_secret = NULL,  scope = "ssl",  token = ".httr-oauth",  ...)

Arguments

Details

If a browser cannot be opened, passuse_oob = TRUE toyt_oauth() so authentication can be completed using anout-of-band code.Delete the.httr-oauth file in the working directory to forcere-authentication.

Value

sets the google_token option and also saves.httr_oauthin the working directory (find out the working directory viagetwd())

References

https://developers.google.com/youtube/v3/docs/

https://developers.google.com/youtube/v3/guides/auth/client-side-web-appsfor different scopes

Examples

 ## Not run: yt_oauth(paste0("998136489867-5t3tq1g7hbovoj46dreqd6k5kd35ctjn",                ".apps.googleusercontent.com"),         "MbOSt6cQhhFkwETXKur-L9rN")## End(Not run)

Reset Quota Counter

Description

Reset the quota counter (typically done automatically at midnight UTC)

Usage

yt_reset_quota()

Search YouTube

Description

Search for videos, channels and playlists. (By default, the functionsearches for videos.)

Usage

yt_search(  term = NULL,  max_results = 50,  channel_id = NULL,  channel_type = NULL,  type = "video",  event_type = NULL,  location = NULL,  location_radius = NULL,  published_after = NULL,  published_before = NULL,  video_definition = "any",  video_caption = "any",  video_license = "any",  video_syndicated = "any",  region_code = NULL,  relevance_language = "en",  video_type = "any",  simplify = TRUE,  get_all = TRUE,  page_token = NULL,  max_pages = Inf,  ...)

Arguments

Value

data.frame with 16 elements:video_id, publishedAt,channelId, title, description,thumbnails.default.url, thumbnails.default.width, thumbnails.default.height,thumbnails.medium.url,thumbnails.medium.width, thumbnails.medium.height, thumbnails.high.url,thumbnails.high.width,thumbnails.high.height, channelTitle, liveBroadcastContentThe returned data.frame also has the following attributes:total_results: The total number of results reported by the APIactual_results: The actual number of rows returnedapi_limit_reached: Whether the YouTube API result limit was reached

References

https://developers.google.com/youtube/v3/docs/search/list

Examples

## Not run: # Set API token via yt_oauth() firstyt_search(term = "Barack Obama")yt_search(term = "Barack Obama", published_after = "2016-10-01T00:00:00Z")yt_search(term = "Barack Obama", published_before = "2016-09-01T00:00:00Z")yt_search(term = "Barack Obama", published_before = "2016-03-01T00:00:00Z",                               published_after = "2016-02-01T00:00:00Z")yt_search(term = "Barack Obama", published_before = "2016-02-10T00:00:00Z",                               published_after = "2016-01-01T00:00:00Z")# To check how many results were found vs. how many were returned:results <- yt_search(term = "drone videos")attr(results, "total_results")  # Total number reported by YouTubeattr(results, "actual_results") # Number actually returnedattr(results, "api_limit_reached") # Whether API limit was reached## End(Not run)

Set Quota Limit

Description

Set the daily quota limit (default is 10,000 units)

Usage

yt_set_quota_limit(limit)

Arguments

Examples

## Not run: # If you have a higher quota limityt_set_quota_limit(50000)## End(Not run)

Check if authentication token is in options

Description

Check if authentication token is in options

Usage

yt_token()yt_authorized()yt_check_token()

Value

A Token2.0 class

Search YouTube by TopicIt uses the Freebase list of topics

Description

Search YouTube by TopicIt uses the Freebase list of topics

Usage

yt_topic_search(topic = NULL, ...)

Arguments

Value

a list

Examples

 ## Not run: # Set API token via yt_oauth() firstyt_topic_search(topic = "Barack Obama")## End(Not run)