Gigya Job Openings

Implementing Gigya Plugins in Magento

Skip to end of metadata
Go to start of metadata

« Back to Gigya Extension for Magento 1.x

 

Overview

This article explains how to enable and configure Gigya's social plugins.

Share Bar

Summary

The Share Bar plugin by default is placed on each product page. It displays elements like the following:

For more information on the Share plugin, refer to the socialize.showShareBarUI  API method.

Configuration

To configure the Share Bar, go to System > Configuration > Gigya Share and select Gigya Share Bar Configuration.

Click to enlarge screenshot

FieldDefault Description
Enable Gigya Share BarYesSelect Yes to enable the Share Bar plugin or No to disable it.
Enable Gigya Share Bar on order complete pageYesSelect Yes to enable the Share Bar plugin on the Order Complete page.
Gigya Share Bar container idgigyaSharebarSpecify the div ID in which this plugin is displayed.
Providersshare,facebook-like,twitter-tweetType a comma-separated list of share buttons to display. For the full list of available providers, refer to the socialize.showShareBarUI API method documentation.
Share Bar layoutHorizontalSets the arrangement of buttons in the bar. May be Horizontal (default) or Vertical.
Show countsRightSpecify if and where (right or top) to display the number of times a share button was clicked for this product.
ImageUse image tag if exists, product image otherwise.The default means that: If there is an og:image tag on the page, that image is also used here. If there is not, the product image is used. To always use the product image, select Product image. To specify an online image, select Specify an image URL and then paste that URL below.
Image url(no default)Paste the relevant URL (available if Image is Specify an image URL).
Advanced configuration(no default)This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Advanced Configuration section. For the list of available configuration options, refer to parameters table in the socialize.showShareBarUI API method documentation.

Share Action

Summary

The Gigya Share plugin displays elements like the following in a webpage:

Click to enlarge screenshot

For more information on the Share plugin, you can refer to the socialize.showShareUI API method.

Implementation Notes

By default, the Share Action popup is displayed for both of the following:

  • When a product is added to the shopping cart
  • When an order is complete.

To add the Gigya Share Action to other events, implement an event observer that sets Gigya Share data in the checkout session.

Mage::getSingleton('checkout/session')->setData('gigyaShare', $pid)

Where $pid is the product id to be shared.

Configuration

To configure the Share Bar, go to System > Configuration > Gigya Share and select Gigya Share Action Configuration.

Click to enlarge screenshot

FieldDefault Description
Enable Gigya Share on add to cartYesSelect Yes to enable the Share Bar plugin for “add to cart” or No to disable it.
Enable Gigya Share on order completeYesSelect Yes to enable the Share Bar plugin for “order complete” or No to disable it.
Show Always ShareDo not display the “Always share” checkboxSpecify display options for the Always share checkbox. Additional options:
  • The “Always share” checkbox is displayed and checked by default
  • The “Always share” checkbox is displayed and unchecked by default
Show Never ShareYesSelect Yes to display the Never share checkbox or No not to display it.
Providersfacebook,twitter, linkedin, yahooType a comma-separated list of share-buttons to display. Below this field is a link to a list of available values.
More screen providers*The default * setting specifies all available networks. Otherwise, type a comma-separated list of networks for display after clicking the "+ More" button on Share pop-up screen. You may find the entire list of available providers in the socialize.showShareUI API method documentation.
Scope for publishing to Activity FeedExternal

Deprecated

The license could not be verified: License Certificate has expired!

Advanced configuration(no default)This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Advanced Configuration section. For the list of available configuration options, refer to parameters table in the socialize.showShareUI API method documentation.

Activity Feed

The Activity Feed plugin has been deprecated. If you are using this plugin in your site, please deactivate it to prevent errors.

To deactivate the plugin:

  1. In the Magento admin console, go to System > Configuration > Gigya Activity Feed.
  2. In Enable Gigya Activity Feed, select No.


Comments

Summary

The Gigya Comments plugin enables site users to post comments and have discussions about published content on the site. The Gigya Comments plugin displays elements like the following in a webpage:

Click to enlarge screenshot

Implementation Notes

The Comments plugin is not enabled for your site by default. To add the Comments plugin you must first  set up a new comment category in the Gigya console, then enable Comments and configure them in the Magento admin panel so that they appear on your product pages.

Configuration

To configure the Comments plugin, go to System > Configuration > Gigya Comments.

Click to enlarge screenshot

FieldRequiredDefault Description
Enable Gigya CommentsRequiredNoSelect Yes to enable the Comments plugin or No to disable it.
Gigya Comments container idRequiredgigyaCommentsSpecify the div ID in which this plugin is displayed.
Gigya Comments Category idRequired(no default)Specify the category ID that you have set up in the Gigya admin site. To learn more, see  Setting Up a New Comment Category.
Scope for publishing to Activity FeedOptionalExternal

