Table of contents
Description
Enables retrieving raw data directly from the provider. This allows accessing provider-specific information that is not supported by Gigya.
The response is returned exactly as it is received from the provider without translation by Gigya, so it is the site's responsibility to know how to use the information.
This method can also be used for FQL queries in Facebook when using Facebook's Graph API.
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.getRawData.
Supporting Providers
The following providers currently support this operation: Facebook, Myspace, Twitter, Yahoo, LinkedIn, Google+.
Note: Refer to the following links for information about the available data fields and the format of the response:
Myspace - http://wiki.developer.myspace.com/index.php?title=Portable_Contacts_REST_Resources
Facebook - http://developers.facebook.com/docs/reference/fql/user/
Twitter - https://dev.twitter.com/docs/api/1/get/users/search
Yahoo - http://developer.yahoo.com/social/rest_api_guide/extended-profile-resource.html
LinkedIn - http://developer.linkedin.com/docs/DOC-1061
Syntax
gigya.socialize.getRawData(params)
Method Parameters
The following table lists the params object members:
| Required | Name | Type | Description |
| Required | provider | string | The provider from which to retrieve data. The following values are currently supported for use with this parameter: 'facebook', 'myspace', 'twitter', 'yahoo', 'linkedin', 'googleplus'. |
| Optional | UID | string | The user ID of the user about whom to retrieve the information. |
| fields | string | A comma-separated list of provider-specific fields to retrieve. If you are using Facebook's Graph API this parameter may also be used for FQL queries. If the string starts with "SELECT" it will run as FQL. | |
| dataFormat | string | Choose the preferred format of the raw data. The options 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. |
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. |
| data | string | The data returned by the provider as-is, without any manipulation by Gigya. Note: Every provider returns its individual data format. |
Code Sample
function printResponse(response) {
if ( response.errorCode == 0 ) {
var msg ='';
switch (response.context.provider) {
case 'myspace':
eval("var data = " + response.data)
for (var prop in data.entry) {
msg+= "\n " + prop + ': ' + data.entry[prop];
}
break;
case 'facebook':
eval("var data = " + response.data)
msg = 'The user\'s name is ' + data[0]['name'] + ' (sex :' + data[0]['sex'] + ')';
msg += '\nContext message is :\'' + response['context']['message'] + '\'';
break;
}
alert(msg);
}
else {
alert('Error :' + response.errorMessage);
}
}
var context = {
message:'How are you ?',
provider:'facebook'
};
var params = {
provider: 'facebook',
fields : 'name,sex',
UID: 'Z1sHOcDVFPhI8TfddDz7nA==',
callback:printResponse,
context:context
};
gigya.socialize.getRawData(params); - 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