Cloud Script 실행

Executes a CloudScript function, with the ‘currentPlayerId’ set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player’s master_player_account entity.

Error codes

This operation may return the following PlayFab errors:

Error	Code
CloudScriptAPIRequestCountExceeded	1209
CloudScriptAPIRequestError	1210
CloudScriptFunctionArgumentSizeExceeded	1208
CloudScriptHTTPRequestError	1211
CloudScriptNotFound	1136
JavascriptException	1099
TitleDeleted	1347

POST

Client

ExecuteCloudScript

Execute Cloud Script

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/ExecuteCloudScript \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "FunctionName": "levelCompleted",
  "FunctionParameter": {
    "level": 3,
    "points": 400
  },
  "RevisionSelection": "Live",
  "GeneratePlayStreamEvent": true
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/ExecuteCloudScript"

payload = {
    "FunctionName": "levelCompleted",
    "FunctionParameter": {
        "level": 3,
        "points": 400
    },
    "RevisionSelection": "Live",
    "GeneratePlayStreamEvent": True
}
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    FunctionName: 'levelCompleted',
    FunctionParameter: {level: 3, points: 400},
    RevisionSelection: 'Live',
    GeneratePlayStreamEvent: true
  })
};

fetch('https://{titleId}.playfabapi.com/Client/ExecuteCloudScript', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/ExecuteCloudScript",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'FunctionName' => 'levelCompleted',
    'FunctionParameter' => [
        'level' => 3,
        'points' => 400
    ],
    'RevisionSelection' => 'Live',
    'GeneratePlayStreamEvent' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/ExecuteCloudScript"

	payload := strings.NewReader("{\n  \"FunctionName\": \"levelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"RevisionSelection\": \"Live\",\n  \"GeneratePlayStreamEvent\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/ExecuteCloudScript")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"FunctionName\": \"levelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"RevisionSelection\": \"Live\",\n  \"GeneratePlayStreamEvent\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/ExecuteCloudScript")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"FunctionName\": \"levelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"RevisionSelection\": \"Live\",\n  \"GeneratePlayStreamEvent\": true\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "Revision": 3,
    "FunctionResult": {
      "newScore": 25
    },
    "Logs": [
      {
        "Level": "Info",
        "Message": "Something normal happened",
        "Data": {
          "secondsAfterStart": 75
        }
      },
      {
        "Level": "Error",
        "Message": "Something unexpected happened"
      }
    ],
    "ExecutionTimeSeconds": 0.03670790046453476,
    "MemoryConsumedBytes": 38904,
    "APIRequestsIssued": 2
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

인증

X-Authorization

string

header

필수

This API requires a client session ticket, available from any Client Login function.

본문

application/json

FunctionName

string

필수

The name of the CloudScript function to execute

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

FunctionParameter

object

Object that is passed in to the function as the first argument

GeneratePlayStreamEvent

boolean

Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.

RevisionSelection

enum<string>

Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live' executes the current live, published revision, and 'Specific' executes the specified revision. The default value is 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.

사용 가능한 옵션:

Live,

Latest,

Specific

SpecificRevision

number

The specivic revision to execute, when RevisionSelection is set to 'Specific'

응답

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

예시:

{
  "Revision": 3,
  "FunctionResult": { "newScore": 25 },
  "Logs": [
    {
      "Level": "Info",
      "Message": "Something normal happened",
      "Data": { "secondsAfterStart": 75 }
    },
    {
      "Level": "Error",
      "Message": "Something unexpected happened"
    }
  ],
  "ExecutionTimeSeconds": 0.03670790046453476,
  "MemoryConsumedBytes": 38904,
  "APIRequestsIssued": 2
}

마지막 수정일 2026년 10월 6일

⌘I

Execute Cloud Script

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/ExecuteCloudScript \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "FunctionName": "levelCompleted",
  "FunctionParameter": {
    "level": 3,
    "points": 400
  },
  "RevisionSelection": "Live",
  "GeneratePlayStreamEvent": true
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/ExecuteCloudScript"

payload = {
    "FunctionName": "levelCompleted",
    "FunctionParameter": {
        "level": 3,
        "points": 400
    },
    "RevisionSelection": "Live",
    "GeneratePlayStreamEvent": True
}
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    FunctionName: 'levelCompleted',
    FunctionParameter: {level: 3, points: 400},
    RevisionSelection: 'Live',
    GeneratePlayStreamEvent: true
  })
};

fetch('https://{titleId}.playfabapi.com/Client/ExecuteCloudScript', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/ExecuteCloudScript",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'FunctionName' => 'levelCompleted',
    'FunctionParameter' => [
        'level' => 3,
        'points' => 400
    ],
    'RevisionSelection' => 'Live',
    'GeneratePlayStreamEvent' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/ExecuteCloudScript"

	payload := strings.NewReader("{\n  \"FunctionName\": \"levelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"RevisionSelection\": \"Live\",\n  \"GeneratePlayStreamEvent\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/ExecuteCloudScript")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"FunctionName\": \"levelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"RevisionSelection\": \"Live\",\n  \"GeneratePlayStreamEvent\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/ExecuteCloudScript")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"FunctionName\": \"levelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"RevisionSelection\": \"Live\",\n  \"GeneratePlayStreamEvent\": true\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "Revision": 3,
    "FunctionResult": {
      "newScore": 25
    },
    "Logs": [
      {
        "Level": "Info",
        "Message": "Something normal happened",
        "Data": {
          "secondsAfterStart": 75
        }
      },
      {
        "Level": "Error",
        "Message": "Something unexpected happened"
      }
    ],
    "ExecutionTimeSeconds": 0.03670790046453476,
    "MemoryConsumedBytes": 38904,
    "APIRequestsIssued": 2
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Cloud Script 실행

Error codes

인증

본문

응답