Deprecated

The license could not be verified: License Certificate has expired!

Advanced configurationOptional(no default)This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Advanced Configuration section. For the list of available configuration options, refer to the parameter table in the comments.showCommentsUI API method documentation.

Gamification (Loyalty)

Summary

Gigya Gamification (Loyalty) plugins constitute a social loyalty and rewards platform that you can embed in your website, increasing site engagement and making your users' experience more enjoyable.

Click to enlarge screenshot

Implementation Notes

To add Gamification (Loyalty) to your site:

  1. Make sure that Gamification is part of your Gigya site package: Gamification is a premium platform that requires separate activation. If Gamification is not part of your site package, contact your Gigya account manager or contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of the Gigya console.
  2. Enable the Gamification and configure it in the Magento admin: To configure the Gamification plugins, go to System > Configuration > Gigya Gamification.

    Click to enlarge screenshot

    FieldDefault Description
    Enable Gigya GamificationNoSelect Yes to enable the Gamification or No to disable it.
    Enable Gamification notificationsYesSelect Yes to enable Gamification notifications or No to disable notifications.
    Leaderboard Time Period7 DaysDetermines the time period for which the leaderboard displays rankings. To display the highest rankings of the last seven days, select 7 Days. To display all-time highest rankings, select All.
    Leaderboard User Count12Determines the number of highest ranking users displayed. Type a value between 1 – 36.
    Enable purchase notifications to GamificationYes

    Select Yes to enable purchases to generate Gamification points. To use this option you must define a Custom User Action with the Action ID "purchase" and set the number of points it generates. Note that the Action ID is case sensitive. To do this open the Gigya Console, go to Settings >> Gamification >> Actions and then, in the Custom User Actions section press the Add User Action button.

    For further information and more detailed instructions see Loyalty Configuration and Administration (note that calls to gm.notifyAction are not required).

    Advanced configuration(no default)

    This box enables you to specify configuration options beyond those available in the fields above.

    Known issue: Currently, the Advanced Configuration functionality does not work for the Gamification (Loyalty) plugin. Please use the other configuration options.


  3. Add the Gamification Plugin to the Layout: The Gamification platform includes a set of graphic plugins (see Gamification plugins). To specify which plugins are displayed, and their order, modify your Magento layout XML file. The Gamification plugin receives the internal layout of the different Gamification parts. Data named “layout” is set on the plugin as an array, with the Gamification plugin name as a key and the container div id as the value.
    The order of the array determines display order.

    In the following example, we display all currently available Gamification plugins. You can change the order of the plugins and comment out or delete any that you do not want displayed.

    <plugin type="Gigya_Social_Block_Gamification_plugins" after="-" name="left.gigya.gm.blocks" template="gigya/gamification.phtml">
        <action method="setData">
            <name>layout</name>
            <value>
                <UserStatus>divUserStatus</UserStatus>
                <ChallengeStatus>divChallenge</ChallengeStatus>
                <Achievements>divAchievements</Achievements>
                <Leaderboard>divLeaderboard</Leaderboard>
            </value>
            </action>
    </plugin>		
    

Reactions

Summary

The Gigya Reactions plugin enables users to share their reactions to your products with their social networks. This plugin displays a set of buttons like the following in a webpage:

Click to enlarge screenshot

Configuration

To configure the Reactions plugin, go to System > Configuration > Gigya Reactions.

FieldDefault Description
Enable Gigya reactionsYesSelect Yes to enable the Reactions plugin or No to disable it.
Gigya reactions container idgigyaReactionsSpecify the div ID in which this plugin is displayed.
Reactions(no default)Specify the Reaction buttons (JavaScript, comma-separated). For details, see below.
Providersfacebook,twitter, linkedin, yahooType a comma-separated list of share-buttons to display. For the full list of available providers, refer to the socialize.showReactionsBarUI API method documentation.
Reactions Bar layoutHorizontalSets the arrangement of buttons in the bar. May be Horizontal (default) or Vertical.
Count typePercentageSpecifies if counts are displayed as a percentage of users who clicked on the specific reaction button out of the total clicked on all reaction buttons or an absolute number of clicks on that button.
Show countsRightSpecify if and where (right or top) to display the number of times a reaction was clicked for this product.
Use multiple reactionsYesSelect Yes to enable a user to click multiple reaction buttons or No for one reaction button only.
Scope for publishing to Activity FeedExternal

Deprecated

The license could not be verified: License Certificate has expired!

ImageUse image tag if exists, product image otherwise.The default means: If there is an og:image tag on the page, that image is also used here. If there is not, the product image is used. To always use the product image, select Product image. To specify an online image, select Specify an image URL and then paste that URL below.
Advanced configuration(no default)This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Advanced Configuration section. For the list of available configuration options, refer to parameters table in the socialize.showReactionsBarUI API method documentation.

