R/live_onDemand.R

In davisj95/YTAnalytics: Wrapper for 'YouTube Analytics' API

#' Video Live & OnDemand Data
#' 
#' @description
#' Return video data split by live & on demand.
#'
#' @param videoId Required.String. Id of YouTube video.
#' @param ... Addt. arguments passed to \code{analytics_request}
#'
#' @return data.frame
#' @export
#'
#' @examples
#' \dontrun{
#' video_live_onDemand(videoId = "dQw4w9WgXcQ")
#' }

video_live_onDemand <- function(videoId = NULL, ...) {
  
  results <- data.frame()
  pb <- prog_bar(length(videoId))
  for(i in 1:length(videoId)) {
    pb$tick()
    temp <- analytics_request(dimensions = "liveOrOnDemand",
                              filters = paste0("video==", videoId[i]), ...)
    
    results <- dplyr::bind_rows(results, error_checking(temp, videoId[i], "video"))
  }

  return(results)
}


#' Playlist Live & OnDemand Data
#' 
#' @description
#' Return playlist data split by live & on demand.
#'
#' @param playlistId Required. String. Id of YouTube playlist.
#' @param ... Addt. arguments passed to \code{analytics_request}
#'
#' @return data.frame
#' @export
#'
#' @examples
#' \dontrun{
#' playlist_live_onDemand(playlistId = "PL2MI040U_GXq1L5JUxNOulWCyXn-7QyZK")
#' }

playlist_live_onDemand <- function(playlistId = NULL, ...) {
  
  results <- data.frame()
  pb <- prog_bar(length(playlistId))
  for(i in 1:length(playlistId)) {
    pb$tick()
    temp <- analytics_request(dimensions = "liveOrOnDemand",
                              filters = paste0("playlist==", playlistId[i], ";isCurated==1"), ...)
    
    results <- dplyr::bind_rows(results, error_checking(temp, playlistId[i], "playlist"))
  }
  
  return(results)
}


#' Channel Live & OnDemand Data
#' 
#' @description
#' Return channel data split by live & on demand.
#'
#' @param ... Addt. arguments passed to \code{analytics_request}
#'
#' @return data.frame()
#' @export
#'
#' @examples
#' \dontrun{
#' channel_live_onDemand()
#' }

channel_live_onDemand <- function(...) {
  temp <- analytics_request(dimensions = "liveOrOnDemand", ...)
  return(temp)
}