更新共享组数据

Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data

Error codes

This operation may return the following PlayFab errors:

Error	Code
ProductDisabledForTitle	1609

POST

Client

UpdateSharedGroupData

Update Shared Group Data

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/UpdateSharedGroupData \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "SharedGroupId": "Clan Data",
  "Data": {
    "ClanKills": "34",
    "LastClanUpdate": "2014-10-03T09:21:14Z"
  },
  "Permission": "Public"
}
'

import requests

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

payload = {
    "SharedGroupId": "Clan Data",
    "Data": {
        "ClanKills": "34",
        "LastClanUpdate": "2014-10-03T09:21:14Z"
    },
    "Permission": "Public"
}
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({
    SharedGroupId: 'Clan Data',
    Data: {ClanKills: '34', LastClanUpdate: '2014-10-03T09:21:14Z'},
    Permission: 'Public'
  })
};

fetch('https://{titleId}.playfabapi.com/Client/UpdateSharedGroupData', 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/UpdateSharedGroupData",
  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([
    'SharedGroupId' => 'Clan Data',
    'Data' => [
        'ClanKills' => '34',
        'LastClanUpdate' => '2014-10-03T09:21:14Z'
    ],
    'Permission' => 'Public'
  ]),
  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/UpdateSharedGroupData"

	payload := strings.NewReader("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Data\": {\n    \"ClanKills\": \"34\",\n    \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n  },\n  \"Permission\": \"Public\"\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/UpdateSharedGroupData")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Data\": {\n    \"ClanKills\": \"34\",\n    \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n  },\n  \"Permission\": \"Public\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"SharedGroupId\": \"Clan Data\",\n  \"Data\": {\n    \"ClanKills\": \"34\",\n    \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n  },\n  \"Permission\": \"Public\"\n}"

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

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "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

Note that in the case of multiple calls to write to the same shared group data keys, the last write received by the PlayFab service will determine the value available to subsequent read operations. For scenarios requiring coordination of data updates, it is recommended that titles make use of user data with read permission set to public, or a combination of user data and shared group data.

SharedGroupId

string

必填

Unique identifier for the shared group.

CustomTags

object

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

Data

object

Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may not begin with a '!' character or be null.

KeysToRemove

string[]

Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language constraints. Use this to delete the keys directly.

Permission

enum<string>

Permission to be applied to all user data keys in this request.

可用选项:

Private,

Public

响应

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

最后修改于 2026年10月6日

⌘I

Update Shared Group Data

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/UpdateSharedGroupData \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "SharedGroupId": "Clan Data",
  "Data": {
    "ClanKills": "34",
    "LastClanUpdate": "2014-10-03T09:21:14Z"
  },
  "Permission": "Public"
}
'

import requests

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

payload = {
    "SharedGroupId": "Clan Data",
    "Data": {
        "ClanKills": "34",
        "LastClanUpdate": "2014-10-03T09:21:14Z"
    },
    "Permission": "Public"
}
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({
    SharedGroupId: 'Clan Data',
    Data: {ClanKills: '34', LastClanUpdate: '2014-10-03T09:21:14Z'},
    Permission: 'Public'
  })
};

fetch('https://{titleId}.playfabapi.com/Client/UpdateSharedGroupData', 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/UpdateSharedGroupData",
  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([
    'SharedGroupId' => 'Clan Data',
    'Data' => [
        'ClanKills' => '34',
        'LastClanUpdate' => '2014-10-03T09:21:14Z'
    ],
    'Permission' => 'Public'
  ]),
  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/UpdateSharedGroupData"

	payload := strings.NewReader("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Data\": {\n    \"ClanKills\": \"34\",\n    \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n  },\n  \"Permission\": \"Public\"\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/UpdateSharedGroupData")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Data\": {\n    \"ClanKills\": \"34\",\n    \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n  },\n  \"Permission\": \"Public\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"SharedGroupId\": \"Clan Data\",\n  \"Data\": {\n    \"ClanKills\": \"34\",\n    \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n  },\n  \"Permission\": \"Public\"\n}"

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

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

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

PlayFab API

PlayFab REST API References

更新共享组数据

Error codes

授权

请求体

响应