Gigya Job Openings

Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

RequiredNameTypeDescription
Yes
providerstring

The provider to which to post the bookmark. The optional values for this parameter are:
'facebook', 'twitter', 'googleplus', 'microsoft', 'linkedin', 'googlebookmarks', 'whatsapp', 'myaol', 'baidu', 'stumbleupon', 'qq', 'sina', 'renren', 'mixi', 'friendfeed', 'reddit', 'boxnet', 'tumblr', 'plaxo', 'technorati', 'faves', 'newsvine', 'fark', 'mixx', 'bitly', 'hatena', 'amazon', 'gmail', 'netlog', 'evernote', 'aolmail', 'currenttv', 'yardbarker', 'blinklist', 'diigo', 'dropjack', 'segnalo', 'linkagogo', 'kaboodle', 'skimbit', 'formspring', 'vkontakte', 'spiceworks', 'viadeo', 'nkpl', 'xing', 'tuenti', 'odnoklassniki', 'douban', 'pinterest'.

Panel
borderColor#81C0FC
bgColor#F4F7FC
borderWidth1
borderStylesolid

Notes:

  • whatsapp can only be used on iOS (not in Android).
  • (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). 
Varies
urlURLThe URL of the bookmark to post. This parameter is Required only if the linkback field of the UserAction is not specified.
Varies
titlestring

The title to assign to the bookmark. Note: some of the bookmark destinations do not support assigning a title to the bookmark.

Include Page
Sina Weibo Title Requirement Template
Sina Weibo Title Requirement Template

No
actionAttributesJSON objectIn Gamification your users receive points for actions they perform on your site, in this case posting a bookmark 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 posts a bookmark, 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. 
These action attributes are later used to display the GM Plugins filtered according to a certain attribute. For example, you can show the Leaderboard plugin only for top users on the "Glee" page. 
Include Page
Template_gs api actionAttributes description
Template_gs api actionAttributes description
No
cidstring
Include Page
Template_gs api cid description
Template_gs api cid description
No
descriptionstringThe description of the bookmark. Note: some of the bookmark destinations do not support assigning a description to the bookmark.
No
facebookDialogTypestringApplicable only for sharing through Facebook. This parameter determines which Facebook dialog will appear when clicking the share button. Options are:
  • 'share' (default value)
  • 'feed'

When using the 'share' dialog, it is required to implement open graph tags on your page, since Facebook's 'share' as well as other major social networks, use open graph tags to get the news feed item data for the shared item, rather than using data from the 'user action object'. 

No
popupHeightstring/integerDefines the height of the popup window rendered when clicking on the provider's button. If passed as an integer it will define as pixels. If this parameter is passed as a string it can be either in pixels or percent, e.g., "200px" or "40%".
No
popupPositionXstring/integerDefines the position of the left-top corner of the popup window rendered when clicking on the provider's button from left to right. If passed as an integer it will define as pixels. If this parameter is passed as a string it can be either in pixels or percent, e.g., "200px" or "40%".
No
popupPositionYstring/integerDefines the position of the top of the popup window rendered when clicking on the provider's button from the top of the screen. If passed as an integer it will define as pixels. If this parameter is passed as a string it can be either in pixels or percent, e.g., "200px" or "40%".
No
popupWidthstring/integerDefines the weight of the popup window rendered when clicking on the provider's button. If passed as an integer it will define as pixels. If this parameter is passed as a string it can be either in pixels or percent, e.g., "200px" or "40%".
No
providerKeystringThe provider-specific API Key. This parameter is used when calling this method for providers that require an API key.
No
shortURLsstring
Include Page
Template_gs api shortURLs description
Template_gs api shortURLs description
No
tagsstringA comma separated list of tags that are used to identify the share operation.
No
targetstringThe user ID in the social network. Used to enable opening FB feed dialog to allow a user to post to a friend(s) wall.  Currently only Facebook is supported.
No
titlestringThe title to assign to the bookmark. Note: some of the bookmark destinations do not support assigning a title to the bookmark.
No
userActionUserAction object
When specified, the parameters of the bookmark will be taken from this object, but they may be overridden by the other (existing) explicit parameters if those are specified. The default values of the userAction fields (if not overridden) are:
  • Title - the UserAction title.
  • Link Back - the URL of the bookmark to post. If the url  parameter is not specified, this parameter is Required.
  • Description - the UserAction description.
  • thumbnailURL -  the first media item of type "image" in the UserAction object.

Notes:

  • A shared URL must match the approved URLs (domains) f or the specified API ke y, otherwise the share will not work. 
  • When Twitter is the provider, only the Title and Link Back are posted.

...