ScheduleRichPushNotifications

Schedules rich notifications based on user local time.

Example of substitution usage:

Message could be You have won a {2} for entering the {1} contest.

Substitutions parameter would be { "1" : "User Appreciation", "2", "User Appreciation Prize" }

Results

Name	Description
notificationJobs	Number of notification jobs/time zones targeted

Service	Operation
pushNotification	SCHEDULE_RICH_NOTIFICATIONS

Method Parameters

Parameter	Description
notificationTemplateId	Identifies the template that will determine the message content.
segmentCodeList	List of target segment codes. Required, unless the deprecated segmentIdList is given.
segmentIdList	Deprecated: list of target segment ids. Use segmentCodeList instead.
substitutions	Positional message substitution values.
startDateUTC	Optional base date for local time calculation.
localTime	The scheduled local arrival time.
minimizeJobs	Optional flag to cause the server to scan players time zones to reduce scope.

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 notificationTemplateId = 1;
var substitutions = {
    "0": "value0",
    "1": "value1"
};
var segments = [
    "high_spenders",
    "lapsed_30d"
];
var localTime = "15:00";
var minimizeJobs = true;
var startDateUTC = 1437579786000;
var pushNotificationProxy = bridge.getPushNotificationServiceProxy();

var postResult = pushNotificationProxy.scheduleRichPushNotifications(notificationTemplateId, substitutions, segments, localTime, minimizeJobs, startDateUTC);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "pushNotification",
    "operation": "SCHEDULE_RICH_NOTIFICATIONS",
    "data": {
        "notificationTemplateId": 1,
        "segmentCodeList": [
            "high_spenders",
            "lapsed_30d"
        ],
        "substitutions": {
            "0": "value0",
            "1": "value1"
        },
        "startDateUTC": 1437579786000,
        "localTime": "15:00",
        "minimizeJobs": true
    }
}

JSON Response

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