Catalog - Get Catalog Config
Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
POST https://titleId.playfabapi.com/Catalog/GetCatalogConfigRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Catalog |
|
|
Catalog |
|
|
Category |
|
|
Deep |
|
|
Display |
|
|
Display |
|
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
File |
|
|
Get |
|
|
Get |
|
|
Image |
|
|
Review |
|
|
User |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
CatalogConfig
| Name | Type | Description |
|---|---|---|
| AdminEntities |
A list of player entity keys that will have admin permissions. There is a maximum of 64 entities that can be added. |
|
| Catalog |
The set of configuration that only applies to catalog items. |
|
| DeepLinkFormats |
A list of deep link formats. Up to 10 can be added. |
|
| DisplayPropertyIndexInfos |
A list of display properties to index. Up to 5 mappings can be added per Display Property Type. More info on display properties can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/content-types-tags-and-properties#displayproperties |
|
| File |
The set of configuration that only applies to Files. |
|
| Image |
The set of configuration that only applies to Images. |
|
| IsCatalogEnabled |
boolean |
Flag defining whether catalog is enabled. |
| Platforms |
string[] |
A list of Platforms that can be applied to catalog items. Each platform can have a maximum character length of 40 and up to 128 platforms can be listed. |
| Review |
The set of configuration that only applies to Ratings and Reviews. |
|
| ReviewerEntities |
A set of player entity keys that are allowed to review content. There is a maximum of 128 entities that can be added. |
|
| UserGeneratedContent |
The set of configuration that only applies to user generated contents. |
CatalogSpecificConfig
| Name | Type | Description |
|---|---|---|
| ContentTypes |
string[] |
The set of content types that will be used for validation. Each content type can have a maximum character length of 40 and up to 128 types can be listed. |
| Tags |
string[] |
The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags can be listed. |
CategoryRatingConfig
| Name | Type | Description |
|---|---|---|
| Name |
string |
Name of the category. |
DeepLinkFormat
| Name | Type | Description |
|---|---|---|
| Format |
string |
The format of the deep link to return. The format should contain '{id}' to represent where the item ID should be placed. |
| Platform |
string |
The target platform for the deep link. |
DisplayPropertyIndexInfo
| Name | Type | Description |
|---|---|---|
| Name |
string |
The property name in the 'DisplayProperties' property to be indexed. |
| Type |
The type of the property to be indexed. |
DisplayPropertyType
| Name | Type | Description |
|---|---|---|
| None |
string |
|
| QueryDateTime |
string |
|
| QueryDouble |
string |
|
| QueryString |
string |
|
| SearchString |
string |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
FileConfig
| Name | Type | Description |
|---|---|---|
| ContentTypes |
string[] |
The set of content types that will be used for validation. Each content type can have a maximum character length of 40 and up to 128 types can be listed. |
| Tags |
string[] |
The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags can be listed. |
GetCatalogConfigRequest
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
GetCatalogConfigResponse
| Name | Type | Description |
|---|---|---|
| Config |
The catalog configuration. |
ImageConfig
| Name | Type | Description |
|---|---|---|
| Tags |
string[] |
The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags can be listed. |
ReviewConfig
| Name | Type | Description |
|---|---|---|
| CategoryRatings |
A set of categories that can be applied toward ratings and reviews. |
UserGeneratedContentSpecificConfig
| Name | Type | Description |
|---|---|---|
| ContentTypes |
string[] |
The set of content types that will be used for validation. |
| Tags |
string[] |
The set of tags that will be used for validation. |
Error Codes
| Name | Code |
|---|---|
| BillingInformationRequired | 1266 |
| InvalidEntityType | 1373 |