R/BoardPinsByID.R

In rpinterest: Access Pinterest API

#'Get board pins using board ID
#'
#'Get information about all the pins on a pinterest board using the board ID.
#'
#'Takes a board ID and an access token, returns a data.frame.
#'@param boardID a character string with a board ID.
#'@param token a character string with an access token generated at \url{https://developers.pinterest.com/tools/access_token/}
#'@return Always returns a data.frame, with a warning when appropriate.
#'@export
#'@importFrom magrittr %>%
#'@importFrom httr GET
#'@importFrom rjson fromJSON
#'@examples
#'BoardPinsByID(boardID = "42080646457333782", token = "your_token")

BoardPinsByID <- function(boardID, token) {
  . <- NULL 
  default <- data.frame(pin_id = vector("character"), 
                    creator_name = vector("character"), 
                    creator_id = vector("character"), 
                    type = vector("character"), 
                    original_link = vector("character"), 
                    pin_note = vector("character"), 
                    pin_color = vector("character"), 
                    pin_link = vector("character"), 
                    pin_board_name = vector("character"), 
                    pin_board_url = vector("character"), 
                    pin_board_id = vector("character"), 
                    pins_likes = vector("character"), 
                    pins_comments = vector("character"), 
                    pins_repins = vector("character"), 
                    attribution_title = vector("character"), 
                    attribution_author = vector("character"), 
                    attribution_url = vector("character"), 
                    attribution_provider = vector("character"), 
                    stringsAsFactors = FALSE)
  url <- paste0("https://api.pinterest.com/v1/boards/", boardID, "/pins/?access_token=", token, "&fields=id%2Clink%2Cnote%2Curl%2Cattribution%2Ccolor%2Cboard%2Ccounts%2Ccreated_at%2Ccreator%2Cimage%2Cmedia%2Cmetadata%2Coriginal_link")
  name <- httr::GET(url)
  if (name$status_code == 200){
    content <- rjson::fromJSON(rawToChar(name$content))
    contentdata <- content$data
    if(!is.null(content$page$`next`)){
      repeat{
        url <- content$page$`next`
        name <- httr::GET(url)
        content <- rjson::fromJSON(rawToChar(name$content))
        contentdata <- c(contentdata, content$data)
        if(is.null(content$page$`next`)){
          break
        }
      }
    }
    identity <- lapply(contentdata, function(obj){
      data.frame(pin_id = obj$id %||% NA, 
                 creator_first_name = obj$creator$first_name %||% NA, 
                 creator_last_name = obj$creator$last_name %||% NA, 
                 creator_id = obj$creator$id %||% NA, 
                 type = obj$media$type %||% NA, 
                 original_link = obj$original_link %||% NA, 
                 pin_note = obj$note %||% NA, 
                 pin_color = obj$color %||% NA, 
                 pin_link = obj$link %||% NA, 
                 pin_board_name = obj$board$name %||% NA, 
                 pin_board_url = obj$board$url %||% NA, 
                 pin_board_id = obj$board$id %||% NA, 
                 pins_likes = obj$counts$likes %||% NA, 
                 pins_comments = obj$counts$comments %||% NA, 
                 pins_repins = obj$counts$repins %||% NA, 
                 attribution_title = obj$attribution$title %||% NA, 
                 attribution_author = obj$attribution$author_name %||% NA, 
                 attribution_url = obj$attribution$author_url %||% NA, 
                 attribution_provider = obj$attribution$provider_name %||% NA, 
                 stringsAsFactors = FALSE)
    }) %>% do.call(rbind, .)  
  } else {
    warning("Request error: your token may not be valid, or your input not an actual board ID")
    identity <- default
  }
  return(identity)
}