Reaction Buttons Definition

The reactions are defined by a comma separated list of JSON objects. Each object defines a single Reaction button to be displayed in the reactions bar. refer to the Reaction object for the specification of the object structure.

You may also use Gigya's Reactions wizard. Make sure you are logged in to the Gigya console, you may access the wizard by clicking the "Plugins" tab, and then the "Reactions" on the side bar.

If you copy Reactions from the Reactions wizard, make sure that you paste only the Reactions buttons' objects and not the entire code.

Code Sample

The following sample code displays these Reaction buttons:

{
    text: 'Amazing',
    ID: 'amazing',
    iconImgUp:'http://cdn.gigya.com/gs/i/reactions/icons/Amazing_Icon_Up.png',
    iconImgOver:'http://cdn.gigya.com/gs/i/reactions/icons/Amazing_Icon_Down.png',
    tooltip:'This item is amazing',
    feedMessage: 'This is amazing!',
    headerText:'Your reaction to this post is \'Amazing\''
}
,{
    text: 'Geeky',
    ID: 'geeky',
    iconImgUp:'http://cdn.gigya.com/gs/i/reactions/icons/Geeky_Icon_Up.png',
    iconImgOver:'http://cdn.gigya.com/gs/i/reactions/icons/Geeky_Icon_Down.png',
    tooltip:'This item is geeky',
    feedMessage: 'This is geeky!',
    headerText:'Your reaction to this post is \'Geeky\''
}

Rating & Reviews

Summary

The Gigya Ratings and Reviews plugin gives your customers an easy way to provide feedback on products. The Ratings & Reviews plugin displays elements like the following on Product pages:

Click to enlarge screenshot

The Gigya Rating & Reviews plugin is a “drop in” replacement for the Magento Product Rating system (when enabled, it replaces the relevant Magneto plugins). The Magento default store includes a Magento Product-Rating widget on the product page, located in the following DIV:

If the Gigya Rating & Reviews is enabled (see below how to enable), the Gigya Rating & Reviews plugin will replace the Magento Product Rating in each "customer-reviews" DIV. Just make sure to keep the "customer-reviews" DIV on the page. Placing the Magento Product Rating ("customer-reviews" DIV) on page can be done using Magento admin.

The Gigya Rating & Reviews plugins supports SEO, meaning the reviews content is searchable by the main search engines.

Implementation Notes

To start using Rating & Reviews:

  1. First, make sure that the Magento Product Rating ("customer-reviews" DIV) appears on your product pages.
  2. Setting Up a New Comment Category. Copy your new Category name from the Gigya console.
  3. Go to the Rating & Reviews configuration page in Magento (see details below) and:
    • Enable Gigya Rating & Reviews - make sure it is set to "Yes".
    • Paste your new Category name into the textbox next to "The identifier of the Comments Category".

Gigya Rating & Reviews should now appear on the product pages. You can further customize it using the configurations options below, and using Gigya console.

Configuration

To configure the Rating & Reviews plugin, go to System > Configuration > Gigya Rating & Reviews.

Click to enlarge screenshot

 

FieldDefault Description
Enable Gigya Rating & ReviewsYesSelect Yes to enable the Rating & Reviews plugins or No to disable it.
Div IDcustomer-reviews(Non editable) The DIV ID in which this plugin is displayed.
The identifier of the Comments Category(no default)Specify the category name that you have set up in the Gigya admin console (see Setting Up a New Comment Category).
Scope for publishing to Activity FeedExternal

Deprecated

The license could not be verified: License Certificate has expired!

Advanced configuration(no default)This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Advanced Configuration section. For the list of available configuration options, refer to parameters table in the comments.showRatingUI API method documentation.

Adding "Verified Purchaser" Badges

The Gigya module supports the ability to give verified purchasers a badge when they post a Rating & Review on item they have purchased in your Magento store.
When a user posts a review on an item in your store, we would check if the user has purchased that item. If so, we will tag the review as being completed by a verified purchaser.

To enable this feature, you would need to specify the verified purchaser's badge.
Go to Gigya's console - Comments Settings and add a new Highlight Comments group. The group name must be "Verified-Purchaser":

Click to enlarge screenshot

You may define your own badge's text, icon and colors. Then hit the "Create" button. Below is the new "Verified-Purchaser" badge listed and active:

Click to enlarge screenshot

After activating, a Verified Purchaser's review will include your pre-defined badge.

Gigya Follow Bar

The Follow Bar plugin has been deprecated. If you are using the Follow Bar plugin in your site, please deactivate it to prevent errors.

To deactivate the Follow Bar:

  1. In the Magento admin console, go to System > Configuration > Gigya Follow Bar.
  2. In Enable, select No.



Save

Save

Save

Save

Save

Save

Save

Save

  • No labels