Cloud Script タスクの作成
Create a CloudScript task, which can run a CloudScript on a schedule.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| InvalidScheduledTaskName | 1256 |
| InvalidTaskSchedule | 1257 |
| ProductDisabledForTitle | 1609 |
| ScheduledTaskCreateConflict | 1255 |
| ScheduledTaskNameConflict | 1254 |
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"Name": "EnableWeekdayHappyHour",
"Description": "Turn on special pricing for weekday happy hour.",
"Schedule": "0 17 * * 1-5",
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": {
"preset": "WeekdayHappyHour"
}
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask"
payload = {
"Name": "EnableWeekdayHappyHour",
"Description": "Turn on special pricing for weekday happy hour.",
"Schedule": "0 17 * * 1-5",
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": { "preset": "WeekdayHappyHour" }
}
}
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Name: 'EnableWeekdayHappyHour',
Description: 'Turn on special pricing for weekday happy hour.',
Schedule: '0 17 * * 1-5',
Parameter: {FunctionName: 'applyStorePreset', Argument: {preset: 'WeekdayHappyHour'}}
})
};
fetch('https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask', 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/Admin/CreateCloudScriptTask",
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([
'Name' => 'EnableWeekdayHappyHour',
'Description' => 'Turn on special pricing for weekday happy hour.',
'Schedule' => '0 17 * * 1-5',
'Parameter' => [
'FunctionName' => 'applyStorePreset',
'Argument' => [
'preset' => 'WeekdayHappyHour'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <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/Admin/CreateCloudScriptTask"
payload := strings.NewReader("{\n \"Name\": \"EnableWeekdayHappyHour\",\n \"Description\": \"Turn on special pricing for weekday happy hour.\",\n \"Schedule\": \"0 17 * * 1-5\",\n \"Parameter\": {\n \"FunctionName\": \"applyStorePreset\",\n \"Argument\": {\n \"preset\": \"WeekdayHappyHour\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<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/Admin/CreateCloudScriptTask")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Name\": \"EnableWeekdayHappyHour\",\n \"Description\": \"Turn on special pricing for weekday happy hour.\",\n \"Schedule\": \"0 17 * * 1-5\",\n \"Parameter\": {\n \"FunctionName\": \"applyStorePreset\",\n \"Argument\": {\n \"preset\": \"WeekdayHappyHour\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Name\": \"EnableWeekdayHappyHour\",\n \"Description\": \"Turn on special pricing for weekday happy hour.\",\n \"Schedule\": \"0 17 * * 1-5\",\n \"Parameter\": {\n \"FunctionName\": \"applyStorePreset\",\n \"Argument\": {\n \"preset\": \"WeekdayHappyHour\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"TaskId": "644FA3A39C9714BC"
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}承認
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
ボディ
Task name is unique within a title. Using a task name that's already taken will cause a name conflict error. Too many create-task requests within a short time will cause a create conflict error.
Task name is unique within a title. Using a task name that's already taken will cause a name conflict error. Too many create-task requests within a short time will cause a create conflict error.
Whether the schedule is active. Inactive schedule will not trigger task execution.
Name of the task. This is a unique identifier for tasks in the title.
Task details related to CloudScript
Show child attributes
Show child attributes
{
"FunctionName": "applyStorePreset",
"Argument": { "presetName": "dailyHappyHour" }
}
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Description the task
Cron expression for the run schedule of the task. The expression should be in UTC.
このページは役に立ちましたか?
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"Name": "EnableWeekdayHappyHour",
"Description": "Turn on special pricing for weekday happy hour.",
"Schedule": "0 17 * * 1-5",
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": {
"preset": "WeekdayHappyHour"
}
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask"
payload = {
"Name": "EnableWeekdayHappyHour",
"Description": "Turn on special pricing for weekday happy hour.",
"Schedule": "0 17 * * 1-5",
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": { "preset": "WeekdayHappyHour" }
}
}
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Name: 'EnableWeekdayHappyHour',
Description: 'Turn on special pricing for weekday happy hour.',
Schedule: '0 17 * * 1-5',
Parameter: {FunctionName: 'applyStorePreset', Argument: {preset: 'WeekdayHappyHour'}}
})
};
fetch('https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask', 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/Admin/CreateCloudScriptTask",
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([
'Name' => 'EnableWeekdayHappyHour',
'Description' => 'Turn on special pricing for weekday happy hour.',
'Schedule' => '0 17 * * 1-5',
'Parameter' => [
'FunctionName' => 'applyStorePreset',
'Argument' => [
'preset' => 'WeekdayHappyHour'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <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/Admin/CreateCloudScriptTask"
payload := strings.NewReader("{\n \"Name\": \"EnableWeekdayHappyHour\",\n \"Description\": \"Turn on special pricing for weekday happy hour.\",\n \"Schedule\": \"0 17 * * 1-5\",\n \"Parameter\": {\n \"FunctionName\": \"applyStorePreset\",\n \"Argument\": {\n \"preset\": \"WeekdayHappyHour\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<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/Admin/CreateCloudScriptTask")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Name\": \"EnableWeekdayHappyHour\",\n \"Description\": \"Turn on special pricing for weekday happy hour.\",\n \"Schedule\": \"0 17 * * 1-5\",\n \"Parameter\": {\n \"FunctionName\": \"applyStorePreset\",\n \"Argument\": {\n \"preset\": \"WeekdayHappyHour\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/CreateCloudScriptTask")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Name\": \"EnableWeekdayHappyHour\",\n \"Description\": \"Turn on special pricing for weekday happy hour.\",\n \"Schedule\": \"0 17 * * 1-5\",\n \"Parameter\": {\n \"FunctionName\": \"applyStorePreset\",\n \"Argument\": {\n \"preset\": \"WeekdayHappyHour\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"TaskId": "644FA3A39C9714BC"
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}