Facebook Connector for CData Sync

Build 22.0.8462
  • Facebook
    • Establishing a Connection
      • Insight Mapping
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Likes
        • Posts
      • Views
        • Comments
        • Events
        • Groups
        • InsightsByConsumptionType
        • InsightsByFeedbackType
        • InsightsByLikeSourceType
        • InsightsByReactionTotals
        • InsightsByStoryType
        • InsightsByTabType
        • InsightsByUnLikeSourceType
        • InstagramAccountInsights
        • Pages
        • Permissions
        • Photos
        • Places
        • Ratings
        • SimpleInsights
        • SimpleVideoInsights
        • StoryAttachments
        • TaggedBy
        • Users
        • VideoInsightsByActionType
        • VideoInsightsByDistributionType
        • VideoInsightsByReactionType
        • Videos
        • Wall
    • Connection String Options
      • Authentication
        • Version
        • AuthenticateAsPage
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • AggregateFormat
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • Target
        • Timeout
        • UploadLinkedMedia
        • UserDefinedViews

Facebook Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Facebook data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Facebook connector can be used from the CData Sync application to pull data from Facebook and move it to any of the supported destinations.

Facebook Connector for CData Sync

Establishing a Connection

Create a connection to Facebook by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Facebook icon is not available, click the Add More icon to download and install the Facebook connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Facebook

The following are optional connection properties:

  • Target: Some Facebook tables can be filtered by a target. For example, to retrieve comments on a video, specify the Id of the video as the target. This property enables you to restrict the results of all queries in the connection to records that match the specified target. You can also specify this restriction per query with the Target column.
  • AggregateFormat: The Sync App returns some columns as a string aggregate. For example, the available likes data for an entity is returned in aggregate. By default, the Sync App returns aggregate columns in JSON. You can also return aggregates in XML.
  • Version: Set this property to the Facebook API version if you need to work with a different version than the default.

Authenticating to Facebook

Facebook uses the OAuth standard to authenticate users.

OAuth

In all OAuth flows, you must set AuthScheme to OAuth. The sections below assume that you have done so.

Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Facebook. See Creating a Custom OAuth App for more information about custom applications. You can then use the Sync App to get and manage the OAuth token values. Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • AuthScheme: Set this to AzureAD.
  • OAuthClientId: Set this to the client Id in your application settings.
  • OAuthClientSecret: Set this to the client secret in your application settings
  • Scope (optional): Set this if you need to customizie the permissions that the driver requests.
  • AuthenticateAsPage (optional): Set this to a page name or Id to make requests as a page. The page must be managed by the authenticated user.

Then call stored procedures to complete the OAuth exchange:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings. If necessary, set the "Permissions" parameter to request custom permissions.
  2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
  3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the "Permissions" parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Creating a custom OAuth app is optional in the headless OAuth flow; you can skip creating an app by connecting with the driver's embedded OAuth credentials. You might want to create a custom OAuth app to change the information displayed when users log into Facebook to grant permissions to the driver. See Creating a Custom OAuth App for more information about creating custom OAuth applications.

  1. Choose one of these two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the Sync App on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the Sync App to automatically refresh the access token from the headless machine.
This section describes the procedure to authenticate and connect to data.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. If you are using the Embedded OAuth Application:
    1. Call the GetOAuthAuthorizationURL stored procedure.
    2. Click Facebook OAuth endpoint to open the endpoint in your browser.
  2. If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
    • InitiateOAuth: Set to OFF.
    • OAuthClientId: Set to the client Id assigned when you registered your application.
    • OAuthClientSecret: Set to the client secret assigned when you registered your application.
  3. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURI input parameter set to the exact Redirect URI you specified in your application settings.
  4. Open the URL returned by the stored procedure in a browser.
  5. Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
  6. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Finally, on the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • OAuthClientId: Set to the Client ID in your OAuth Integration settings.
  • OAuthClientSecret: Set to the Client Secret in your OAuth Integration settings.
  • OAuthVerifier: Set to the verifier code.
  • OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified file.
  • InitiateOAuth: Set to REFRESH.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set to REFRESH.

Option 2: Transfer OAuth Settings

To install the Sync App on another machine, authenticate, and then transfer the resulting OAuth values:

  1. On a second machine, install the Sync App and connect with the following properties set:
    • OAuthSettingsLocation: Set to a writable text file.
    • OAuthClientId: Set to the client ID in your app settings.
    • OAuthClientSecret: Set to the client secret in your app settings.
    • CallbackURL: Set to the callback URL in your app settings.
  2. Test the connection to authenticate. The resulting authentication values are written and encrypted to the path specified by OAuthSettingsLocation. After you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
    • InitiateOAuth: Set to REFRESH.
    • OAuthSettingsLocation: Set to the path to your OAuth settings file. Make sure this file gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Requesting Additional Permissions

You may find while using the Sync App that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you must generate a new OAuth access token with the required permissions. Set the Scope property in the authentication step.

Web applications need to call the GetOAuthAuthorizationURL and GetOAuthAccessToken stored procedures, which have inputs for the permissions you would like to request.

Note that these are comma-separated lists of permissions, so you can request more than one per authorization request. You can find a list of available Facebook permissions here:

http://developers.facebook.com/docs/authentication/permissions/

AuthenticateAsPage Property

Use the AuthenticateAsPage connection property if you want to post as a single page. To query collections of pages, leave AuthenticateAsPage blank, in which case CData tools automatically detect which page tokens to use.

The following sections compare the two options.

Posting as a Page

After authenticating to Facebook with your user account, you can post, etc. as one of the pages you manage: Set the AuthenticateAsPage property to the Id of the page you want. You can find the Ids for all pages your account has access to by querying the Pages view.

Automatic Page

Facebook has made a number of recent changes that require page tokens for most resources owned by a page. This can be troublesome if you manage multiple pages and want to execute the same queries across all pages (such as retrieving Insights). In order to make this work seamlessly with our tools, we have added a way to automatically detect the page token to use. For this to work, simply do not specify the AuthenticateAsPage. Note that the correct page token can only be resolved if the page id is specified as part of the target in the request. This means for some requests you will still need to manually specify AuthenticateAsPage.

Facebook Connector for CData Sync

Insight Mapping

Below is a mapping of specific Facebook insights, which periods are available for them, what view they can be used from, and what types of targets are available. Since Facebook frequently makes changes to the available insights, we also include a table indicating which insights have been removed recently from Facebook, and the previous name for an insight if it has been renamed.

Current Insights

