Gigya Job Openings

gm.getActionConfig 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 retrieves the configuration of specified actions. The method returns the list of actions and their configurations. Note: only active challenges and actions are returned, unless specified otherwise.
  

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
includeActionsstringActions to include in the response. The default value is '*', representing all the actions that the site has to offer.
Note: Actions that are listed in the excludedActions parameter are not displayed.
excludeActionsstringActions to exclude from the response. The default value is '' (empty string), meaning that no actions that the site has to offer are to be excluded.
langstring or JSONSpecifies the language of the title and description of the actions. If a specific field does not have a translation in the requested language, then the string from the default language will be used. If this parameter is not specified, then the default language will be used. If this field has the special value "all", then each string field is expanded to an object that lists all the available languages for that string, as it is written in gm.setActionConfig.
includeDisabledActionsBooleanIndicates whether disabled actions will be returned. The default value is 'false'.
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 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. 

 

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.

 

actionsarrayAn array listing the actions. Each action is represented by an object that includes the following fields:
  • actionID - the unique ID of the action
  • title - the name of the action
  • points - the number of points a user earns for performing this action
  • description - the description of the action
  • freqCap- the 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
  • dailyCap - the set amount of times a day that performing this action awards the user points
  • enabled - indicates whether the action is enabled or not.
  • triggerActionID - the ID of an action performed by a referred user that will trigger the current action and grant points to the referring user automatically
  • allowClientSideNotifyAction - indicates whether to allow client-side access to the API to allow updating of of this action
  • source - the API key of the site to which the action belongs
The actions array will be returned empty if the request is made from an untrusted source (client or untrusted access token). 

 

Response Example

{
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "bf71a02cce0f4d9bb81ecedc57ee1e9e",
  "time": "2015-03-22T11:42:25.943Z",
  "actions": [
    {
      "actionID": "111aaa",
      "title": "Language action",
      "enabled": false,
      "description": "This is a translated action",
      "points": 13,
      "dailyCap": 34,
      "freqCap": 0,
      "triggeringActionId": "_socialLogin",
      "source": "<Source Site API key>"
    }
  ]
}