The params list may consist of:

Using the preceding parameters as a guide, we can put together a simple request to capture the application owner’s name and gender. We use the userId key with a value of @owner and then input name and gender under the fields key.

Finally, we bundle the request with the execute method to initiate the REST request to the container’s social endpoints.

//opensocial person data request
osapi.people.get({userId: '@owner', fields: ['name', 'gender']}).execute(
   function(result){
      var name = (result.name) ?
                 result.name.givenName + " " + result.name.familyName : "";
      var gender = (result.gender) ? result.gender : "Unknown";
   }
);

The execute method accepts a function reference to call once the REST request completes. The function will be called with the result set, after which we can parse the results to capture the data values we requested.

The parameters available in the getViewer method are:

As with the previous get method, we can use the getViewer method to capture social details. Since the request is targeted to the current application user, we don’t need to specify the userId parameter and only need the fields list:

//capture viewer data
osapi.people.getViewer({fields: ['name']}).execute(function(result){
  var name = (result.name) ? result.name.givenName + " " + result.name.familyName : "";
});

The parameters available in the getViewerFriends method are:

In this next example, we make a request to collect the friends of the current application viewer. Using the count parameter, we limit the number of friends returned to 10. These friends are returned as Person objects:

//get viewer friends
osapi.people.getViewerFriends({count: 10}).execute(function(result){
   var friends = result.list;
   var html = '';
   for (var i = 0; i < friends.length; i++){
      html += friends[i].name.givenName + ' : ' + friends[i].profileUrl + '<br />';
   }
});

Once the request returns, we store the friends array (result.list) in a variable. We then loop through the friends array, storing each friend’s name and profile URL.

The parameters available in the getOwner method are:

Much like we did for the getViewer call, we will capture the name for the person (in this case, the application owner) but will extend it with the nickname. In many social networks, the nickname is the text identifier by which the person has chosen to be addressed. This nickname identifier is generally more publicly exposed than the full name:

//capture owner data
osapi.people.getOwner({fields: ['name', 'nickName']}).execute(function(result){
  var name = (result.name) ? result.name.givenName + " " 
           + result.name.familyName : "";
  name += (result.nickName) ? " : " + result.nickName : " : no nickname";
});

Once the request returns, we can capture the owner’s full name and nickname.

The parameters available in the getOwnerFriends method are:

In this next example, we will collect the friends of the application’s owner. We will do so much like we did for the getViewerFriends call, but this time we will be capturing only the thumbnailUrl and only the second page of friend results, given a count of 10 friends. This means that we will be capturing friends 11–20:

//get owner friends
osapi.people.getOwnerFriends({'count': 10,
                              'startPage': 2,
                              'fields': ['thumbnailUrl']}).execute(function(result){
   var friends = result.list;
   var html = '';
   for (var i = 0; i < friends.length; i++){
      html += '<img src="' + friends[i].thumbnailUrl + '" alt="thumbnail image" />';
   }
});

Once the results have been returned, we loop through the array and store images for thumbnails of all the friends returned.