创建组
Creates a new group.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| GroupNameNotAvailable | 1368 |
curl --request POST \
--url https://{titleId}.playfabapi.com/Group/CreateGroup \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"GroupName": "Example Group"
}
'import requests
url = "https://{titleId}.playfabapi.com/Group/CreateGroup"
payload = { "GroupName": "Example Group" }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({GroupName: 'Example Group'})
};
fetch('https://{titleId}.playfabapi.com/Group/CreateGroup', 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/Group/CreateGroup",
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([
'GroupName' => 'Example Group'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <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/Group/CreateGroup"
payload := strings.NewReader("{\n \"GroupName\": \"Example Group\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<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/Group/CreateGroup")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"GroupName\": \"Example Group\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Group/CreateGroup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"GroupName\": \"Example Group\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"GroupName": "Example Group",
"Group": {
"Id": "ABC1234ABC"
},
"MemberRoleId": "ABC123DEF",
"AdminRoleId": "ABC123456",
"Roles": {
"admins": "Administrators",
"members": "Members",
"awesomepeople": "Some Other Role"
},
"Created": "2017-12-31T11:59:59",
"ProfileVersion": 17
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}授权
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
请求体
Creates a new group, as well as administration and member roles, based off of a title's group template. Returns information about the group that was created.
Creates a new group, as well as administration and member roles, based off of a title's group template. Returns information about the group that was created.
The name of the group. This is unique at the title level by default.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The optional entity to perform this action on. Defaults to the currently logged in entity.
Show child attributes
Show child attributes
响应
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
{
"GroupName": "Example Group",
"Group": { "Id": "ABC1234ABC" },
"MemberRoleId": "ABC123DEF",
"AdminRoleId": "ABC123456",
"Roles": {
"admins": "Administrators",
"members": "Members",
"awesomepeople": "Some Other Role"
},
"Created": "2017-12-31T11:59:59",
"ProfileVersion": 17
}
此页面对您有帮助吗?
curl --request POST \
--url https://{titleId}.playfabapi.com/Group/CreateGroup \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"GroupName": "Example Group"
}
'import requests
url = "https://{titleId}.playfabapi.com/Group/CreateGroup"
payload = { "GroupName": "Example Group" }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({GroupName: 'Example Group'})
};
fetch('https://{titleId}.playfabapi.com/Group/CreateGroup', 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/Group/CreateGroup",
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([
'GroupName' => 'Example Group'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <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/Group/CreateGroup"
payload := strings.NewReader("{\n \"GroupName\": \"Example Group\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<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/Group/CreateGroup")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"GroupName\": \"Example Group\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Group/CreateGroup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"GroupName\": \"Example Group\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"GroupName": "Example Group",
"Group": {
"Id": "ABC1234ABC"
},
"MemberRoleId": "ABC123DEF",
"AdminRoleId": "ABC123456",
"Roles": {
"admins": "Administrators",
"members": "Members",
"awesomepeople": "Some Other Role"
},
"Created": "2017-12-31T11:59:59",
"ProfileVersion": 17
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}