facebook.S4 (version 1.1.0)

FacebookPagesCollection: Build a collection of Facebook pages

Description

Connect to Facebook Graph API, get information from a list of public Facebook pages and build a FacebookPagesCollection-class instance.

Usage

FacebookPagesCollection(id, token = NULL, parameters = list(),
  fields = c("id", "username", "name", "about", "category", "description",
  "fan_count", "link", "talking_about_count"), metadata = FALSE,
  .progress = create_progress_bar())

Arguments

id

A character vector or a comma-delimited string of IDs or an existing Facebook Collection of any of the supported types (see below).

token

Either a temporary access token created at https://developers.facebook.com/tools/explorer or the OAuth token created with fbOAuth. If token NULL and id is a collection, use the token of the source collection. Otherwise, no query is performed to the Facebook Graph API and an empty collection is returned.

parameters

A list of parameters to be added to the Facebook Graph API query. For more information on the accepted parameters, see: https://developers.facebook.com/docs/graph-api/using-graph-api.

fields

A character vector with the fields to get for each id. If no value for a given field is found, it will be set to NULL.

metadata

If set to TRUE, the metadata for each ID is pulled with the data and the type slot is fed accordingly. Please note that setting this to TRUE could considerably slow down the execution time, as more queries are needed.

.progress

progress_bar object as defined in the plyr package. By default the none progress bar is used, which prints nothing to the console. See create_progress_bar for details.

Value

A collection of pages in a FacebookPagesCollection-class object.

Nesting fields

Due to the network-graph nature of Facebook data model, you can specify fields details for each field nesting .fields() clauses.

For example, if you need only id and source for the cover field, this is valid among others: cover.fields(id,source).

Following the same philosophy, if you need only id and name for the from node you can use from.fields(id,name).

Valid sources

Instead of a character vector, one of these collections can also be passed as parameter in id:

• FacebookPagesCollection-class will build a collection with the same elements as the source collection.

• FacebookMixedCollection-class will build a collection with only the page elements of the source collection.

Details

FacebookPagesCollection is the constructor for the FacebookPagesCollection-class. It returns data about pages but doesn't return lists of posts or the fanbase (although it will return a summary view for the latter).

See Also

FacebookPostsCollection, FacebookCommentsCollection, fbOAuth

Other Facebook Collection Constructors: FacebookAlbumsCollection, FacebookCommentsCollection, FacebookConversationsCollection, FacebookEventsCollection, FacebookGroupsCollection, FacebookLikesCollection, FacebookMessagesCollection, FacebookPhotosCollection, FacebookPostsCollection, FacebookReactionsCollection, FacebookUsersCollection, FacebookVideosCollection

Examples

# NOT RUN {
## See examples for fbOAuth to know how token was created.
 load("fb_oauth")
 
## Getting information about 9th Circle Games' Facebook Page
fb.pages <- FacebookPagesCollection(id = c("9thcirclegames", 
                                           "NathanNeverSergioBonelliEditore"),
                                    token = fb_oauth)

## Getting informations from the same pages, but with a different set of fields
 fb.pages.covers <- FacebookPagesCollection(id = fb.pages,
                                            fields = c("id",
                                                       "name",
                                                       "cover.fields(id,source,height,width)")
                                            )
 
## Convert the collection to a data frame
 fb.pages.df <- as.data.frame(fb.pages)
 
## Build a collection of the pages the current user likes
 likes.pages <- FacebookUsersCollection("me", fb_token, fields = "") %>%
   facebook.object.likes() %>% 
   FacebookPagesCollection()
# }
# NOT RUN {
# }