다음을 통해 공유


Catalog - Get Item Review Summary

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.

POST https://titleId.playfabapi.com/Catalog/GetItemReviewSummary

Request 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
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

CustomTags

object

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

Id

string

The unique ID of the item.

Responses

Name Type Description
200 OK

GetItemReviewSummaryResponse

400 Bad Request

ApiErrorWrapper

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
ApiErrorWrapper

The basic wrapper around every failed API response

CatalogAlternateId
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

GetItemReviewSummaryRequest
GetItemReviewSummaryResponse
Rating
Review

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

CatalogAlternateId

Name Type Description
Type

string

Type of the alternate ID.

Value

string

Value of the alternate ID.

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

GetItemReviewSummaryRequest

Name Type Description
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

CustomTags

object

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

Id

string

The unique ID of the item.

GetItemReviewSummaryResponse

Name Type Description
LeastFavorableReview

Review

The least favorable review for this item.

MostFavorableReview

Review

The most favorable review for this item.

Rating

Rating

The summary of ratings associated with this item.

ReviewsCount

number

The total number of reviews associated with this item.

Rating

Name Type Description
Average

number

The average rating for this item.

Count1Star

number

The total count of 1 star ratings for this item.

Count2Star

number

The total count of 2 star ratings for this item.

Count3Star

number

The total count of 3 star ratings for this item.

Count4Star

number

The total count of 4 star ratings for this item.

Count5Star

number

The total count of 5 star ratings for this item.

TotalCount

number

The total count of ratings for this item.

Review

Name Type Description
CategoryRatings

object

The star rating associated with each selected category in this review.

HelpfulNegative

number

The number of negative helpfulness votes for this review.

HelpfulPositive

number

The number of positive helpfulness votes for this review.

IsInstalled

boolean

Indicates whether the review author has the item installed.

ItemId

string

The ID of the item being reviewed.

ItemVersion

string

The version of the item being reviewed.

Locale

string

The locale for which this review was submitted in.

Rating

number

Star rating associated with this review.

ReviewId

string

The ID of the review.

ReviewText

string

The full text of this review.

ReviewerEntity

EntityKey

The ID of the author of the review.

ReviewerId

string

Deprecated. Use ReviewerEntity instead. This property will be removed in a future release.

Submitted

string

The date and time this review was last submitted.

Title

string

The title of this review.

Error Codes

Name Code
DatabaseThroughputExceeded 1113
ItemNotFound 1047