Obtenir des éléments brouillons
Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note: SAS tokens provided are valid for 1 hour.
Allowed entity token types: title, master_player_account, title_player_account
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| DatabaseThroughputExceeded | 1113 |
| ItemNotFound | 1047 |
POST
/
Catalog
/
GetDraftItems
Get Draft Items
curl --request POST \
--url https://{titleId}.playfabapi.com/Catalog/GetDraftItems \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Ids": [
"dddddddd-dddd-dddd-dddd-dddddddddddd",
"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Catalog/GetDraftItems"
payload = { "Ids": ["dddddddd-dddd-dddd-dddd-dddddddddddd", "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"] }
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({
Ids: ['dddddddd-dddd-dddd-dddd-dddddddddddd', 'eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee']
})
};
fetch('https://{titleId}.playfabapi.com/Catalog/GetDraftItems', 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/Catalog/GetDraftItems",
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([
'Ids' => [
'dddddddd-dddd-dddd-dddd-dddddddddddd',
'eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee'
]
]),
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/Catalog/GetDraftItems"
payload := strings.NewReader("{\n \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\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/Catalog/GetDraftItems")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Catalog/GetDraftItems")
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 \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Items": [
{
"Id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
},
{
"Id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
}
],
"ContinuationToken": "+RID:IQkbAIvkRQD9oQIAAAAAAA==#RT:1#TRC:10#FPC:AgEKHAoKAPEhAOAhQP8DWIAMAgB8rRACAJeAHAIA0r0="
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Autorisations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Corps
application/json
List of item alternate IDs.
Show child attributes
Show child attributes
An opaque token used to retrieve the next page of items created by the caller, if any are available. Should be null on initial request.
Number of items to retrieve. This value is optional. Default value is 10.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The entity to perform this action on.
Show child attributes
Show child attributes
List of Item Ids.
Réponse
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
Exemple:
{
"Items": [
{
"Id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": { "Values": ["Keyword_1", "Keyword_2"] }
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": ["pirates", "holiday"],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
},
{
"Id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": { "Values": ["Keyword_1", "Keyword_2"] }
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": ["pirates", "holiday"],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
}
],
"ContinuationToken": "+RID:IQkbAIvkRQD9oQIAAAAAAA==#RT:1#TRC:10#FPC:AgEKHAoKAPEhAOAhQP8DWIAMAgB8rRACAJeAHAIA0r0="
}
Dernière modification le 6 octobre 2026
Sujets connexes
Obtenir un élément brouillonObtenir les éléments brouillons de l'entitéCréer un élément brouillonPFCatalogGetEntityDraftItemsAsyncDémarrage rapide du contenu généré par les utilisateurs (UGC)Cette page vous a-t-elle été utile ?
⌘I
Get Draft Items
curl --request POST \
--url https://{titleId}.playfabapi.com/Catalog/GetDraftItems \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Ids": [
"dddddddd-dddd-dddd-dddd-dddddddddddd",
"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Catalog/GetDraftItems"
payload = { "Ids": ["dddddddd-dddd-dddd-dddd-dddddddddddd", "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"] }
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({
Ids: ['dddddddd-dddd-dddd-dddd-dddddddddddd', 'eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee']
})
};
fetch('https://{titleId}.playfabapi.com/Catalog/GetDraftItems', 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/Catalog/GetDraftItems",
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([
'Ids' => [
'dddddddd-dddd-dddd-dddd-dddddddddddd',
'eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee'
]
]),
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/Catalog/GetDraftItems"
payload := strings.NewReader("{\n \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\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/Catalog/GetDraftItems")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Catalog/GetDraftItems")
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 \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Items": [
{
"Id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
},
{
"Id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
}
],
"ContinuationToken": "+RID:IQkbAIvkRQD9oQIAAAAAAA==#RT:1#TRC:10#FPC:AgEKHAoKAPEhAOAhQP8DWIAMAgB8rRACAJeAHAIA0r0="
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}