#' Get list of categories that can be associated with YouTube channels
#'
#'
#' @param filter string; Required.
#' named vector of length 1
#' potential names of the entry in the vector:
#' \code{region_code}: Character. Required. Has to be a ISO 3166-1 alpha-2 code
#' (see \url{https://www.iso.org/obp/ui/#search})
#' \code{category_id}: YouTube channel category ID
#'
#' @param hl Language used for text values. Optional. Default is \code{en-US}.
#' For other allowed language codes, see \code{\link{list_langs}}.
#' @param \dots Additional arguments passed to \code{\link{tuber_GET}}.
#'
#' @return data.frame with 5 columns: \code{region_code, channelId, title,
#' etag, id}
#'
#' @export
#'
#' @references \url{https://developers.google.com/youtube/v3/docs/guideCategories/list}
#'
#' @examples
#' \dontrun{
#'
#' # Set API token via yt_oauth() first
#'
#' list_guidecats(c(region_code = "JP"))
#' }
list_guidecats <- function(filter = NULL, hl = NULL, ...) {
if (!is.character(filter) || length(filter) != 1) {
stop("filter must be a character vector of length 1.")
}
translate_filter <- c(category_id = "id", region_code = "regionCode")
yt_filter_name <- translate_filter[names(filter)]
names(filter) <- yt_filter_name
if (sum(is.na(names(filter))) > 0) {
stop("Filter can only have region_code or category_id.")
}
querylist <- list(part = "snippet", hl = hl, filter)
res <- tuber_GET("guideCategories", querylist, ...)
resdf <- data.frame(region_code = character(),
channelId = character(),
title = character(),
etag = character(),
id = character(),
stringsAsFactors = FALSE)
# Cat total results
cat("Total Number of Categories:", length(res$items), "\n")
if (length(res$items) > 0) {
simple_res <- lapply(res$items, function(x) c(unlist(x$snippet), etag = x$etag, id = x$id))
resdf <- do.call(rbind, simple_res)
resdf$region_code <- filter["regionCode"]
} else {
resdf$region_code <- filter["regionCode"]
}
resdf
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.