socialize.publishUserAction REST

Skip to end of metadata
Go to start of metadata

 

Publishes a user action to the newsfeed of all the connected providers.

To learn more about publishing feed items, please read the Advanced Sharing page.

 

Note: This API should not be used on mobile apps unless you want to allow users to post to multiple networks at once.

 

 

Supporting Providers

This operation is currently supported by the following providers: Facebook, TwitterLinkedInVKontakte, Renren and Sina Weibo.

Note: Before your application can publish to Facebook, the user must grant your application an extended permission. Make sure you have checked the "Enable publishing user actions" check box in the Site Setup > Permissions page on Gigya's website. During the social login process, the user will be presented with a dialog in which the user can authorize your application to publish to his Facebook profile. Read more in the Facebook Setting - Permissions guide.

 

Possible Responses and the "Unsupported Provider" Error

When publishUserAction is called, the Gigya server tries to publish the user action to every provider to which the user is connected that is also listed in the 'enabledProviders' parameter. If the server succeeds in publishing to at least one of these providers, it considers the operation successful. An error is returned only if the server cannot publish to any of these providers.

In other words, if you call publishUserAction and specify an unsupported provider in 'enabledProviders', the call might still succeed if the user has other valid connected providers -- or it may fail for other reasons, e.g. an expired session on a supported provider.

The server returns an 'unsupported provider' error only if the user is connected to that unsupported provider and has no other valid connections.

 

Request URL

Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.

 

Parameters

RequiredNameTypeDescription
UID string The unique ID of the user with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user. See User.UID for more information.
  • The UID parameter is required when you call this method through one of the following interfaces:  PHP SDKPython SDKJava SDKNET SDK  or if you are using the REST API directly with Gigya's proprietary authorization method.
  • The UID parameter is not required when you call this method through one of the following interfaces: Android SDK, iOS SDK or if you are using an external OAuth2 SDK.
Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Social Login Implementation guide.
userActionUserAction JSONThe user action to publish. The UserAction represented as a JSON string. See below the UserAction JSON representation.
Notes:
  • The UserAction JSON is equivalent to the UserAction object in the Web SDK. See further usage details there. Please remove empty values from the JSON.
  • A shared URL must match the approved URLs (domains) for the specified API key, otherwise the share will not work. 
  • When Twitter is the provider, only the Title and Link Back are posted.
actionAttributesJSON objectIn Gamification your users receive points for actions they perform on your site, in this case publishing a user action grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user publishes a user action, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. 
actionAttributes contain a JSON object comprised of a series of attribute keys (categories) with associated values. You can also use a generic "tags" key.

No more than three values can be given, they can be with a single key or each have their own key.

For more information see Variants and Action Attributes. Action attributes are later used to filter GM Plugins by a certain attribute.
Example:  {"<attribute key1>": ["<attribute value1>", "<attribute value2>"],  "<attribute key2>": "<attribute value3>" }

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.
disabledProvidersstring
A comma-delimited list of provider names to exclude in the method execution. This parameter gives the possibility to specify providers to which you do not 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 Twitter, define: disabledProviders: "twitter".
Valid provider names include:
 'facebook', 'twitter', 'linkedin', 'vkontakte', 'renren', 'sina'.
enabledProvidersstring
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 Twitter, define: enabledProviders: "twitter".
Valid provider names include:
 'facebook', 'twitter', 'linkedin', 'vkontakte', 'renren', 'sina'.
shortURLsstring
Using this parameter you may determine whether to use Gigya's URL shortening service for URLs passed in the status parameter. The optional values for this parameter are:
  • 'always' (default): always try to shorten URLs. Where providers permit, URLs are shortened based on the Data Center you are using:
    • fw.to for users of the US data center.
    • shr.gs for users of the European data center.
    • vst.to for users of the Australian data center.
    • socli.ru for users of the Russian data center.
    • s.gigya-api.cn for users of the Chinese data center.
  • 'whenRequired': URLs longer than 139 characters are shortened in accordance with provider preferences.
  • 'never' - never shorten URLs. Where providers permit, URLs are left untouched.

To determine your data center see Finding Your Data Center.


URL shortening requirements vary between providers and depend on the particular type of action and its content. URL shortening is available for the following providers:

ProviderNote
FacebookN/A
TwitterN/A
LinkedInShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
MicrosoftNot for share. (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used).
DeliciousShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
WhatsAppOnly on mobile.
RedditN/A
GooglePlusN/A
Google BookmarksN/A
VKontakteN/A
nk.plN/A
XingN/A
TuentiN/A
HatenaN/A
PinterestShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
BaiduN/A
FriendFeedN/A
TumblrN/A
SinaN/A
mixiN/A

