This method notifies the Game Mechanics (GM) engine about an action that a user has taken on the site. Note: there is no need to notify the GM engine about Gigya's default actions (actions that are initiated using Gigya’s plugins or APIs, such as sharing, commenting, etc.). Use this method to notify about custom user actions. You may read about setting up custom actions in the Custom User Actions section of the Game Mechanics guide.
The following table lists the available parameters:
|||action||string||The identifier of the action that took place. The identifier should be the same as defined in the Actions Setup page in Gigya's website. You may read about setting up site custom actions in the Custom User Actions section of the Game Mechanics guide.|
A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes.
The callback function should be defined with the following signature: functionName(Response).
The "Response Object Data Members" table below provides specification of the data that is passed to the callback function.
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
|||operation||string||The possible values are "grant" (default) and "revoke". When the operation is "revoke" the server behaves as if a regular notifyAction call has been made but inverse the points to be granted so the negative number of points is added to the user. Revoke operations are logged under the same action name but with negative number of points.|
|||actionAttributes||JSON object||In Gamification users receive points for actions they perform on your site, in this case the custom 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 actionAttributes here, each time a user performs this action, the action also receives an attribute (or attributes), 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.
Response Object Data Members