View or Stored Procedure Insight Name Available Periods Target Type Previous Name
SimpleInsights PAGE_ACTIONS_POST_REACTIONS_ANGER_TOTAL day page
SimpleInsights PAGE_ACTIONS_POST_REACTIONS_HAHA_TOTAL day page
SimpleInsights PAGE_ACTIONS_POST_REACTIONS_LIKE_TOTAL day page
SimpleInsights PAGE_ACTIONS_POST_REACTIONS_LOVE_TOTAL day page
SimpleInsights PAGE_ACTIONS_POST_REACTIONS_SORRY_TOTAL day page
SimpleInsights PAGE_ACTIONS_POST_REACTIONS_WOW_TOTAL day page
SimpleInsights PAGE_CONSUMPTIONS day, week, days_28 page
SimpleInsights PAGE_CONSUMPTIONS_UNIQUE day, week, days_28 page
SimpleInsights PAGE_ENGAGED_USERS day, week, days_28 page
SimpleInsights PAGE_FAN_ADDS day page
SimpleInsights PAGE_FAN_ADDS_UNIQUE day, week, days_28 page
SimpleInsights PAGE_FAN_REMOVES day page
SimpleInsights PAGE_FAN_REMOVES_UNIQUE day page
SimpleInsights PAGE_FANS day page
SimpleInsights PAGE_FANS_ONLINE day page
SimpleInsights PAGE_FANS_ONLINE_PER_DAY day page
SimpleInsights PAGE_IMPRESSIONS day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_FREQUENCY_DISTRIBUTION day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_ORGANIC day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_ORGANIC_UNIQUE day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_PAID day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_PAID_UNIQUE day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_UNIQUE day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_VIRAL day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_VIRAL_FREQUENCY_DISTRIBUTION day, week, days_28 page
SimpleInsights PAGE_IMPRESSIONS_VIRAL_UNIQUE day, week, days_28 page
SimpleInsights PAGE_NEGATIVE_FEEDBACK day, week, days_28 page
SimpleInsights PAGE_NEGATIVE_FEEDBACK_UNIQUE day, week, days_28 page
SimpleInsights PAGE_PLACES_CHECKIN_MOBILE day, week, days_28 page
SimpleInsights PAGE_PLACES_CHECKIN_MOBILE_UNIQUE day, week, days_28 page
SimpleInsights PAGE_PLACES_CHECKIN_TOTAL day, week, days_28 page
SimpleInsights PAGE_PLACES_CHECKIN_TOTAL_UNIQUE day, week, days_28 page
SimpleInsights PAGE_POST_ENGAGEMENTS day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS_ORGANIC day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS_ORGANIC_UNIQUE day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS_PAID day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS_PAID_UNIQUE day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS_UNIQUE day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS_VIRAL day, week, days_28 page
SimpleInsights PAGE_POSTS_IMPRESSIONS_VIRAL_UNIQUE day, week, days_28 page
SimpleInsights PAGE_CONTENT_ACTIVITY day, week, days_28 page PAGE_STORIES
SimpleInsights PAGE_VIDEO_COMPLETE_VIEWS_30S day, week, days_28 page
SimpleInsights PAGE_VIDEO_COMPLETE_VIEWS_30S_AUTOPLAYED day, week, days_28 page
SimpleInsights PAGE_VIDEO_COMPLETE_VIEWS_30S_CLICK_TO_PLAY day, week, days_28 page
SimpleInsights PAGE_VIDEO_COMPLETE_VIEWS_30S_ORGANIC day, week, days_28 page
SimpleInsights PAGE_VIDEO_COMPLETE_VIEWS_30S_PAID day, week, days_28 page
SimpleInsights PAGE_VIDEO_COMPLETE_VIEWS_30S_REPEAT_VIEWS day, week, days_28 page
SimpleInsights PAGE_VIDEO_COMPLETE_VIEWS_30S_UNIQUE day, week, days_28 page
SimpleInsights PAGE_VIDEO_REPEAT_VIEWS day, week, days_28 page
SimpleInsights PAGE_VIDEO_VIEWS day, week, days_28 page
SimpleInsights PAGE_VIDEO_VIEWS_AUTOPLAYED day, week, days_28 page
SimpleInsights PAGE_VIDEO_VIEWS_CLICK_TO_PLAY day, week, days_28 page
SimpleInsights PAGE_VIDEO_VIEWS_ORGANIC day, week, days_28 page
SimpleInsights PAGE_VIDEO_VIEWS_PAID day, week, days_28 page
SimpleInsights PAGE_VIDEO_VIEWS_UNIQUE day, week, days_28 page
SimpleInsights PAGE_VIEWS_TOTAL day, week, days_28 page PAGE_VIEWS
SimpleInsights PAGE_VIEWS_LOGGED_IN_TOTAL day, week, days_28 page PAGE_VIEWS_LOGIN
SimpleInsights PAGE_VIEWS_LOGGED_IN_UNIQUE day, week, days_28 page PAGE_VIEWS_LOGIN_UNIQUE
SimpleInsights PAGE_VIEWS_LOGOUT day page
SimpleInsights POST_CLICKS lifetime post POST_CONSUMPTIONS
SimpleInsights POST_CLICKS_UNIQUE lifetime post POST_CONSUMPTIONS_UNIQUE
SimpleInsights POST_ENGAGED_USERS lifetime post
SimpleInsights POST_IMPRESSIONS lifetime post
SimpleInsights POST_IMPRESSIONS_FAN lifetime post
SimpleInsights POST_IMPRESSIONS_FAN_PAID lifetime post
SimpleInsights POST_IMPRESSIONS_FAN_PAID_UNIQUE lifetime post
SimpleInsights POST_IMPRESSIONS_FAN_UNIQUE lifetime post
SimpleInsights POST_IMPRESSIONS_ORGANIC lifetime post
SimpleInsights POST_IMPRESSIONS_ORGANIC_UNIQUE lifetime post
SimpleInsights POST_IMPRESSIONS_PAID lifetime post
SimpleInsights POST_IMPRESSIONS_PAID_UNIQUE lifetime post
SimpleInsights POST_IMPRESSIONS_UNIQUE lifetime post
SimpleInsights POST_IMPRESSIONS_VIRAL lifetime post
SimpleInsights POST_IMPRESSIONS_VIRAL_UNIQUE lifetime post
SimpleInsights POST_NEGATIVE_FEEDBACK lifetime post
SimpleInsights POST_NEGATIVE_FEEDBACK_UNIQUE lifetime post
SimpleInsights POST_ACTIVITY lifetime post POST_STORIES
SimpleInsights POST_ACTIVITY_UNIQUE lifetime post POST_STORYTELLERS
SimpleInsights POST_VIDEO_AVG_TIME_WATCHED lifetime post
SimpleInsights POST_VIDEO_COMPLETE_VIEWS_ORGANIC lifetime post
SimpleInsights POST_VIDEO_COMPLETE_VIEWS_ORGANIC_UNIQUE lifetime post
SimpleInsights POST_VIDEO_COMPLETE_VIEWS_PAID lifetime post
SimpleInsights POST_VIDEO_COMPLETE_VIEWS_PAID_UNIQUE lifetime post
SimpleInsights POST_VIDEO_LENGTH lifetime post
SimpleInsights POST_VIDEO_VIEW_TIME lifetime post
SimpleInsights POST_VIDEO_VIEW_TIME_ORGANIC lifetime post
SimpleInsights POST_VIDEO_VIEWS_10S lifetime post
SimpleInsights POST_VIDEO_VIEWS_10S_AUTOPLAYED lifetime post
SimpleInsights POST_VIDEO_VIEWS_10S_CLICKED_TO_PLAY lifetime post
SimpleInsights POST_VIDEO_VIEWS_10S_ORGANIC lifetime post
SimpleInsights POST_VIDEO_VIEWS_10S_PAID lifetime post
SimpleInsights POST_VIDEO_VIEWS_10S_SOUND_ON lifetime post
SimpleInsights POST_VIDEO_VIEWS_10S_UNIQUE lifetime post
SimpleInsights POST_VIDEO_VIEWS_ORGANIC lifetime post
SimpleInsights POST_VIDEO_VIEWS_ORGANIC_UNIQUE lifetime post
SimpleInsights POST_VIDEO_VIEWS_PAID lifetime post
SimpleInsights POST_VIDEO_VIEWS_PAID_UNIQUEPOST_VIDEO_VIEWS_SOUND_ON lifetime post
InsightsByConsumptionType PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE day, week, days_28 page
InsightsByConsumptionType PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE_UNIQUE day, week, days_28 page
InsightsByConsumptionType POST_CLICKS_BY_TYPE lifetime post POST_CONSUMPTIONS_BY_CONSUMPTION_TYPE
InsightsByConsumptionType POST_CLICKS_BY_TYPE_UNIQUE lifetime post POST_CONSUMPTIONS_BY_CONSUMPTION_TYPE_UNIQUE
InsightsByFeedbackType PAGE_NEGATIVE_FEEDBACK_BY_TYPE day, week, days_28 page
InsightsByFeedbackType PAGE_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE day, week, days_28 page
InsightsByFeedbackType PAGE_POSITIVE_FEEDBACK_BY_TYPE day, week, days_28 page
InsightsByFeedbackType PAGE_POSITIVE_FEEDBACK_BY_TYPE_UNIQUE day, week, days_28 page
InsightsByFeedbackType POST_NEGATIVE_FEEDBACK_BY_TYPE lifetime post
InsightsByFeedbackType POST_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE lifetime post
InsightsByLikeSourceType PAGE_FANS_BY_LIKE_SOURCE day page
InsightsByLikeSourceType PAGE_FANS_BY_LIKE_SOURCE_UNIQUE day page
InsightsByUnLikeSourceType PAGE_FANS_BY_UNLIKE_SOURCE day page
InsightsByUnLikeSourceType PAGE_FANS_BY_UNLIKE_SOURCE_UNIQUE day page
InsightsByReactionTotals PAGE_ACTIONS_POST_REACTIONS_TOTAL day page
InsightsByReactionTotals POST_REACTIONS_BY_TYPE_TOTAL day page
InsightsByStoryType PAGE_CONTENT_ACTIVITY_BY_ACTION_TYPE day, week, days_28 page PAGE_STORIES_BY_STORY_TYPE
InsightsByStoryType PAGE_IMPRESSIONS_BY_STORY_TYPE day, week, days_28 page
InsightsByStoryType PAGE_IMPRESSIONS_BY_STORY_TYPE_UNIQUE day, week, days_28 page
InsightsByStoryType POST_IMPRESSIONS_BY_STORY_TYPE day, week, days_28 page
InsightsByStoryType POST_IMPRESSIONS_BY_STORY_TYPE_UNIQUE day, week, days_28 page
InsightsByTabType PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE day, week page
InsightsByTabType PAGE_TAB_VIEWS_LOGIN_TOP day, week page
InsightsByTabType PAGE_TAB_VIEWS_LOGOUT_TOP day page
SimpleVideoInsights PAGE_VIDEO_VIEW_TIME day page
SimpleVideoInsights TOTAL_VIDEO_VIEWS lifetime video
SimpleVideoInsights TOTAL_VIDEO_VIEWS_UNIQUE lifetime video
SimpleVideoInsights TOTAL_VIDEO_VIEWS_AUTOPLAYED lifetime video
SimpleVideoInsights TOTAL_VIDEO_VIEWS_CLICKED_TO_PLAY lifetime video
SimpleVideoInsights TOTAL_VIDEO_VIEWS_SOUND_ON lifetime video
SimpleVideoInsights TOTAL_VIDEO_COMPLETE_VIEWS lifetime video
SimpleVideoInsights TOTAL_VIDEO_COMPLETE_VIEWS_UNIQUE lifetime video
SimpleVideoInsights TOTAL_VIDEO_COMPLETE_VIEWS_AUTO_PLAYED lifetime video
SimpleVideoInsights TOTAL_VIDEO_COMPLETE_VIEWS_CLICKED_TO_PLAY lifetime video
SimpleVideoInsights TOTAL_VIDEO_10S_VIEWS lifetime video
SimpleVideoInsights TOTAL_VIDEO_10S_VIEWS_UNIQUE lifetime video
SimpleVideoInsights TOTAL_VIDEO_10S_VIEWS_auto_played lifetime video
SimpleVideoInsights TOTAL_VIDEO_10S_VIEWS_CLICKED_TO_PLAY lifetime video
SimpleVideoInsights TOTAL_VIDEO_10S_VIEWS_SOUND_ON lifetime video
SimpleVideoInsights TOTAL_VIDEO_AVG_TIME_WATCHED lifetime video
SimpleVideoInsights TOTAL_VIDEO_VIEW_TOTAL_TIME lifetime video
SimpleVideoInsights TOTAL_VIDEO_IMPRESSIONS lifetime video
SimpleVideoInsights TOTAL_VIDEO_IMPRESSIONS_UNIQUE lifetime video
SimpleVideoInsights TOTAL_VIDEO_IMPRESSIONS_VIRAL_UNIQUE lifetime video
SimpleVideoInsights TOTAL_VIDEO_IMPRESSIONS_VIRAL lifetime video
SimpleVideoInsights TOTAL_VIDEO_IMPRESSIONS_FAN_UNIQUE lifetime video
SimpleVideoInsights TOTAL_VIDEO_IMPRESSIONS_FAN lifetime video
VideoInsightsByActionType TOTAL_VIDEO_STORIES_BY_ACTION_TYPE lifetime video
VideoInsightsByDistributionType TOTAL_VIDEO_VIEWS_BY_DISTRIBUTION_TYPE lifetime video
VideoInsightsByDistributionType TOTAL_VIDEO_VIEW_TIME_BY_DISTRIBUTION_TYPE lifetime video
VideoInsightsByReactionType TOTAL_VIDEO_REACTIONS_BY_TYPE_TOTAL lifetime video
CreateInsightSchema PAGE_CONTENT_ACTIVITY_BY_AGE_GENDER_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_AGE_GENDER
CreateInsightSchema PAGE_CONTENT_ACTIVITY_BY_CITY_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_CITY
CreateInsightSchema PAGE_CONTENT_ACTIVITY_BY_COUNTRY_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_COUNTRY
CreateInsightSchema PAGE_CONTENT_ACTIVITY_BY_LOCALE_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_LOCALE
CreateInsightSchema PAGE_IMPRESSIONS_BY_CITY_UNIQUE day, week, days_28 page
CreateInsightSchema PAGE_IMPRESSIONS_BY_COUNTRY_UNIQUE day, week, days_28 page
CreateInsightSchema PAGE_IMPRESSIONS_BY_LOCALE_UNIQUE day, week, days_28 page
CreateInsightSchema PAGE_IMPRESSIONS_BY_AGE_GENDER_UNIQUE day, week, days_28 page
CreateInsightSchema PAGE_PLACES_CHECKINS_BY_AGE_GENDER day page
CreateInsightSchema PAGE_PLACES_CHECKINS_BY_LOCALE day page
CreateInsightSchema PAGE_PLACES_CHECKINS_BY_COUNTRY day page
CreateInsightSchema PAGE_FANS_LOCALE day page
CreateInsightSchema PAGE_FANS_CITY day page
CreateInsightSchema PAGE_FANS_COUNTRY day page
CreateInsightSchema PAGE_FANS_GENDER_AGE day page
CreateInsightSchema PAGE_VIEWS_EXTERNAL_REFERRALS day page
CreateInsightSchema POST_STORIES_BY_ACTION_TYPE lifetime post
CreateInsightSchema POST_STORYTELLERS_BY_ACTION_TYPE lifetime post
CreateInsightSchema PAGE_POSTS_IMPRESSIONS_FREQUENCY_DISTRIBUTION day, week, days_28 post
CreateInsightSchema POST_VIDEO_RETENTION_GRAPH lifetime post

