Was this article helpful?

socialize.getPlaces

Last modified 11:38, 15 Sep 2014

Description

This method returns a list of places, which are located in a specified area.

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

Supporting Providers

This operation is currently supported by the following providers: FourSquare, Facebook, Twitter.  

Notes:
1. Before your application can check-in in Facebook, the user must grant your application an extended permission. Please make sure you have checked the "Enable checkin" 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 checkins on her behalf.
Please, read more in the Facebook Setting - Permissions guide.
2. In Twitter, the check-in operation is supported for users only if they choose so in their account settings. The user should check the "Add a location to your tweets" check-box in his Twitter account settings.

 

Syntax

gigya.socialize.getPlaces(params)

 

Method Parameters

The following table lists the params object members:

Required Name Type Description
Required latitude float The decimal latitude of the user.
 
  longitude float The decimal longitude of the user.
Optional query string A string to filter the search results. The string is typically a search term to be applied against places' names. For example: "coffee", "square".
  radius integer The radius in meters to search. The default is 1000 meters.
  unifyResults Boolean Determines whether Gigya should unify the result data from the multiple providers. By default the value of this parameter is false (the data is not unified). Unifying results means that if the same place appears in the result data more then ones, coming from several providers, Gigya will unify the multiple entries into one entry with unified identifier. The unified identifier is the concatenation of the providers' specific IDs with "|" as separator. For example:
Non unified data:
places : [
     {ID: "facebook:sdfd5", name:"Mike's Place", latitude:"23.2323", longitude:"43.234", distance:"145" },
    {ID: "foursquare:12kui5", name:"Mike's Place", latitude:"23.2323", longitude:"43.234", distance:"145" },
    {ID: "twitter:76rftg", name:"My other place", latitude:"32.2323", longitude:"34.234", distance:"541" }
]

Unified data:
places : [    {ID: "facebook:sdfd5|foursquare:12kui5", name:"Mike's Place", latitude:"23.2323", longitude:"43.234", distance:"145" },
    {ID: "twitter:76rftg", name:"My other place", latitude:"32.2323", longitude:"34.234", distance:"541" }
]
  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.
  enabledProviders string A comma-delimited list of provider names to include in the method execution. This parameter gives the possibility to apply this method only to 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', 'foursquare'.
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 that 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 Google+ and Twitter, define: disabledProviders: "googleplus, twitter".
Valid provider names include:
'facebook', 'twitter', 'foursquare'.
Note: the value of this parameter overrides the value of the identical parameter in the global configuration object.
  cid string 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: 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.
places Array An array listing the places. Each place is represented by a JSON object. Each object contains the following fields:
  • ID - the place's unique identifier.
  • name - the place's name.
  • latitude - the place's latitude.
  • longitude - the place's longitude.
  • distance - the distance between the place location and the current user's location.

 

Code Sample

function printResponse(response) {  
    if ( response.errorCode == 0 ) {             
        response.places;          
        if ( null!=response.places && response.places.length>0) {        
            var msg = 'My checked in places are:\n\n';        
            for (var index in response.places) {
                msg += response.places[index].name + '\n' ;                 
            }            
            alert(msg);
        }
        else {
            alert('No places were returned');
        }
    }
    else {
        alert('Error :' + response.errorMessage);
    }
}

var params= {    
    latitude: 42.87596410238254,   // NYC latitude 
    longitude: -78.837890625,  // NYC longitude       
    callback:printResponse
};

gigya.socialize.getPlaces(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.

Was this article helpful?
Page statistics
96 view(s) and 1 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
This page has no classifications.

Comments

You must to post a comment.

Attachments