This method serves as an end point with a UI for posting a bookmark on a bookmarking destination. The method redirects the user to the specified bookmarking destination. This method has no response.
The following providers currently support this operation: Facebook, Twitter, Google+, Microsoft, LinkedIn, Del.icio.us, Google Bookmarks, WhatsApp, My AOL, Baidu, StumbleUpon, Tencent QQ, Sina Weibo, Renren, mixi, FriendFeed, Reddit, Box.net, Tumblr, Plaxo, Technorati, Faves, Newsvine, Fark, Mixx, Bit.ly, Hatena, Amazon, Gmail, NetLog, Evernote, AOL Mail, Current TV, Yardbarker, BlinkList, Diigo, DropJack, Segnalo, LinkaGoGo, Kaboodle, Skimbit, Formspring, VKontakte, Spiceworks, Viadeo, nkpl, Xing, Tuenti, Odnoklassniki, Douban, Pinterest (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). .
In addition to these automatically available destinations, Gigya supports various other destinations, which have to be requested explicitly. Contact your Gigya Customer Engagement Executive or contact us by filling in a support form on our site. You can also access the support page by clicking "Support" in the upper corner of your Gigya Console. See a list of the possible additional destinations.
The provider to which to post the bookmark. The optional values for this parameter are:
|||url||URL||The URL of the bookmark to post. This parameter is Required only if the linkback field of the UserAction is not specified.|
The title to assign to the bookmark. Note: some of the bookmark destinations do not support assigning a title to the bookmark.
The title property is required when sharing to Sina Weibo (sina); You do not need to include a title separately if you include it within a UserAction object.
|||actionAttributes||JSON object||In 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.
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.
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.
|||description||string||The description of the bookmark. Note: some of the bookmark destinations do not support assigning a description to the bookmark.|
|||facebookDialogType||string||Applicable only for sharing through Facebook. This parameter determines which Facebook dialog will appear when clicking the share button. Options are:|
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'.
|||popupHeight||string/integer||Defines 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%".|
|||popupPositionX||string/integer||Defines 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%".|
|||popupPositionY||string/integer||Defines 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%".|
|||popupWidth||string/integer||Defines 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%".|
|||providerKey||string||The provider-specific API Key. This parameter is used when calling this method for providers that require an API key.|
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:
To determine your data center see Finding Your Data Center.
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.
|||tags||string||A comma separated list of tags that are used to identify the share operation.|
|||target||string||The 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.|
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:
For a fully functional demo, please review the postBookmark Working Example.