Insights Removed By Facebook

View or Stored Procedure Insight Name Available Periods Target Type
SimpleInsights PAGE_VIEWS_UNIQUE day, week page
InsightsByPaidStatus PAGE_STORYTELLERS_BY_STORY_TYPE day, week, days_28 page
InsightsByPaidStatus POST_IMPRESSIONS_BY_PAID_NON_PAID lifetime page
InsightsByPaidStatus PAGE_IMPRESSIONS_BY_PAID_NON_PAID day, week, days_28 page
InsightsByPaidStatus PAGE_IMPRESSIONS_BY_PAID_NON_PAID_UNIQUE day, week, days_28 page
InsightsByPaidStatus POST_IMPRESSIONS_BY_PAID_NON_PAID_UNIQUE lifetime page
InsightsByPaidStatus PAGE_POSTS_IMPRESSIONS_BY_PAID_NON_PAID day, week, days_28 page
InsightsByPaidStatus PAGE_POSTS_IMPRESSIONS_BY_PAID_NON_PAID_UNIQUE day, week, days_28 page

Facebook Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Facebook Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Facebook and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Facebook Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Facebook Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Facebook Connector for CData Sync

Data Model

The CData Sync App models Facebook APIs as relational Tables, Views, and Stored Procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables describes the available tables.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Facebook Connector for CData Sync

Tables

The Sync App models the data in Facebook into a list of tables that can be queried using standard SQL statements.

Generally, querying Facebook tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Facebook Connector for CData Sync Tables

Name Description
Likes Create, delete, and query the Likes for a Target. Alternatively, lists Pages that the specified User or Page Likes. Authentication is required to use this table.
Posts Create, delete, and query the Posts for a Target based on either the Target or Id. Posts can also be inserted based on a Target, or deleted based on Id. This table requires authentication.

Facebook Connector for CData Sync

Likes

Create, delete, and query the Likes for a Target. Alternatively, lists Pages that the specified User or Page Likes. Authentication is required to use this table.

Table Specific Information

Likes in Facebook represent the users that like a particular target. The target may be a post, page, picture, or other type of valid entity that may have likes associated with it.

Select

When selecting likes, specify a target. The target represents the username or Id of the entity that likes are being retrieved for. For example:

SELECT Id, Name, Picture FROM Likes WHERE Target = '15526475270_410830705612736'

If a user or page is specified as the target for likes, then the pages that the user or page likes will be returned. For example:

SELECT Id, Name, Username, Category FROM Likes WHERE Target = 'facebook'

If no target is specified, the currently authenticated user will be used as the target. In this case, the pages that the authenticated user likes will be returned.

Insert

To insert a like or to like something, simply issue an INSERT statement and specify the target you are liking. The target must be an album, checkin, comment, photo, post, status update, or other object that can be liked. For example:

INSERT INTO Likes (Target) VALUES ('123456789_123456789')

Update

Facebook does not allow likes to be updated.

Delete

Facebook does not allow likes to be deleted.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The Id of a user who likes the target, which may or may not be combined with the target Id. The user Id will be after the final '_'.

Target [KEY] String False

The Id or username of the target being liked. This may be a post, page, picture, or other valid id with likes.

Name String True

The name of the user who likes the target. May alternatively be the name of a page.

Username String True

The username of a page when retrieving pages a page has liked.

Picture String True

Picture of the user who likes the target. May alternatively be the picture of a page.

Category String True

The category of the user or page.

CreatedTime Datetime True

The time the like was created, if available.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
offset String

Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Posts

Create, delete, and query the Posts for a Target based on either the Target or Id. Posts can also be inserted based on a Target, or deleted based on Id. This table requires authentication.

Table Specific Information

Posts in Facebook are posts to a user's profile feed. Posts can be made to a user, page, application, group, or event.

Select

When selecting posts, a target may be specified. The target represents a page or another valid entity that may have posts for it. If no target is specified, the authenticated user will be used as the target. For example, to retrieve posts made by a page:

SELECT * FROM Posts WHERE Target = 'PageId'

If you know the post Id, you can specify the Id to obtain information about the specific post. For example:

SELECT * FROM Posts WHERE Id = 'PostId'

When querying posts, elements may be retrieved by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Posts WHERE Target='facebook' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '2/1/2012'

Insert

To insert a post, you will need to specify the Target and Message of the post. For instance:

INSERT INTO Posts (Message, Target) VALUES ('My New Post', 'PageId')

Create a photo post by using the Link or ObjectId columns. With the Link column, specify the accessible URL of an image to add the post to. You can also create video posts:

