RunBatchUserScript

Runs a script against the users targetted by the provided segments or all players.

Service	Operation
script	RUN_BATCH_USER_SCRIPT

Method Parameters

Parameter	Description
scriptName	The name of the script with its path to be run.
scriptData	Data to be sent to the script in JSON format.
segmentCodeList	List of target segment codes. Omit, or pass an empty list, to send to all users.
segmentIdList	Deprecated: list of target segment ids. Use segmentCodeList instead.

warning

segmentIdList is deprecated. Use segmentCodeList instead. Segment ids are assigned separately in each environment, so the same id can refer to a different segment after an app is copied or promoted, and new apps reject segment ids in cloud code.

Usage

http://localhost:3000

C#

// S2S call: to view example, switch to the Cloud Code or Raw tab.

C++

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Obj-C

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Java

// S2S call: to view example, switch to the Cloud Code or Raw tab.

JavaScript

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Dart

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Roblox

-- N/A

GDScript

N/A

Lua

-- S2S call: to view example, switch to the Cloud Code or Raw tab.

Cloud Code

var scriptName = "path/to/script1";
var scriptData = {
  "parm": "value"
};
var segments = [
    "high_spenders",
    "lapsed_30d"
];
var scriptProxy = bridge.getScriptServiceProxy();

var postResult = scriptProxy.runBatchUserScript(scriptName, scriptData, segments);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "script",
    "operation": "RUN_BATCH_USER_SCRIPT",
    "data": {
        "scriptName": "path/to/script1",
        "scriptData": {
            "parm": "value"
        },
        "segmentCodeList": [
            "high_spenders",
            "lapsed_30d"
        ]
    }
}

JSON Response

{
    "packetId": 1,
    "messageResponses": [
        {
            "data": {},
            "status": 200
        }
    ]
}

Common Error Code

Status Codes

Code	Name	Description
40793	INVALID_SEGMENT_ID_LIST	None of the segment ids match a segment in the app
41056	INVALID_SEGMENT_CODE_LIST	None of the segment codes match a segment in the app