Table of contents
Description
A generic method for making Facebook Graph API calls. This method can be used for Graph operations such as Creating and Using Graph Actions. See also Facebook's Open Graph Actions.
Note: Before your application can publish Open Graph actions to the user Timeline, ticker & News feed, the user must grant your application a permission. Please make sure you have checked the "Enable publishing user actions" check box in the Site Setup > Permissions page on Gigya's website. During the Social Login process, the user will be presented with a Facebook UI in which she can authorize your application to perform Open Graph actions on her behalf.
Please, read more in the Facebook Setting - Permissions guide. You can also refer to Facebook's documentation on how to set up an application with open graph actions.
Please, read more in the Facebook Setting - Permissions guide. You can also refer to Facebook's documentation on how to set up an application with open graph actions.
Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to REST API > socialize.facebookGraphOperation.
Syntax
gigya.socialize.facebookGraphOperation(params)
Method Parameters
The following table lists the params object members:
| Required | Name | Type | Description |
| Required | graphPath | string | The Graph operation path. This is the part of Facebook's Graph URL that defines the operation. For example:
|
| Optional | method | string | Determines the HTTP method to use: "GET", "POST" or "DELETE". The default is "GET". |
| graphParams | JSON Object | A JSON object containing parameters to be passed to the Graph operation. For example:graphParams: {
"recipe": "http://demo.gigya.com/recipe1.php",
"place": "14576",
"tags": "208576,507763995",
"start_time": 1303502229,
"end_time": 1303513029,
"expires_in": 330
} | |
| authType | string | Determines whether the graph operation requires an access token or not. The supported values are:
| |
| callback | function | A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes. The callback function should be defined with the following signature: functionName(response). The "Response object Data Members" table below provides specification of the data that is passed to the callback function. | |
| cid | string | A string of maximum 100 characters length. This string is associated with each transaction and will later appear on reports generated by Gigya in the "Context ID" combo box. The cid allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. The "Context ID" combo box lets you filter the report data by site/application context. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| context | object | A developer-created object that is passed back unchanged to the application as one of the fields in the response object. | |
| authRequired | Boolean | Deprecated. Indicates whether the graph operation requires an access token or not. The default is 'true'. This parameter is still supported and translated to either "none" (false) or "userToken" (true). |
Response Object Data Members
| Field | Type | Description |
| errorCode | integer | The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table. |
| errorMessage | string | A short textual description of an error associated with the errorCode for logging purposes. |
| operation | string | The name of the API method that generated this response. |
| context | object | The context object passed by the application as parameter to the API method, or null if no context object has been passed. |
| graphResponse | JSON Object | An object containing the response data of the Graph operation. The response is returned exactly as it is received from Facebook Graph API without translation by Gigya. |
Code Sample
function printResponse(response) {
if ( response.errorCode == 0 ) {
// Get Facebook's response data
alert("The ID of the new action" + response.graphResponse.id);
}
else {
alert('Error :' + response.errorMessage);
}
}
// create a new action in Graph API
var params = {
graphPath: "/me/socializedemo:cook",
graphParams: {"recipe": "http://demo.gigya.com/recipe1.php"},
"method": "post",
callback:printResponse
};
gigya.socialize.facebookGraphOperation(params); Notes:
- This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
- To run the code on your own domain, add your Gigya API key to the socialize.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
- In some cases it is necessary to connect/login the user to a provider? prior to calling the API method. You can learn more in the Social Login guide.
Comments