Gigya Job Openings

gm.setActionConfig REST

Skip to end of metadata
Go to start of metadata

Note: If you plan on integrating the Loyalty platform, we highly recommend reading the Loyalty - Gamification and User Behavior Guide. Loyalty is a premium Gigya platform that requires separate activation. If it is not yet a part of your existing site package, please contact Gigya Support via the Support link in the top menu of your Console Dashboard or email support@gigya.com.

Description

This API creates or updates an existing Gamification action. Read more about Gamification Actions.

 

Note: Actions created or updated via this API can be edited via the Actions page on Gigya's site.

 

 

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
actionIDstringThe unique ID of the action.
titlestring or JSON

The name of the action. The name should be in the following format:
{
    "default":"<action name in default language>",
   "":""
  ...
}
The title parameter is constructed of the name in the default language, e.g. {"default":"New User - social login"}, and also of a pair or pairs of language codes with their respective action names, e.g.: 
{
   "default":"New User - social login",
   "
es":"Nuevo usuario - login sociales",
   "
ar":"مستخدم جديد- تسجيل الدخول للموقع الإجتماعي"
}
In this case the name of the action is provided in the default language (English), and in Spanish (es) and Arabic (ar). The available language codes can be found here. The parameter can be passed as a string only, without the language codes, in which case the string represents the name of the action in the default language, e.g. "New User - social login". 

 Note: This parameter is optional, but for the best practice implementation, we recommend adding an action name to each action. 

pointsintegerThe number of points a user earns for performing this action. 
descriptionJSONThe description of the action. The description has the same format as the title parameter - it is constructed of the description in the default language, and also of a pair or pairs of language codes with their respective action descriptions:
{
    "default":"<action description in default language>",
   "":"",
  ...
}
The available language codes can be found here
The parameter can be passed as a string only, without the language codes, in which case the string represents the description of the action in the default language, e.g. "New user registration via Gigya social login".
freqCapintegerThe number of seconds that need to pass from the time a user performs this action before he can earn more points for performing this action again. The default value is "0".
dailyCapintegerThe set amount of times a day that performing this action awards the user points. The default value is "0", which means there is no limit on the number of times the user can earn points for performing this action. Note: there is a technical limit, which currently stands on 1000.
enabledBooleanIndicates whether the action is enabled or not. The default value is 'false'.
triggerActionIDstringThe ID of an action performed by a referred user that will trigger the current action and grant points to the referring user automatically. 
allowClientSideNotifyActionBooleanIndicates whether to allow client-side access to the API to allow updating of of this action. The default is 'false'. Setting this parameter to 'true' enables the usage of the gm.notifyAction API method from your client application. It is highly advised disabling client access and executing this method from your server so as to prevent hacking. You can find the server side API in REST API > gm.notifyAction. Note: the value of this parameter overrides the value of the identical parameter in gm.setGlobalConfig.
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
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 one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

 

Response Data

FieldTypeDescription
 
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.
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 that is not always returned and should not be relied upon by your implementation.
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
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.

 

 

Response Example

{
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "bb5d9224614946c58a6771a081cddb9a",
        "time": "2015-03-22T11:42:25.943Z"
}