INSERT INTO Posts (Message, Target, Link) VALUES ('My New Post', 'PageId' , 'http://imagerepo.net/testimage.png)'

INSERT INTO Posts (Message, Target, Link) VALUES ('My New Post', 'PageId' , 'http://samplevideos.net/newmovie.mp4)'

You can also set local files in the Link column to upload media. Note that you must set UploadLinkedMedia to true for this to work:

INSERT INTO Posts (Message, Target, Link) VALUES ('From Local', 'PageId' , 'file://D://test/sample.mp4')

With the ObjectId column, specify the ID of an unpublished photo in your account. To upload a photo without publishing it, use the UploadPhoto stored procedure. Video Ids are not supported:

INSERT INTO Posts (Message, Target, ObjectId) VALUES ('My New Post', 'PageId' , '43572')

Update

Facebook does not allow posts to be updated.

Delete

Posts can be deleted by issuing a DELETE statement and specifying the Id of the post. Please note that Facebook allows only posts created by your app to be deleted using your app.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The Id of the post.

Target String False

The Id or username of the target you are retrieving posts for or are posting to. This can be an event, group, page, or user.

FromId String True

Id of the user who made the post.

FromName String True

Name of the user who made the post.

FromPicture String True

Picture of the user who made the post.

FromCategory String True

Category of the user who made the post. FromCategory can only be retrieved if the other From* fields are not selected.

ToData String True

An aggregate of users the post was made to.

Message String False

The message of the post. A message is required when inserting a post.

MessageTags String True

An aggregate of objects tagged in the message such as users, pages, etc.

Attachments String True

An aggregate for the attachments of the post.

Picture String False

A link to the picture included in the post.

FullPicture String False

A link to the original picture included in the post. The one listed in Picture may be a resized smaller version.

Icon String True

Link to an icon representing the type of post.

Actions String True

An aggregate of available actions on the post such as commenting or liking.

CommentsCount Integer True

The number of comments for the post.

LikesCount Integer True

The number of times the post has been liked.

SharesCount Integer True

The number of times the post has been shared.

PlaceId String False

The Id of the location associated with the post, if any.

PlaceName String True

The name of the location associated with the post, if any.

ApplicationId String True

Id of the application this post came from.

ApplicationName String True

Name of the application this post came from.

ApplicationCanvasName String True

Information about the application used to create the entity.

ApplicationNamespace String True

Information about the application used to create the entity.

Story String True

Text of stories not intentionally generated by users, such as those generated when two users become friends; you must have the Include Recent Activity Stories migration enabled in your app to retrieve these stories. Requires the read_stream permission.

StoryTags String True

An aggregate of objects (users, pages, etc.) associated with the story.

LikesData String True

An aggregate of like data.

CommentsData String True

An aggregate of comments for this post.

CreatedTime Datetime True

When the post was created.

UpdatedTime Datetime True

When the post was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
TaggedUser String

If set to an Id or username, it will retrieve posts where the specified user has been tagged. Requires the read_stream permission.

LocationUser String

If set to an Id or username, it will retrieve location posts where the user has been tagged. Requires the user_photos and user_status permissions.

Facebook Connector for CData Sync

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Facebook Connector for CData Sync Views

Name Description
Comments Create, update, delete, and query the Comments for a Target. Comments may also be inserted based on a Target or deleted based on Id.
Events Query the Events for a Target such as a page id.
Groups Query the Pages based on the supplied Id.
InsightsByConsumptionType Allows retrieval of insights by consumption type.
InsightsByFeedbackType Allows retrieval of insights by feedback type.
InsightsByLikeSourceType Allows retrieval of insights by like source type.
InsightsByReactionTotals Allows retrieval of insights by like source type.
InsightsByStoryType Allows retrieval of insights by like story type.
InsightsByTabType Allows retrieval of insights by tab type..
InsightsByUnLikeSourceType Allows retrieval of insights by like source type.
InstagramAccountInsights Allows you to get insights for an Instagram Business Account. Requires the instagram_basic and instagram_manage_insights scopes.
Pages Query the Pages based on the supplied Id.
Permissions Query the Permissions the User has granted the current application.
Photos Query Photos associated with a Target. Accessing Photo information typically requires the user_photos permission.
Places Query the Places based on the supplied Id. Places are stored as Pages in Facebook.
Ratings List of ratings for a Facebook Page. This view requires authentication.
SimpleInsights Allows the retrieval of simple insights with a single value in the response.
SimpleVideoInsights Allows the retrieval of simple video insights with a single value in the response.
StoryAttachments Query attachments from a post or comment.
TaggedBy Query information about Posts, Statuses, Photos, and other entities that have tagged the User or Page. This view is a derivative of the Wall connection where only entries that have tagged the Target User or Page will be returned. In general it is only available for Pages.
Users Returns basic information about the authenticated user.
VideoInsightsByActionType Allows the retrieval of video insights by story action type.
VideoInsightsByDistributionType Allows the retrieval of video insights by distribution type.
VideoInsightsByReactionType Allows the retrieval of video insights by reaction type.
Videos Query Videos from a Target. Normally requires the user_videos permission.
Wall Query Posts from the Wall of a Target.

Facebook Connector for CData Sync

Comments

Create, update, delete, and query the Comments for a Target. Comments may also be inserted based on a Target or deleted based on Id.

Table Specific Information

Comments in Facebook are comments about a specific thing. They are always associated with a target, which is the item the comment is directed toward. For example, this could be a post, a picture, or a video. Using this table, you can list the comments for a specific target and also insert new comments about a target.

Select

When querying comments, either the Target or the Id of the comment must be specified. For example, to retrieve all the comments about a specific post, your SELECT statement could look something like this:

SELECT * FROM Comments WHERE Target = '15526475270_410830705612736'

Alternatively, you can specify the Id to retrieve a specific comment. For example:

SELECT * FROM Comments WHERE Id = '15526475270_410830705612736_5193593'

Columns

Name Type Description
ID [KEY] String The Id of the comment.
Target String The Id of the target you are retrieving comments for. This may be an album, checkin, link, note, photo, post, status update, or video.
FromId String Id of the user who made the comment.
FromName String Name of the user who made the comment.
FromPicture String Picture of the user who made the comment.
Message String The text of the comment.
MessageTags String Aggregate of tags contained in the message.
Likes Integer The number of likes the comment has.
CommentsCount Integer The number of comments in reply to this comment.
LikesData String Aggregate of likes information on the comment.
UserLikes Boolean Boolean indicating if the authenticated user likes the comment.
CanRemove Boolean Boolean indicating if the comment can be removed.
Attachments String An aggregate for the attachments of the post.
CreatedTime Datetime The time the comment was created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Events

Query the Events for a Target such as a page id.

Table Specific Information

Events in Facebook are events created by a user or page that mark a specific date when something will take place. Events may be queried by Target or Id.

Select

When selecting events, a target may be specified. The target represents a page that has created events. By default, this will be the currently authenticated user or page. For example, to retrieve events associated with a page:

SELECT * FROM Events WHERE Target = 'PageId'

If you know the event Id, you may also just specify the Id to obtain information about the specific event. For example:

SELECT * FROM Events WHERE Id = 'EventId'

Columns

Name Type Description
ID [KEY] String The Id of the event.
Target String The Id or username of the target you are retrieving events for or are posting events to. This may be a page or a user.
Name String The name of the event.
StartTime Datetime The start time of the event.
EndTime Datetime The end time of the event.
Timezone String The time zone the event will take place in.
Description String The description of the event.
Picture String A URL to the picture of the event.
OwnerId String The Id of the user that created the event.
OwnerName String The name of the user that created the event.
OwnerPicture String Picture of the user who created the event.
OwnerCategory String Category of the owner, if available.
Location String The location of the event, if specified.
LocationId String The Id of the location for the event.
LocationStreet String The street address of the event.
LocationCity String The the city for the event.
LocationState String The the state for the event.
LocationCountry String The the country for the event.
LocationZip String The the ZIP code of the event.
LocationLatitude String The latitude of the event.
LocationLongitude String The longitude of the event.
TicketUri String A URL to a location to buy tickets for this event.
UpdatedTime Datetime When the event was last updated.
AttendingCount Integer Number of people attending the event.
DeclinedCount Integer Number of people who declined the event.
InterestedCount Integer Number of people interested in the event.
MaybeCount Integer Number of people who maybe going to the event.
NoreplyCount Integer Number of people who did not reply to the event.

Facebook Connector for CData Sync

Groups

Query the Pages based on the supplied Id.

Table Specific Information

Groups are a place to communicate about shared interests with certain people. Groups may be queried by Id.

Select

If you know the groups Id, you may also just specify the Id to obtain information about the specific group. For example:

SELECT * FROM Groups WHERE Id = 'GroupId'

Columns

Name Type Description
ID [KEY] String The Group ID.
Name String The name of the Group.
Description String A brief description of the Group.
Email String The email address to upload content to the Group. Only current members of the Group can use this.
Icon String The URL for the Group's icon.
MemberCount Integer The number of members in the Group.
MemberRequestCount Integer The number of members in the Group.
CoverId String Id of the cover image for the group.
CoverSource String The URL to the cover image for the group.
CoverOffsetY String The y-axis offset of the cover image for the group.
CoverOffsetX String The x-axis offset of the cover image for the group.
Permissions String The permissions a User has granted for an app installed in the Group.
Privacy String The privacy setting of the Group. Possible values are CLOSED, OPEN, and SECRET. Requires an access token of an Admin of the Group.
UpdatedTime Datetime The last time the Group was updated (includes changes Group properties, Posts, and Comments). Requires an access token of an Admin of the Group.

Facebook Connector for CData Sync

InsightsByConsumptionType

Allows retrieval of insights by consumption type.

Table Specific Information

Insights by consumption type refers to any insights that can be retrieved from a page or post that measure how users consumed your content.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByConsumptionType WHERE Target = 'mypostid' AND InsightName = 'PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByConsumptionType WHERE Target = 'mypostid' AND InsightName = 'PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Datetime The most recent date this insight data is relevant for.
VideoPlay Long Insight column indication the total for the stated consumption type.
OtherClicks Long Insight column indication the total for the stated consumption type.
PhotoView Long Insight column indication the total for the stated consumption type.
LinkClicks Long Insight column indication the total for the stated consumption type.
ButtonClicks Long Insight column indication the total for the stated consumption type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE,PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE_UNIQUE,POST_CLICKS_BY_TYPE,POST_CLICKS_BY_TYPE_UNIQUE
Period String The period for the insight. This must always be specified.

The allowed values are day, week, days_28, lifetime.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByFeedbackType

Allows retrieval of insights by feedback type.

Table Specific Information

Insights by feedback type refers to any insights that can be retrieved from a page or post that measure what kind of feedback was left.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByFeedbackType WHERE Target = 'mypostid' AND InsightName = 'PAGE_POSITIVE_FEEDBACK_BY_TYPE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByFeedbackType WHERE Target = 'mypostid' AND InsightName = 'PAGE_POSITIVE_FEEDBACK_BY_TYPE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Like Long Insight column indication the total for the positive feedback type.
Comment Long Insight column indication the total for the positive feedback type.
Link Long Insight column indication the total for the positive feedback type.
Answer Long Insight column indication the total for the positive feedback type.
Claim Long Insight column indication the total for the positive feedback type.
Rsvp Long Insight column indication the total for the positive feedback type.
HideAllClicks Long Insight column indication the total for the negative feedback type.
HideClicks Long Insight column indication the total for the negative feedback type.
UnlikePageClicks Long Insight column indication the total for the negative feedback type.
ReportSpamClicks Long Insight column indication the total for the negative feedback type.
XButtonClicks Long Insight column indication the total for the negative feedback type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_NEGATIVE_FEEDBACK_BY_TYPE,PAGE_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE,PAGE_POSITIVE_FEEDBACK_BY_TYPE,PAGE_POSITIVE_FEEDBACK_BY_TYPE_UNIQUE,POST_NEGATIVE_FEEDBACK_BY_TYPE,POST_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE
Period String The period for the insight. This must always be specified.

The allowed values are day, week, days_28, lifetime.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByLikeSourceType

Allows retrieval of insights by like source type.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Ads Long Insight column indication the total for the like source type.
NewsFeed Long Insight column indication the total for the like source type.
Other Long Insight column indication the total for the like source type.
PageSuggestions Long Insight column indication the total for the like source type.
RestoredLikesFromReactivatedAccounts Long Insight column indication the total for the like source type.
Search Long Insight column indication the total for the like source type.
YourPage Long Insight column indication the total for the like source type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_FANS_BY_LIKE_SOURCE,PAGE_FANS_BY_LIKE_SOURCE_UNIQUE

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByReactionTotals

Allows retrieval of insights by like source type.

Table Specific Information

Insights by reaction total type refers to the reaction totals for your page or post.

Select

When selecting insights, a Target must be specified. This should be set to a page or post depending on the InsightName specified. You can set InsightName to 'PAGE_ACTIONS_POST_REACTIONS_TOTAL' or 'POST_REACTIONS_BY_TYPE_TOTAL', by default it will be 'PAGE_ACTIONS_POST_REACTIONS_TOTAL'. For instance:

SELECT * FROM InsightsByReactionTotals WHERE Target = 'mypageid' AND InsightName='PAGE_ACTIONS_POST_REACTIONS_TOTAL'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByReactionTotals WHERE Target = 'mypageid' AND InsightName='PAGE_ACTIONS_POST_REACTIONS_TOTAL' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Like Long Total like reactions.
Love Long Total love reactions.
Wow Long Total wow reactions.
Haha Long Total haha reactions.
Sorry Long Total sorry reactions.
Anger Long Total anger reactions.
Target String The target of the insight. This must always be specified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.
InsightName String Insight Name. The available values are: PAGE_ACTIONS_POST_REACTIONS_TOTAL,POST_REACTIONS_BY_TYPE_TOTAL

The default value is PAGE_ACTIONS_POST_REACTIONS_TOTAL.

Facebook Connector for CData Sync

InsightsByStoryType

Allows retrieval of insights by like story type.

Table Specific Information

Insights by story type refers to any insights that can be retrieved from a page or post that measure the types of stories that have occurred.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByStoryType WHERE Target = 'mypostid' AND InsightName = 'PAGE_STORIES_BY_STORY_TYPE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByStoryType WHERE Target = 'mypostid' AND InsightName = 'PAGE_STORIES_BY_STORY_TYPE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
UserPost Long Insight column indication the total for the stated story type.
PagePost Long Insight column indication the total for the stated story type.
Checkin Long Insight column indication the total for the stated story type.
Fan Long Insight column indication the total for the stated story type.
Question Long Insight column indication the total for the stated story type.
Coupon Long Insight column indication the total for the stated story type.
Event Long Insight column indication the total for the stated story type.
Mention Long Insight column indication the total for the stated story type.
Other Long Insight column indication the total for the stated story type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_CONTENT_ACTIVITY_BY_ACTION_TYPE,PAGE_IMPRESSIONS_BY_STORY_TYPE,PAGE_IMPRESSIONS_BY_STORY_TYPE_UNIQUE,POST_IMPRESSIONS_BY_STORY_TYPE,POST_IMPRESSIONS_BY_STORY_TYPE_UNIQUE
Period String The period for the insight. This must always be specified.

The allowed values are day, week, days_28, lifetime.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByTabType

Allows retrieval of insights by tab type..

Table Specific Information

Insights by tab type refers to any insights that can be retrieved from a page or post that measure what tab was used to view your content.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByTabType WHERE Target = 'mypostid' AND InsightName = 'PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByTabType WHERE Target = 'mypostid' AND InsightName = 'PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
About Long Insight column indication the total for the tab type.
Ads Long Insight column indication the total for the tab type.
Album Long Insight column indication the total for the tab type.
AllActivity Long Insight column indication the total for the tab type.
App Long Insight column indication the total for the tab type.
Community Long Insight column indication the total for the tab type.
Events Long Insight column indication the total for the tab type.
Home Long Insight column indication the total for the tab type.
Info Long Insight column indication the total for the tab type.
Insights Long Insight column indication the total for the tab type.
Jobs Long Insight column indication the total for the tab type.
Likes Long Insight column indication the total for the tab type.
Locations Long Insight column indication the total for the tab type.
Notes Long Insight column indication the total for the tab type.
Photos Long Insight column indication the total for the tab type.
PhotosAlbums Long Insight column indication the total for the tab type.
PhotosStream Long Insight column indication the total for the tab type.
Posts Long Insight column indication the total for the tab type.
Profile Long Insight column indication the total for the tab type.
ProfileAbout Long Insight column indication the total for the tab type.
ProfileCommunity Long Insight column indication the total for the tab type.
ProfileHome Long Insight column indication the total for the tab type.
ProfileInfo Long Insight column indication the total for the tab type.
ProfileLikes Long Insight column indication the total for the tab type.
ProfilePhotos Long Insight column indication the total for the tab type.
ProfilePosts Long Insight column indication the total for the tab type.
Reviews Long Insight column indication the total for the tab type.
Timeline Long Insight column indication the total for the tab type.
Videos Long Insight column indication the total for the tab type.
Wall Long Insight column indication the total for the tab type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE,PAGE_TAB_VIEWS_LOGIN_TOP,PAGE_TAB_VIEWS_LOGOUT_TOP
Period String The period for the insight. This must always be specified.

The allowed values are day, week.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByUnLikeSourceType

Allows retrieval of insights by like source type.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
DeactivatedOrMemorializedAccountRemovals Long Insight column indication the total for the like source type.
SuspiciousAccountRemovals Long Insight column indication the total for the like source type.
UnlikesFromPagePostsOrNewsFeed Long Insight column indication the total for the like source type.
UnlikesFromSearch Long Insight column indication the total for the like source type.
UnderageAccountRemovals Long Insight column indication the total for the like source type.
UnlikesFromPageSuggestions Long Insight column indication the total for the like source type.
Other Long Insight column indication the total for the like source type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_FANS_BY_UNLIKE_SOURCE,PAGE_FANS_BY_UNLIKE_SOURCE_UNIQUE

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InstagramAccountInsights

Allows you to get insights for an Instagram Business Account. Requires the instagram_basic and instagram_manage_insights scopes.

Columns

Name Type Description
RowNumber [KEY] String The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Value Long Insight column for a singular value response.
Description String The period for the insight. This controls how rows will be broken up (by day, week, 28 days, or lifetime). This must always be specified.

The allowed values are day, week, days_28, lifetime.

InsightName String The name of the insight. This must always be specified. The available values are: IMPRESSIONS,REACH,FOLLOWER_COUNT,EMAIL_CONTACTS,PHONE_CALL_CLICKS,TEXT_MESSAGE_CLICKS,GET_DIRECTIONS_CLICKS,WEBSITE_CLICKS,PROFILE_VIEWS,AUDIENCE_GENDER_AGE,AUDIENCE_LOCALE,AUDIENCE_COUNTRY,AUDIENCE_CITY,ONLINE_FOLLOWERS
Period String The period for the insight. This controls how rows will be broken up (by day, week, 28 days, or lifetime). This must always be specified.

The allowed values are day, week, days_28, lifetime.

Target String The target of the insight. This value correspond to the InstagramBusinessAccountId of the Pages view. You can also set it to 'Target IN (SELECT InstagramBusinessAccountId FROM Pages)'. This must always be specified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

Pages

Query the Pages based on the supplied Id.

Table Specific Information

Pages in Facebook are pages that are created by a user and may be maintained by one or multiple users. Pages, like users, may be referred to by Id or by screen name.

Select

When querying pages, if nothing is specified then the pages you administrate will be displayed by default. Otherwise, the Id of the page can be specified. For example:

SELECT * FROM Pages WHERE Id = 'facebook'

Columns

Name Type Description
ID [KEY] String The Id of the page.
Username String The username for the page, if any.
Name String The name of the page.
Category String The category of the page.
Categories String An aggregate of categories associated with the page if multiple categories are available.
Link String A link to the page.
Picture String A link to the profile picture of the page for the page.
CoverId String Id of the cover image for the page.
CoverSource String The URL to the cover image for the page.
CoverOffsetY String The y-axis offset of the cover image for the page.
CoverOffsetX String The x-axis offset of the cover image for the page.
About String Basic information about the page.
Description String A description of the page, if available.
GeneralInfo String General information provided by the page.
LocationStreet String The street address of the page.
LocationCity String The city for the page.
LocationState String The state for the page.
LocationCountry String The country for the page.
LocationZip String The ZIP code of the page.
LocationLatitude String The latitude of the page.
LocationLongitude String The longitude of the page.
StoreNumber Integer Unique store number for this location page, if applicable.
Phone String The phone number of the page, if available.
Website String A link to the website for the page.
Likes Integer The number of people who like the page.
Checkins Integer The total number of users who have checked in to the place associated with the page.
TalkingAboutCount Integer The number of users talking about the page.
WereHereCount Integer The number of users who were at the location the page is for, if applicable.
CanPost Boolean Boolean indicating if the authenticated user can post of the page for the page.
IsPublished Boolean Boolean indicating if the page for the page has been published.
IsCommunityPage Boolean Boolean indicating if this is a community page.
PublicTransit String The public transit available for the page, if any.
ParkingStreet Boolean Boolean indicating if street parking is available.
ParkingLot Boolean Boolean indicating if a parking lot is available.
ParkingValet Boolean Boolean indicating if valet parking is available.
PromotionEligible Boolean Boosted posts eligibility status. Requires the manage_pages permission and you must be an administrator of the page.
PromotionIneligibleReason String Reason boosted posts are not eligible. Requires the manage_pages permission and you must be an administrator of the page.
Founded String When the company is founded. Applicable to companies.
Mission String The company mission. Applicable to companies.
Products String The products of this company. Applicable to companies.
Hours String An aggregate for the hours of operation. Applicable to businesses and places.
Attire String Dress code of the business. Applicable to restaurants or nightlife. Valid values are Casual, Dressy or Unspecified.
AcceptsCashOnly Boolean Whether the business accepts only cash as a payment option. Applicable to restaurants or nightlife.
AcceptsVisa Boolean Whether the business accepts Visa as a payment option. Applicable to restaurants or nightlife.
AcceptsAmericanExpress Boolean Whether the business accepts American Express as a payment option. Applicable to restaurants or nightlife.
AcceptsMasterCard Boolean Whether the business accepts MasterCard as a payment option. Applicable to restaurants or nightlife.
AcceptsDiscover Boolean Whether the business accepts Discover as a payment option. Applicable to restaurants or nightlife.
PriceRange String Price range of the business. Applicable to restaurants or nightlife. Valid values are \$ (0-10), \$\$ (10-30), \$\$\$ (30-50), \$\$\$\$ (50+), or Unspecified.
TakesReservations Boolean Whether the restaurant takes reservations. Only applicable to restaurants.
AllowsWalkins Boolean Whether the restaurant allows walk-ins. Only applicable to restaurants.
AllowsGroups Boolean Whether the restaurant accommodates groups. Only applicable to restaurants.
AllowsKids Boolean Whether the restaurant allows kids. Only applicable to restaurants.
ProvidesTakeout Boolean Whether the restaurant provides a takeout service. Only applicable to restaurants.
ProvidesDelivery Boolean Whether the restaurant provides a delivery service. Only applicable to restaurants.
ProvidesCatering Boolean Whether the restaurant provides a catering service. Only applicable to restaurants.
HasWaiters Boolean Whether the restaurant has waiters. Only applicable to restaurants.
HasOutdoorSeating Boolean Whether the restaurant has outdoor seating. Only applicable to restaurants.
ServesBreakfast Boolean Whether the restaurant serves breakfast. Only applicable to restaurants.
ServesLunch Boolean Whether the restaurant serves lunch. Only applicable to restaurants.
ServesDinner Boolean Whether the restaurant serves dinner. Only applicable to restaurants.
ServesCoffee Boolean Whether the restaurant serves coffee. Only applicable to restaurants.
ServesDrinks Boolean Whether the restaurant serves drinks. Only applicable to restaurants.
CulinaryTeam String Culinary team of the business. Applicable to restaurants or nightlife.
PharmaSafetyInfo String Pharmacy safety information. Applicable to pharmaceutical companies.
Affiliation String Affiliation of this person. Applicable to pages representing people.
Birthday String Birthday of this person. Applicable to pages representing people.
PersonalInfo String Personal information. Applicable to pages representing people.
PersonalInterests String Personal interests. Applicable to pages representing people.
ArtistsWeLike String Artists the band likes. Applicable to bands.
BandInterests String Band interests. Applicable to bands.
BandMembers String Members of the band. Applicable to bands.
Bio String Biography of the band. Applicable to bands.
BookingAgent String Booking agent of the band. Applicable to bands.
GeneralManager String General manager of the business. Applicable to restaurants or nightlife. Applicable to bands.
Hometown String Hometown of the band. Applicable to bands.
PressContact String Press contact information of the band. Applicable to bands.
RecordLabel String Record label of the band. Applicable to bands.
Awards String Awards information for the film or TV show. Applicable to films and TV shows.
DirectedBy String The director of the film or TV show. Applicable to films and TV shows.
Genre String The genre of the film or TV show. Applicable to films and TV shows.
Influences String Influences on the band. Applicable to bands.
PlotOutline String The plot outline of the film or TV show. Applicable to films and TV shows.
ProducedBy String The productor of the film. Applicable to films.
ReleaseData String The film's release data. Applicable to films and TV shows.
ScreenplayBy String The screenwriter of the film. Applicable to films and TV shows.
Starring String The cast of the film or TV show. Applicable to films and TV shows.
Studio String The studio for the film production. Applicable to films.
Network String The network the TV show airs on. Applicable to TV shows.
Schedule String The air schedule of the TV show. Applicable to TV shows.
Season String The current season of the TV show. Applicable to TV shows.
WrittenBy String The writer of the TV show. Applicable to TV shows.
Built String The information about when the vehicle was built. Applicable to vehicles.
Features String Features of the vehicle. Applicable to vehicles.
MPG String Miles per gallon for the vehicle. Applicable to vehicles.
Members String Members of this org. Applicable to pages representing team orgs.
InstagramBusinessAccountId String The business instagram account id associated with this page.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Permissions

Query the Permissions the User has granted the current application.

Columns

Name Type Description
PermissionName [KEY] String The name of the permission.
Status String The status of the requested permission.

Facebook Connector for CData Sync

Photos

Query Photos associated with a Target. Accessing Photo information typically requires the user_photos permission.

Table Specific Information

Photos in Facebook are photos that are uploaded by a user (for example, to a page) and are part of a photo album.

Select

When querying photos, specify a target. The target represents the user, page, album, or event that photos are being retrieved for. For example:

SELECT * FROM Photos WHERE Target = 'facebook'

If no target is specified, the currently authenticated user will be used as the target.

When querying photos, elements may be retrieved by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Photos WHERE Target='thesimpsons' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '10/1/2012'

Columns

Name Type Description
ID [KEY] String The Id of the photo.
Target String The Id or username of the target you are retrieving posts for or are posting to. This may be an album, event, page, or user.
FromId String Id of the user who uploaded the photo.
FromName String Name of the user who uploaded the photo.
FromPicture String Photo of the user who uploaded the photo.
FromCategory String Category of the user who uploaded the photo. FromCategory may only be retrieved if the other From* fields are not selected.
Link String A link to the photo on Facebook.
Name String The name of the photo.
Picture String A link a thumbnail of the photo.
Source String The source image of the photo.
Height Integer The height of the photo.
Width Integer The width of the photo.
Position Integer The position of the photo in the album.
Icon String A link to the icon Facebook displays when photos are published to the stream.
PlaceId String The Id of the location associated with the post, if any.
PlaceName String The name of the location associated with the post, if any.
Images String An aggregate of four different images for the photo.
CommentsCount Integer The number of comments for the photo.
LikesCount Integer The number of times the photo has been liked.
CommentsData String An aggregate of comments for this photo.
LikesData String An aggregate of likes data.
CreatedTime Datetime When the photo was uploaded.
UpdatedTime Datetime When the photo was last updated.

Facebook Connector for CData Sync

Places

Query the Places based on the supplied Id. Places are stored as Pages in Facebook.

Table Specific Information

Places in Facebook are places that can charted on a map and visited. They will typically contain an address, coordinates, and basic information.

Select

If you know the place Id, you may specify the Id to obtain information about the specific place. For example:

SELECT * FROM Places WHERE Id = '407032649344593'

If no Id is specified, no results will come back.

Columns

Name Type Description
ID [KEY] String The Id of the place.
Username String Username for the page of the place if any.
Name String The name of the place.
Category String The category of the place.
Categories String An aggregate of categories associated with the page if multiple categories are available.
Link String A link to the place.
LocationStreet String The street address of the place.
LocationCity String The the city for the place.
LocationState String The the state for the place.
LocationCountry String The the country for the place.
LocationZip String The the ZIP code of the place.
LocationLatitude String The latitude of the place.
LocationLongitude String The longitude of the place.
Phone String The phone number of the place, if available.
Picture String A link to the profile picture of the page for the place.
About String Basic information about the place.
Description String A description of the place, if available.
Website String A link to the website for the place.
Likes Integer Number of people who like the place.
Checkins Integer The total number of users who have checked in to the place.
TalkingAboutCount Integer The number of users talking about the place.
CanPost Boolean Boolean indicating if the authenticated user can post of the page for the place.
IsPublished Boolean A boolean indicating if the page for the place has been published.
IsCommunityPage Boolean Boolean indicating if this is a community Page.
PublicTransit String The public transit available for the place, if any.
ParkingStreet Boolean Boolean indicating if street parking is available.
ParkingLot Boolean Boolean indicating if a parking lot is available.
ParkingValet Boolean Boolean indicating if valet parking is available.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
Distance String Optional input that can be specified if searching places. This is the maximum distance from the specified LocationLatitude and LocationLongitude in meters.
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Ratings

List of ratings for a Facebook Page. This view requires authentication.

Columns

Name Type Description
Target String The Id or name of the page to retrieve ratings for.
CreatedTime Datetime When the reviewer rated this object.
HasRating Boolean Bolean indicating if there was a rating included? (1-5 stars).
HasReview Boolean Bolean indicating if there was text in the rating.
OpenGraphID String Id of Open Graph story generated by the rating action.
Rating Integer Rating (1-5 stars).
ReviewText String The time the last message was posted in the conversation.
ReviewerID String Person who rated the object.
ReviewerName String Person who rated the object.

Facebook Connector for CData Sync

SimpleInsights

Allows the retrieval of simple insights with a single value in the response.

Table Specific Information

Simple insights refers to simple insights that can be retrieved from a page or post. These kinds of insights have a single value in the response and can only be filtered by a few values.

Select

When selecting simple insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM SimpleInsights WHERE Target = 'mypageid' AND InsightName = 'PAGE_IMPRESSIONS' AND Period = 'day'

Note that multiple insights may be specified via the IN operator. For example:

SELECT * FROM SimpleInsights WHERE Target = 'mypageid' AND InsightName IN ('PAGE_IMPRESSIONS', 'PAGE_ENGAGED_USERS') AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM SimpleInsights WHERE Target = 'mypageid' AND InsightName = 'PAGE_IMPRESSIONS' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Note: Please be aware that not all periods are available for all insights. Some will have day/week/days_28 available. Others may only have lifetime. It is best to check against Facebook to see what periods are and are not supported. They can be found here: https://developers.facebook.com/docs/graph-api/reference/insights

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Value Long Insight column for a singular value response.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_ACTIONS_POST_REACTIONS_ANGER_TOTAL,PAGE_ACTIONS_POST_REACTIONS_HAHA_TOTAL,PAGE_ACTIONS_POST_REACTIONS_LIKE_TOTAL,PAGE_ACTIONS_POST_REACTIONS_LOVE_TOTAL,PAGE_ACTIONS_POST_REACTIONS_SORRY_TOTAL,PAGE_ACTIONS_POST_REACTIONS_WOW_TOTAL,PAGE_CONSUMPTIONS,PAGE_CONSUMPTIONS_UNIQUE,PAGE_ENGAGED_USERS,PAGE_FAN_ADDS,PAGE_FAN_ADDS_UNIQUE,PAGE_FAN_REMOVES,PAGE_FAN_REMOVES_UNIQUE,PAGE_FANS,PAGE_FANS_ONLINE,PAGE_FANS_ONLINE_PER_DAY,PAGE_IMPRESSIONS,PAGE_IMPRESSIONS_FREQUENCY_DISTRIBUTION,PAGE_IMPRESSIONS_ORGANIC,PAGE_IMPRESSIONS_ORGANIC_UNIQUE,PAGE_IMPRESSIONS_PAID,PAGE_IMPRESSIONS_PAID_UNIQUE,PAGE_IMPRESSIONS_UNIQUE,PAGE_IMPRESSIONS_VIRAL,PAGE_IMPRESSIONS_VIRAL_FREQUENCY_DISTRIBUTION,PAGE_IMPRESSIONS_VIRAL_UNIQUE,PAGE_IMPRESSIONS_NONVIRAL,PAGE_IMPRESSIONS_NONVIRAL_UNIQUE,PAGE_NEGATIVE_FEEDBACK,PAGE_NEGATIVE_FEEDBACK_UNIQUE,PAGE_PLACES_CHECKIN_MOBILE,PAGE_PLACES_CHECKIN_MOBILE_UNIQUE,PAGE_PLACES_CHECKIN_TOTAL,PAGE_PLACES_CHECKIN_TOTAL_UNIQUE,PAGE_POST_ENGAGEMENTS,PAGE_POSTS_IMPRESSIONS,PAGE_POSTS_IMPRESSIONS_ORGANIC,PAGE_POSTS_IMPRESSIONS_ORGANIC_UNIQUE,PAGE_POSTS_IMPRESSIONS_PAID,PAGE_POSTS_IMPRESSIONS_PAID_UNIQUE,PAGE_POSTS_IMPRESSIONS_UNIQUE,PAGE_POSTS_IMPRESSIONS_VIRAL,PAGE_POSTS_IMPRESSIONS_VIRAL_UNIQUE,PAGE_CONTENT_ACTIVITY,PAGE_VIDEO_COMPLETE_VIEWS_30S,PAGE_VIDEO_COMPLETE_VIEWS_30S_AUTOPLAYED,PAGE_VIDEO_COMPLETE_VIEWS_30S_CLICK_TO_PLAY,PAGE_VIDEO_COMPLETE_VIEWS_30S_ORGANIC,PAGE_VIDEO_COMPLETE_VIEWS_30S_PAID,PAGE_VIDEO_COMPLETE_VIEWS_30S_REPEAT_VIEWS,PAGE_VIDEO_COMPLETE_VIEWS_30S_UNIQUE,PAGE_VIDEO_REPEAT_VIEWS,PAGE_VIDEO_VIEWS,PAGE_VIDEO_VIEWS_AUTOPLAYED,PAGE_VIDEO_VIEWS_CLICK_TO_PLAY,PAGE_VIDEO_VIEWS_ORGANIC,PAGE_VIDEO_VIEWS_PAID,PAGE_VIDEO_VIEWS_UNIQUE,PAGE_VIEWS_TOTAL,PAGE_VIEWS_LOGGED_IN_TOTAL,PAGE_VIEWS_LOGGED_IN_UNIQUE,PAGE_VIEWS_LOGOUT,PAGE_VIEWS_UNIQUE,POST_CLICKS,POST_CLICKS_UNIQUE,POST_ENGAGED_USERS,POST_IMPRESSIONS,POST_IMPRESSIONS_FAN,POST_IMPRESSIONS_FAN_PAID,POST_IMPRESSIONS_FAN_PAID_UNIQUE,POST_IMPRESSIONS_FAN_UNIQUE,POST_IMPRESSIONS_ORGANIC,POST_IMPRESSIONS_ORGANIC_UNIQUE,POST_IMPRESSIONS_PAID,POST_IMPRESSIONS_PAID_UNIQUE,POST_IMPRESSIONS_UNIQUE,POST_IMPRESSIONS_VIRAL,POST_IMPRESSIONS_VIRAL_UNIQUE,POST_NEGATIVE_FEEDBACK,POST_NEGATIVE_FEEDBACK_UNIQUE,POST_ACTIVITY,POST_ACTIVITY_UNIQUE,POST_VIDEO_AVG_TIME_WATCHED,POST_VIDEO_COMPLETE_VIEWS_ORGANIC,POST_VIDEO_COMPLETE_VIEWS_ORGANIC_UNIQUE,POST_VIDEO_COMPLETE_VIEWS_PAID,POST_VIDEO_COMPLETE_VIEWS_PAID_UNIQUE,POST_VIDEO_LENGTH,POST_VIDEO_VIEW_TIME,POST_VIDEO_VIEW_TIME_ORGANIC,POST_VIDEO_VIEWS_10S,POST_VIDEO_VIEWS_10S_AUTOPLAYED,POST_VIDEO_VIEWS_10S_CLICKED_TO_PLAY,POST_VIDEO_VIEWS_10S_ORGANIC,POST_VIDEO_VIEWS_10S_PAID,POST_VIDEO_VIEWS_10S_SOUND_ON,POST_VIDEO_VIEWS_10S_UNIQUE,POST_VIDEO_VIEWS_ORGANIC,POST_VIDEO_VIEWS_ORGANIC_UNIQUE,POST_VIDEO_VIEWS_PAID,POST_VIDEO_VIEWS_PAID_UNIQUE,POST_VIDEO_VIEWS_SOUND_ON
Period String The period for the insight. This controls how rows will be broken up (by day, week, 28 days, or lifetime). This must always be specified.

The allowed values are day, week, days_28, lifetime.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

SimpleVideoInsights

Allows the retrieval of simple video insights with a single value in the response.

Table Specific Information

Simple video insights refers to simple insights that can be retrieved from a video. These kinds of insights have a single value in the response and can only be filtered by a few values.

Select

When selecting simple video insights, a Target must be specified. In addition, an InsightName should always be specified. For instance:

SELECT * FROM SimpleVideoInsights WHERE Target = 'myvideoid' AND InsightName = 'TOTAL_VIDEO_VIEWS'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Breakdowns in smaller units are not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Value Long Insight column for a singular value response.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: TOTAL_VIDEO_VIEWS,TOTAL_VIDEO_VIEWS_UNIQUE,TOTAL_VIDEO_VIEWS_AUTOPLAYED,TOTAL_VIDEO_VIEWS_CLICKED_TO_PLAY,TOTAL_VIDEO_VIEWS_SOUND_ON,TOTAL_VIDEO_COMPLETE_VIEWS,TOTAL_VIDEO_COMPLETE_VIEWS_UNIQUE,TOTAL_VIDEO_COMPLETE_VIEWS_AUTO_PLAYED,TOTAL_VIDEO_COMPLETE_VIEWS_CLICKED_TO_PLAY,TOTAL_VIDEO_10S_VIEWS,TOTAL_VIDEO_10S_VIEWS_UNIQUE,TOTAL_VIDEO_10S_VIEWS_auto_played,TOTAL_VIDEO_10S_VIEWS_CLICKED_TO_PLAY,TOTAL_VIDEO_10S_VIEWS_SOUND_ON,TOTAL_VIDEO_AVG_TIME_WATCHED,TOTAL_VIDEO_VIEW_TOTAL_TIME,TOTAL_VIDEO_IMPRESSIONS,TOTAL_VIDEO_IMPRESSIONS_UNIQUE,TOTAL_VIDEO_IMPRESSIONS_VIRAL_UNIQUE,TOTAL_VIDEO_IMPRESSIONS_VIRAL,TOTAL_VIDEO_IMPRESSIONS_FAN_UNIQUE,TOTAL_VIDEO_IMPRESSIONS_FAN

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

StoryAttachments

Query attachments from a post or comment.

Table Specific Information

StoryAttachments in Facebook are attachments associated with a particular user or page story, like a page post or comment.

Select

When querying StoryAttachments, the Target must be specified and set to that of a post or comment. For example, to retrieve all the attachments for a specific post, your SELECT statement could look something like this:

SELECT * FROM StoryAttachments WHERE Target = '15526475270_410830705612736'

Columns

Name Type Description
Target String The Id or username of the target you are retrieving the wall for.
Type String The type of post.
Link String The link attached to the post.
Name String The name of the link.
Caption String The caption of the link, which appears beneath the link name.
Description String A description of the link, appears beneath the link caption.
Source String A URL to a flash movie or video file embedded within the post.
ObjectId String The Facebook object Id for an uploaded photo or video.

Facebook Connector for CData Sync

TaggedBy

Query information about Posts, Statuses, Photos, and other entities that have tagged the User or Page. This view is a derivative of the Wall connection where only entries that have tagged the Target User or Page will be returned. In general it is only available for Pages.

Columns

Name Type Description
ID [KEY] String The Id of the entity that has tagged the user or page.
Target String The Id or username of the user you are retrieving from.
FromId String Id of the user who made the post.
FromName String Name of the user who made the post.
FromPicture String Picture of the user who made the post.
Message String The message of the post or status if available.
CommentsCount Integer The number of comments for the post.
LikesCount Integer The number of times the post has been liked.
SharesCount Integer The number of times the post has been shared.
CreatedTime Datetime When the post was created.
UpdatedTime Datetime When the post was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Users

Returns basic information about the authenticated user.

Table Specific Information

Users in Facebook are the various user accounts on Facebook.

Select

When selecting users, an Id must be specified. For example:

SELECT * FROM Posts WHERE Id = 'UserId'

If an Id is not specified, the information for the currently logged in user will be returned.

Columns

Name Type Description
ID [KEY] String The Id of the user.
Name String The full name of the user.
Picture String Picture of the user.
FirstName String The first name of the user.
MiddleName String The middle name of the user.
LastName String The last name of the user.
Birthday String The birthday of the user. Requires the user_birthday permission.
Email String The email address of the user. Requires the email permission.
HometownName String The hometown name of the user. Requires the user_hometown permission.
HometownId String The hometown name of the user. Requires the user_hometown permission.
LocationName String The current city name of the user. Requires the user_location permission.
LocationId String The current city Id of the user. Requires the user_location permission.

Facebook Connector for CData Sync

VideoInsightsByActionType

Allows the retrieval of video insights by story action type.

Table Specific Information

Video insights by action type refers to video insights that can be retrieved that detail totals for types of stories.

Select

When selecting video insights, a Target must be specified.

SELECT * FROM VideoInsightsByActionType WHERE Target = 'myvideoid'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Separation into smaller units is not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Like Long Total likes.
Comment Long Total comments.
Share Long Total shares.
Target String The target of the insight. This is a video and must always be specified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

VideoInsightsByDistributionType

Allows the retrieval of video insights by distribution type.

Table Specific Information

Video insights by reaction type refers to video insights that offer information on views your video got from different distribution sources.

Select

When selecting video insights, a Target must be specified. In addition, an InsightName should always be specified. For instance:

SELECT * FROM VideoInsightsByDistributionType WHERE Target = 'myvideoid' AND InsightName = 'TOTAL_VIDEO_VIEWS_BY_DISTRIBUTION_TYPE'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Separation into smaller units is not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Page_Owned Long Views that were owned by the page.
Shared Long Views coming from shares.
Crossposted Long Views coming from posts that were crossposted.
Target String The target of the insight. This is a video and must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: TOTAL_VIDEO_VIEWS_BY_DISTRIBUTION_TYPE,TOTAL_VIDEO_VIEW_TIME_BY_DISTRIBUTION_TYPE

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

VideoInsightsByReactionType

Allows the retrieval of video insights by reaction type.

Table Specific Information

Video insights by reaction type refers to video insights that can be measured by the type of reaction.

Select

When selecting video insights, a Target must be specified. For instance:

SELECT * FROM VideoInsightsByReactionType WHERE Target = 'myvideoid'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Separation into smaller units is not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Like Long Total like reactions.
Love Long Total love reactions.
Wow Long Total wow reactions.
Haha Long Total haha reactions.
Sorry Long Total sorry reactions.
Anger Long Total anger reactions.
Target String The target of the insight. This is a video and must always be specified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

Videos

Query Videos from a Target. Normally requires the user_videos permission.

Table Specific Information

Videos in Facebook are videos that have been uploaded by a user or to a page on Facebook.

Select

When selecting videos, specify a target. The target represents the user or page who uploaded the video. If no target is specified, the currently authenticated user will be used as the target. For example:

SELECT * FROM Videos WHERE Target = 'facebook'

If you know the Id, you can specify the Id to obtain information about the specific video. For example:

SELECT * FROM Videos WHERE Id = 'VideoId'

When querying videos, retrieve elements by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Videos WHERE Target='thesimpsons' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '10/1/2012'

Columns

Name Type Description
ID [KEY] String The Id of the video.
Target String The Id or username of the target you are retrieving videos for.
FromId String Id of the user who uploaded the video.
FromName String Name of the user who uploaded the video.
FromPicture String Picture of the user who uploaded the video.
FromCategory String Category of the user who uploaded the video. FromCategory may only be retrieved if the other From* fields are not selected.
Description String A description of the video.
Picture String URL for the thumbnail of the video.
Source String A URL to the raw, playable video file.
EmbedHtml String The HTML element that may be embedded in an Web page to play the video.
Icon String The icon that Facebook displays when videos are published to the Feed.
Format String An aggregate of four different formats for the video.
TagsData String An aggregate of users tagged in the video, if any.
CommentsCount Integer The number of comments for the video.
LikesCount Integer The number of times the video has been liked.
CommentsData String An aggregate of comments for the video.
CreatedTime Datetime When the video was uploaded.
UpdatedTime Datetime When the video was last updated.

Facebook Connector for CData Sync

Wall

Query Posts from the Wall of a Target.

Table Specific Information

Walls in Facebook are a collection of the various posts and updates made to a user's profile or wall.

Select

When selecting from a wall, specify a target. The target represents the user, page, group, application, or other valid entity that may have a wall associated with it. If no target is specified, the currently authenticated user will be used as the target. For example:

SELECT * FROM Wall WHERE Target = 'facebook'

When querying the wall, elements may be retrieved by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Wall WHERE Target='facebook' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '2/1/2012'

Insert

While the wall may not be directly inserted to, you may post to a wall by issuing an insert with the correct target using the Posts table.

Columns

Name Type Description
ID [KEY] String The Id of the post.
Target String The Id or username of the target you are retrieving the wall for.
FromId String Id of the user who made the post.
FromName String Name of the user who made the post.
FromPicture String Picture of the user who made the comment.
FromCategory String Category of the user who made the post. FromCategory may only be retrieved if the other From* fields are not selected.
ToData String An aggregate of users the post was made to.
Message String The message of the post.
MessageTags String An aggregate of objects tagged in the message such as Users, Pages, etc.
Picture String A link to the picture included in the post.
Icon String Link to an icon representing the type of post.
Actions String An aggregate of available actions on the post (such as commenting or liking).
CommentsCount Integer The number of comments for the post.
LikesCount Integer The number of times the post has been liked.
SharesCount Integer The number of times the post has been shared.
PlaceId String The Id of the location associated with the post, if any.
PlaceName String The name of the location associated with the post, if any.
Attachments String An aggregate for the attachments of the post.
ApplicationId String Id of the application this post came from.
ApplicationNamespace String Information about the application used to create the entity.
Story String Text of stories not intentionally generated by users, such as those generated when two users become friends; you must have the 'Include recent activity stories' migration enabled in your app to retrieve these stories.
StoryTags String An aggregate of objects (users, pages, etc.) associated with the story.
LikesData String An aggregate of like data.
CommentsData String An aggregate of comments for this post.
CreatedTime Datetime When the post was created.
UpdatedTime Datetime When the post was last updated.

Facebook Connector for CData Sync

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
VersionThe Facebook Graph API version to use.
AuthenticateAsPageThe name or Id of a page to authenticate as when making requests to Facebook.

OAuth


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
ScopeThe scope to use when authenticating to Facebook.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous


PropertyDescription
AggregateFormatThe format aggregate or collection columns should return in.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Facebook.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TargetA default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UploadLinkedMediaUpload linked photos or videos before inserting a new Post.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Facebook Connector for CData Sync

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
VersionThe Facebook Graph API version to use.
AuthenticateAsPageThe name or Id of a page to authenticate as when making requests to Facebook.
Facebook Connector for CData Sync

Version

The Facebook Graph API version to use.

Remarks

The Facebook Graph API version to use. Generally this property does not need to be set.

Facebook Connector for CData Sync

AuthenticateAsPage

The name or Id of a page to authenticate as when making requests to Facebook.

Remarks

The Id of a page to retrieve data from. The page must be managed by the authenticated user; you can obtain the Ids for all such pages by querying the Pages view.

Facebook Connector for CData Sync

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
ScopeThe scope to use when authenticating to Facebook.
Facebook Connector for CData Sync

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

Facebook Connector for CData Sync

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

Facebook Connector for CData Sync

Scope

The scope to use when authenticating to Facebook.

Remarks

The scope that are used when authenticating to Facebook give your App access to request additional information that may be required for certain tables. Individual scope may be entered in a comma separated list. Leaving it blank will use the defaults. The Scope is only used if you have specified your own OAuthClientId and OAuthClientSecret.

Requesting Additional Permissions

You may find while using the Sync App that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you will need to generate a new OAuth access token with the required scope. Set the Scope property in the authentication step.

Web applications need to call the GetOAuthAuthorizationURL and GetOAuthAccessToken stored procedures, which have inputs for the scope you would like to request.

Note that these are comma-separated lists of scopes, so you can request more than one per authorization request. You can find a list of available Facebook scopes here: http://developers.facebook.com/docs/authentication/permissions/.

Facebook Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.
Facebook Connector for CData Sync

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Facebook Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.
Facebook Connector for CData Sync

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type Default Port Description
TUNNEL 80 When this is set, the Sync App opens a connection to Facebook and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Facebook Connector for CData Sync

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

Facebook Connector for CData Sync

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

Facebook Connector for CData Sync

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Facebook Connector for CData Sync

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Facebook Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Facebook Connector for CData Sync

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Facebook Connector for CData Sync

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

Facebook Connector for CData Sync

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

Facebook Connector for CData Sync

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Facebook Connector for CData Sync

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

Facebook Connector for CData Sync

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

Facebook Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTODefault setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Facebook Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Facebook Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesCore modules to be included in the log file.
Facebook Connector for CData Sync

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Facebook Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Facebook Connector for CData Sync

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Facebook Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Facebook Connector for CData Sync

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Facebook Connector for CData Sync

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Facebook Connector for CData Sync

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Facebook Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
AggregateFormatThe format aggregate or collection columns should return in.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Facebook.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TargetA default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UploadLinkedMediaUpload linked photos or videos before inserting a new Post.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Facebook Connector for CData Sync

AggregateFormat

The format aggregate or collection columns should return in.

Remarks

The format aggregate or collection columns should return in.

Facebook Connector for CData Sync

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Facebook Connector for CData Sync

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Facebook Connector for CData Sync

Pagesize

The maximum number of results to return per page from Facebook.

Remarks

The Pagesize property affects the maximum number of results to return per page from Facebook. Sometimes you may get an error asking you to request less data. The frequency of such errors can be reduced by reducing the pagesize. The maximum pagesize tends to be about 100 per page.

Facebook Connector for CData Sync

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Facebook Connector for CData Sync

Target

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

Remarks

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

Facebook Connector for CData Sync

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Facebook Connector for CData Sync

UploadLinkedMedia

Upload linked photos or videos before inserting a new Post.

Remarks

The UploadLinkedMedia determines whether to upload media before inserting a Post. If set to True, when you attempt to insert a new Post with the Link column, the driver will first attempt to resolve the URL and determine if the URL is referencing a photo or a video. If so, the photo or video will be uploaded first, then a new Post containing the media will be created.If False, then the new Post will be created as a Link Post.

Facebook Connector for CData Sync

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Posts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462