socialize.getRawData JS

Skip to end of metadata
Go to start of metadata

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 developer's responsibility to know how to use the information.

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

This operation is currently supported by the following providers: Facebook*, Twitter, Yahoo, LinkedIn, Google+, Xing, Odnoklassniki, Wechat, Microsoft, Instagram and Foursquare. (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). 

*Facebook does not support FQL requests for apps created after August 2014. If you have a newer app, instead of using this method with the 'fields' parameter to send an FQL request, you should use the 'path' parameter or use the socialize.facebookGraphOperation method.

Refer to the following links for information about the available data fields and the format of the response:

 

Syntax

 

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
providerstringThe provider to retrieve data from. The following values are currently supported for use with this parameter: "facebook", "twitter", "yahoo", "linkedin", "googleplus", "xing", "odnoklassniki", "wechat", "microsoft", "instagram", "foursquare".
UIDstringThe user ID of the user for whom to retrieve the information.
fieldsstring(Facebook only) 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 Facebook Query Language (FQL) queries. If the string starts with "SELECT" it will run as FQL.
pathstring(Facebook only) For Facebook Graph API operations, this parameter specifies the path of the API from which you want to retrieve data, e.g./me/photos. This path is appended to the base API path, which is https://graph.facebook.com, to form the request.

You may also include parameters for the request, e.g. /v2.2/12341354253?fields=from,link.

Notes for users of Facebook app version 2.1 or higher:

  • Facebook does not support FQL requests for version 2.1 or higher, so you must use 'path' instead of 'fields'.
  • If you do not pass either 'fields' or 'path' in the parameters, the API call defaults to FQL, which will result in an error.
dataFormatstringChoose the preferred format of the raw data. The options are:
  • json (default)
  • xml

Note: Not all the providers support both formats.

callbackfunction
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.
cidstring
A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering 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. You should not define more than 100 different context IDs.

Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

contextobject
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

FieldTypeDescription
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 table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.
data stringThe 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 'messenger':
				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);

 

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 gigya.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.