共有グループデータの取得

Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. 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

GetSharedGroupData

Get Shared Group Data

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/GetSharedGroupData \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "SharedGroupId": "Clan Data",
  "Keys": [
    "ClanKills",
    "LastClanUpdate"
  ],
  "GetMembers": true
}
'

import requests

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

payload = {
    "SharedGroupId": "Clan Data",
    "Keys": ["ClanKills", "LastClanUpdate"],
    "GetMembers": 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({
    SharedGroupId: 'Clan Data',
    Keys: ['ClanKills', 'LastClanUpdate'],
    GetMembers: true
  })
};

fetch('https://{titleId}.playfabapi.com/Client/GetSharedGroupData', 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/GetSharedGroupData",
  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',
    'Keys' => [
        'ClanKills',
        'LastClanUpdate'
    ],
    'GetMembers' => 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/GetSharedGroupData"

	payload := strings.NewReader("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Keys\": [\n    \"ClanKills\",\n    \"LastClanUpdate\"\n  ],\n  \"GetMembers\": 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/GetSharedGroupData")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Keys\": [\n    \"ClanKills\",\n    \"LastClanUpdate\"\n  ],\n  \"GetMembers\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"Keys\": [\n    \"ClanKills\",\n    \"LastClanUpdate\"\n  ],\n  \"GetMembers\": true\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "Data": {
      "ClanKills": {
        "Value": "34",
        "LastUpdatedBy": "D984A64B832",
        "LastUpdated": "2015-01-03T17:44:21",
        "Permission": "Public"
      },
      "LastClanUpdate": {
        "Value": "2015-01-03T17:44:21Z",
        "LastUpdatedBy": "D984A64B832",
        "LastUpdated": "2015-01-03T17:44:21"
      }
    },
    "Members": [
      "D984A64B832",
      "F74A523E1562"
    ]
  }
}

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

SharedGroupId

string

必須

Unique identifier for the shared group.

GetMembers

boolean

If true, return the list of all members of the shared group.

Keys

string[]

Specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array indicates that no keys should be returned).

レスポンス

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

例:

{
  "Data": {
    "ClanKills": {
      "Value": "34",
      "LastUpdatedBy": "D984A64B832",
      "LastUpdated": "2015-01-03T17:44:21",
      "Permission": "Public"
    },
    "LastClanUpdate": {
      "Value": "2015-01-03T17:44:21Z",
      "LastUpdatedBy": "D984A64B832",
      "LastUpdated": "2015-01-03T17:44:21"
    }
  },
  "Members": ["D984A64B832", "F74A523E1562"]
}

最終更新日 2026年10月6日

⌘I

Get Shared Group Data

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/GetSharedGroupData \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "SharedGroupId": "Clan Data",
  "Keys": [
    "ClanKills",
    "LastClanUpdate"
  ],
  "GetMembers": true
}
'

import requests

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

payload = {
    "SharedGroupId": "Clan Data",
    "Keys": ["ClanKills", "LastClanUpdate"],
    "GetMembers": 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({
    SharedGroupId: 'Clan Data',
    Keys: ['ClanKills', 'LastClanUpdate'],
    GetMembers: true
  })
};

fetch('https://{titleId}.playfabapi.com/Client/GetSharedGroupData', 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/GetSharedGroupData",
  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',
    'Keys' => [
        'ClanKills',
        'LastClanUpdate'
    ],
    'GetMembers' => 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/GetSharedGroupData"

	payload := strings.NewReader("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Keys\": [\n    \"ClanKills\",\n    \"LastClanUpdate\"\n  ],\n  \"GetMembers\": 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/GetSharedGroupData")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"SharedGroupId\": \"Clan Data\",\n  \"Keys\": [\n    \"ClanKills\",\n    \"LastClanUpdate\"\n  ],\n  \"GetMembers\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"Keys\": [\n    \"ClanKills\",\n    \"LastClanUpdate\"\n  ],\n  \"GetMembers\": true\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "Data": {
      "ClanKills": {
        "Value": "34",
        "LastUpdatedBy": "D984A64B832",
        "LastUpdated": "2015-01-03T17:44:21",
        "Permission": "Public"
      },
      "LastClanUpdate": {
        "Value": "2015-01-03T17:44:21Z",
        "LastUpdatedBy": "D984A64B832",
        "LastUpdated": "2015-01-03T17:44:21"
      }
    },
    "Members": [
      "D984A64B832",
      "F74A523E1562"
    ]
  }
}

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

PlayFab API

PlayFab REST API References

共有グループデータの取得

Error codes

承認

ボディ

レスポンス