Table of contents
Description
This method retrieves statistics of shares per social network (i.e. the number of Likes, Tweets, etc.) on a specified URL.
Supporting Providers
The following providers currently support this operation: Facebook, Twitter, Delicious, StumbleUpon, LinkedIn and Pinterest.
Note: If you make the call over HTTPS then only Facebook is supported. The other providers do not support this call over HTTPS.
Syntax
gigya.socialize.getProviderShareCounts(params)
Method Parameters
The following table lists the params object members:
| Required | Name | Type | Description |
| Optional | URL | URL | The URL for which to retrieve the statistics. By default if this parameter is not specified, the method retrieves statistics for the current page URL. |
| enabledProviders | string | A comma-delimited list of provider names to include in the method execution. This parameter gives the possibility to apply this method to only a subset of providers of your choice. If you do not set this parameter, by default all the providers are enabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply only to Facebook and Twitter, define: enabledProviders="facebook,twitter". Valid provider names include: 'facebook', 'twitter', 'delicious', 'stumbleupon', 'linkedin', 'pinterest'. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| disabledProviders | string | A comma-delimited list of provider names to exclude in the method execution. This parameter gives the possibility to specify providers to which you don't want this method to apply. If you do not set this parameter, by default no provider is disabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply to all providers except Delicious and Twitter, define: disabledProviders="delicious,twitter". Valid provider names include: 'facebook', 'twitter', 'delicious', 'stumbleupon', 'linkedin', 'pinterest'. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| <provider-name>URL | string | It is possible to specify a provider-specific URL for which to retrieve the statistics. For this purpose, the method supports a set of parameters with the same name format: <provider-name> (i.e. facebook, twitter, etc.) followed by "URL". For example: twitterURL - specifies the URL for which to retrieve statistics specifically for Twitter. | |
| 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. | |
| context | object | A developer-created object that is passed back unchanged to the application as one of the fields in the response object. | |
| cacheTimeout | integer | When the share count data is fetched with this method, it is stored in local storage for a limited number of milliseconds that is set in this parameter. The next time the data is requested, if the cache timeout has not expired, the data is fetched from the local storage. |
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. |
| shareCounts | JSON object | This object enfolds the share statistics. The object includes the following numeric fields:
|
Code Sample
function printResponse(response) {
if ( response.errorCode == 0 ) {
var msg = "Number of Facebook Likes and Shares on this page: " + response.shareCounts.facebook + '\n\n';
msg += "Number of Tweets on this page: " + response.shareCounts.twitter + '\n\n';
alert(msg);
}
else {
alert('Error :' + response.errorMessage);
}
}
gigya.socialize.getProviderShareCounts({callback:printResponse});
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