When Gigya's URL shortening service is active, Gigya tracks all the traffic coming from the distributed URLs. In such case, 'Referred Traffic' reports will be available to you.

 


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.

tagsstringA comma separated list of tags that are used to identify the share operation.
UserActionUserAction JSONIt is possible to specify different content to publish for each social network. For this purpose, the method supports a set of parameters with the same name format: (i.e. facebook, twitter, etc.) followed by "UserAction". For example: twitterUserAction - specifies the content to be used specifically when publishing to Twitter.
Each of these parameters accepts a UserAction JSON (same format as the userAction parameter. Each of these optional parameters if specified will override the userAction parameter when posting to that provider. In other words, the userAction parameter (see above) specifies the default content to be used for all social networks and UserAction specifies the content to be used for the specific network.
userLocationJSON ObjectThe location to which this user action refers. Assigning a location to a user action is currently supported by Twitter only. The value of this parameter should be a JSON object containing the following fields:
  • longitude - the longitude of the location. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive.
  • latitude - the latitude of the location. The valid ranges for latitude is -90.0 to +90.0 (North is positive) inclusive.
  • placeID - a unique identifier of a place to which this status update refers.
    Note: you may receive a list of place identifiers using the socialize.getPlaces method.
See also socialize.checkin.
   
format string Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are:
  • json
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
  • xml (default) - Deprecated. We do not support XML format anymore, but it is the default due to backwards compatibility. Please set the format parameter to either json or jsonp.
callback string This parameter is relevant only when the format parameter is set to jsonp (see above). In such case this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if occurs.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 

 

UserAction JSON Representation

{
    "userMessage":"Text entered by the user", 
    "title":"Link text displayed to user",  
      // actual link
    "linkBack":"http://google.com",  
    "subtitle":"This title appears below the link"
    "description":"Description of the link displayed below the subtitle",
      // additional options following the standard provider links below the post    
      //"actionLinks":[{"title":"text displayed","href":"http://wiki.gigya.com"},{"title":"text displayed2","href":"http://livejournal.com"}],   
    "mediaItems":
        [    
         // Note: add only ONE type of media items - images/flash/video/mps
         // images:
         {"src":"http://www.f2h.co.il/logo.jpg", "href":"http://www.f2h.co.il","type":"image"},
         {"src":"http://teo.esuper.ro/wp-content/images/cute_cat01.jpg","href":"http://teo.esuper.ro/","type":"image"},
         // video 
         {"src":"http://www.f2h.co.il/logo.avi","width":"100","height":"100",
         "previewImageURL":"http://www.f2h.co.il/logo.jpg","previewImageWidth":"200",
         "previewImageHeight":"90","type":"flash"} ,
         // mp3
         {"src":"http://denis.com/Around_The_World.mp3","title":"Around The World","artist":"Max Raabe","album":"Greatest Hits","type":"mp3"}
        ]
}

 

Response Data

FieldTypeDescription
 
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
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.
statusReason string A brief explanation of the status code.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter and not always returned.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or

 

 

providerPostIDsJSON
Object
A list of social networks' post ID. The JSON object contains fields which are names of social networks. The optional field names are: 'facebook', 'twitter' and 'linkedin'. The value of each field is the post unique ID, as returned by the corresponding social network (see JSON example below). 
providerErrorCodesJSON
Array
An array of JSON objects representing the social network's post error codes. Each object has the following fields:
  • provider - the social network provider (string).
  • errorCode - the error code. Code '0' indicates success, any other number indicates failure.
  • errorMessage - a short textual description of an error, associated with the errorCode, for logging purposes.
  • errorDetails - This field will appear only in case of an error and will contain exception info, if available.

A field that does not contain data will not appear in the response.

 

Response Example

{
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "a40b878f32ba41a68db8a66000d23c8a",
        "time": "2015-03-22T11:42:25.943Z",
        "providerPostIDs": {
            "facebook": "696437547_10152162258982548"
        },
        "providerErrorCodes": [{
            "provider": "facebook",
            "errorCode": 0,
            "errorMessage": "OK"},
        {
            "provider": "twitter",
            "errorCode": 403024,
            "errorMessage": "Provider limit reached",
            "errorDetails": "Limit reached: Status is a duplicate."}]
}