Functions
| Function | Description |
|---|---|
| PFCatalogCreateDraftItemAsync | Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour. |
| PFCatalogCreateDraftItemGetResult | Gets the result of a successful PFCatalogCreateDraftItemAsync call. |
| PFCatalogCreateDraftItemGetResultSize | Get the size in bytes needed to store the result of a CreateDraftItem call. |
| PFCatalogCreateUploadUrlsAsync | Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info around uploading content can be found here: https://learn.microsoft.com/gaming/playfab/features/pricing/meters/catalog-meters |
| PFCatalogCreateUploadUrlsGetResult | Gets the result of a successful PFCatalogCreateUploadUrlsAsync call. |
| PFCatalogCreateUploadUrlsGetResultSize | Get the size in bytes needed to store the result of a CreateUploadUrls call. |
| PFCatalogDeleteEntityItemReviewsAsync | Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified. |
| PFCatalogDeleteItemAsync | Removes an item from working catalog and all published versions from the public catalog. |
| PFCatalogGetCatalogConfigAsync | 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/gaming/playfab/features/economy-v2/settings |
| PFCatalogGetCatalogConfigGetResult | Gets the result of a successful PFCatalogGetCatalogConfigAsync call. |
| PFCatalogGetCatalogConfigGetResultSize | Get the size in bytes needed to store the result of a GetCatalogConfig call. |
| PFCatalogGetDraftItemAsync | Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are valid for 1 hour. |
| PFCatalogGetDraftItemGetResult | Gets the result of a successful PFCatalogGetDraftItemAsync call. |
| PFCatalogGetDraftItemGetResultSize | Get the size in bytes needed to store the result of a GetDraftItem call. |
| PFCatalogGetDraftItemsAsync | 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. |
| PFCatalogGetDraftItemsGetResult | Gets the result of a successful PFCatalogGetDraftItemsAsync call. |
| PFCatalogGetDraftItemsGetResultSize | Get the size in bytes needed to store the result of a GetDraftItems call. |
| PFCatalogGetEntityDraftItemsAsync | Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. |
| PFCatalogGetEntityDraftItemsGetResult | Gets the result of a successful PFCatalogGetEntityDraftItemsAsync call. |
| PFCatalogGetEntityDraftItemsGetResultSize | Get the size in bytes needed to store the result of a GetEntityDraftItems call. |
| PFCatalogGetEntityItemReviewAsync | Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update in near real time with delays within a few seconds. |
| PFCatalogGetEntityItemReviewGetResult | Gets the result of a successful PFCatalogGetEntityItemReviewAsync call. |
| PFCatalogGetEntityItemReviewGetResultSize | Get the size in bytes needed to store the result of a GetEntityItemReview call. |
| PFCatalogGetItemAsync | Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. |
| PFCatalogGetItemContainersAsync | Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. This API is intended for tooling/automation scenarios and has a reduced RPS with Player Entities limited to 30 requests in 300 seconds and Title Entities limited to 100 requests in 10 seconds. |
| PFCatalogGetItemContainersGetResult | Gets the result of a successful PFCatalogGetItemContainersAsync call. |
| PFCatalogGetItemContainersGetResultSize | Get the size in bytes needed to store the result of a GetItemContainers call. |
| PFCatalogGetItemGetResult | Gets the result of a successful PFCatalogGetItemAsync call. |
| PFCatalogGetItemGetResultSize | Get the size in bytes needed to store the result of a GetItem call. |
| PFCatalogGetItemModerationStateAsync | Gets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/ugc/moderation |
| PFCatalogGetItemModerationStateGetResult | Gets the result of a successful PFCatalogGetItemModerationStateAsync call. |
| PFCatalogGetItemModerationStateGetResultSize | Get the size in bytes needed to store the result of a GetItemModerationState call. |
| PFCatalogGetItemPublishStatusAsync | Gets the status of a publish of an item. |
| PFCatalogGetItemPublishStatusGetResult | Gets the result of a successful PFCatalogGetItemPublishStatusAsync call. |
| PFCatalogGetItemPublishStatusGetResultSize | Get the size in bytes needed to store the result of a GetItemPublishStatus call. |
| PFCatalogGetItemReviewsAsync | Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near real time with delays within a few seconds. |
| PFCatalogGetItemReviewsGetResult | Gets the result of a successful PFCatalogGetItemReviewsAsync call. |
| PFCatalogGetItemReviewsGetResultSize | Get the size in bytes needed to store the result of a GetItemReviews call. |
| PFCatalogGetItemReviewSummaryAsync | Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update data coming within 15 minutes. |
| PFCatalogGetItemReviewSummaryGetResult | Gets the result of a successful PFCatalogGetItemReviewSummaryAsync call. |
| PFCatalogGetItemReviewSummaryGetResultSize | Get the size in bytes needed to store the result of a GetItemReviewSummary call. |
| PFCatalogGetItemsAsync | Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. |
| PFCatalogGetItemsGetResult | Gets the result of a successful PFCatalogGetItemsAsync call. |
| PFCatalogGetItemsGetResultSize | Get the size in bytes needed to store the result of a GetItems call. |
| PFCatalogPublishDraftItemAsync | Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish. |
| PFCatalogReportItemAsync | Submit a report for an item, indicating in what way the item is inappropriate. |
| PFCatalogReportItemReviewAsync | Submit a report for a review |
| PFCatalogReviewItemAsync | Creates or updates a review for the specified item. More information around the caching surrounding item ratings and reviews can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching |
| PFCatalogSearchItemsAsync | Executes a search against the public catalog using the provided search parameters and returns a set of paginated results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/catalog/search |
| PFCatalogSearchItemsGetResult | Gets the result of a successful PFCatalogSearchItemsAsync call. |
| PFCatalogSearchItemsGetResultSize | Get the size in bytes needed to store the result of a SearchItems call. |
| PFCatalogSetItemModerationStateAsync | Sets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/ugc/moderation |
| PFCatalogSubmitItemReviewVoteAsync | Submit a vote for a review, indicating whether the review was helpful or unhelpful. |
| PFCatalogTakedownItemReviewsAsync | Submit a request to takedown one or more reviews. |
| PFCatalogUpdateCatalogConfigAsync | Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/gaming/playfab/features/economy-v2/settings |
| PFCatalogUpdateDraftItemAsync | Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour. |
| PFCatalogUpdateDraftItemGetResult | Gets the result of a successful PFCatalogUpdateDraftItemAsync call. |
| PFCatalogUpdateDraftItemGetResultSize | Get the size in bytes needed to store the result of a UpdateDraftItem call. |