entity-executed-cloud-script.md

title	author	description	ms.author	ms.date	ms.topic	ms.service	keywords	ms.localizationpriority
entity_executed_cloud_script	joannaleecy	entity_executed_cloud_script event.	joanlee	02/19/2019	article	playfab	playfab, playstream events	medium

entity_executed_cloud_script

This event is optionally triggered when a CloudScript function is executed by calling the ExecuteEntityCloudScript API. If you want the Event logged, you can pass in GeneratePlayStreamEvent.

Properties

Name	Type	Description
CloudScriptExecutionResult	ExecuteCloudScriptResult	Result of the CloudScript function, including diagnostic information that is useful for debugging.
EntityChain	String	The chain of ownership for this entity.
EntityLineage	EntityLineage	Entities that this entity is a child of.
FunctionName	String	Name of the CloudScript function that was called.

Common Properties

All PlayStream events are formatted as JSON objects and share the following common properties:

Name	Type	Description
CustomTags	Object	Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.
EntityId	String	The identifier for the entity (title, player, etc) to which this event applies.
EntityType	String	The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.
EventId	String	PlayFab-assigned unique identifier for this event.
EventName	String	The name of this event.
EventNamespace	String	The assigned namespacing for this event. For example: 'com.myprogram.ads'
History	PlayStreamEventHistory	The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.
Reserved	object	Reserved exclusively for PlayFab internal use.
Source	String	The name of the source of this PlayStream event; will be PlayFab if the event originated from us.
SourceType	SourceType	The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).
Timestamp	DateTime	The time (in UTC) associated with this event.