Scheduled Task - Get Actions On Players In Segment Task Instance

GetActionsOnPlayersInSegmentTaskInstanceResult

ApiErrorWrapper

This is the outer wrapper for all responses with errors

AddInventoryItemV2Content

Action content to add inventory item v2

BanPlayerContent

Action content to ban player

DeleteInventoryItemV2Content

Action content to delete inventory item v2

DeletePlayerContent

Action content to delete player

ExecuteCloudScriptContent

Action content to execute cloud script

ExecuteFunctionContent

Action content to execute azure function

GrantItemContent

Action content to grant item

GrantVirtualCurrencyContent

Action content to grant virtual currency

IncrementPlayerStatisticContent

Action content to increment player statistic

PushNotificationContent

Action content to send push notification

SendEmailContent

Action content to send email

SubtractInventoryItemV2Content

Action content to subtract inventory item v2

Action[]

List of actions to perform on each player in a segment. Each action object can contain only one action type.

string

ID of the segment to perform actions on.

string

UTC timestamp when the task completed.

string

Error message for last processing attempt, if an error occured.

boolean

Flag indicating if the error was fatal, if false job will be retried.

number

Estimated time remaining in seconds.

number

Progress represented as percentage.

string

If manually scheduled, ID of user who scheduled the task.

string

UTC timestamp when the task started.

TaskInstanceStatus

Current status of the task instance.

NameIdentifier

Identifier of the task this instance belongs to.

string

ID of the task instance.

number

Total players in segment when task was started.

number

Total number of players that have had the actions applied to.

number

Amount of the item to be granted to a player

string

The collection id for where the item will be granted in the player inventory

number

The duration in seconds of the subscription to be granted to a player

string

The id of item to be granted to the player

string

The stack id for where the item will be granted in the player inventory

integer

Numerical HTTP code

string

Playfab error code

integer

Numerical PlayFab error code

object

Detailed description of individual issues with the request object

string

Description for the PlayFab errorCode

string

String HTTP code

number

Duration(in hours) to ban a player. If not provided, the player will be banned permanently.

string

Reason to ban a player

string

The collection id for where the item will be removed from the player inventory

string

The id of item to be removed from the player

string

The stack id for where the item will be removed from the player inventory

string

Arguments(JSON) to be passed into the cloudscript method

string

Cloudscript method name

boolean

Publish cloudscript results as playstream event

string

Arguments(JSON) to be passed into the cloudscript azure function

string

Cloudscript azure function name

boolean

Publish results from executing the azure function as playstream event

ActionsOnPlayersInSegmentTaskParameter

Parameter of this task instance

ActionsOnPlayersInSegmentTaskSummary

Status summary of the actions-on-players-in-segment task instance

string

ID of the requested task instance.

string

The catalog version of the item to be granted to the player

string

The id of item to be granted to the player

number

Quantity of the item to be granted to a player

number

Amount of currency to be granted to a player

string

Code of the currency to be granted to a player

number

Amount(in whole number) to increase the player statistic by

string

Name of the player statistic to be incremented

string

Id Identifier, if present

string

Name Identifier, if present

string

Text of message to send.

string

Id of the push notification template.

string

Subject of message to send (may not be displayed in all platforms)

string

The email template id of the email template to send.

number

Amount of the item to removed from the player

string

The collection id for where the item will be removed from the player inventory

number

The duration in seconds to be removed from the subscription in the players inventory

string

The id of item to be removed from the player

string

The stack id for where the item will be removed from the player inventory

string

string

string

string

string

string