REST Resource: reviews

  • A Review resource represents an Android app review and includes the review ID, author name, and a list of comments.

  • A Comment resource is an entry of conversation between a user and a developer, containing either a UserComment or a DeveloperComment.

  • A UserComment includes details about the user's review such as the text, star rating, language, device information, and timestamps.

  • A Timestamp represents a point in time in seconds and nanoseconds since the Unix epoch.

  • DeviceMetadata provides characteristics of the user's device like model, manufacturer, screen size, and more.

  • A DeveloperComment contains the text and last modified timestamp of a developer's reply to a review.

  • The Reviews resource supports methods to get, list, and reply to reviews.

Resource: Review

An Android app review.

JSON representation 
{
  "reviewId": string,
  "authorName": string,
  "comments": [
    {
      object (Comment)
    }
  ]
}
Fields
reviewId

string

Unique identifier for this review.
authorName

string

The name of the user who wrote the review.
comments[]

object (Comment)

A repeated field containing comments for the review.

Comment

An entry of conversation between user and developer.

JSON representation 
{

  // Union field comment can be only one of the following:
  "userComment": {
    object (UserComment)
  },
  "developerComment": {
    object (DeveloperComment)
  }
  // End of list of possible types for union field comment.
}
Fields

Union field comment.

comment can be only one of the following:
userComment

object (UserComment)

A comment from a user.
developerComment

object (DeveloperComment)

A comment from a developer.

UserComment

User entry from conversation between user and developer.

JSON representation 
{
  "text": string,
  "lastModified": {
    object (Timestamp)
  },
  "starRating": integer,
  "reviewerLanguage": string,
  "device": string,
  "androidOsVersion": integer,
  "appVersionCode": integer,
  "appVersionName": string,
  "thumbsUpCount": integer,
  "thumbsDownCount": integer,
  "deviceMetadata": {
    object (DeviceMetadata)
  },
  "originalText": string
}
Fields
text

string

The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.
lastModified

object (Timestamp)

The last time at which this comment was updated.
starRating

integer

The star rating associated with the review, from 1 to 5.
reviewerLanguage

string

Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.
device

string

Codename for the reviewer's device, e.g. klte, flounder. May be absent.
androidOsVersion

integer

Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
appVersionCode

integer

Integer version code of the app as installed at the time the review was written. May be absent.
appVersionName

string

String version name of the app as installed at the time the review was written. May be absent.
thumbsUpCount

integer

Number of users who have given this review a thumbs up.
thumbsDownCount

integer

Number of users who have given this review a thumbs down.
deviceMetadata

object (DeviceMetadata)

Information about the characteristics of the user's device.
originalText

string

Untranslated text of the review, where the review was translated. If the review was not translated this is left blank.

Timestamp

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970.

JSON representation 
{
  "seconds": string,
  "nanos": integer
}
Fields
seconds

string (int64 format)

Represents seconds of UTC time since Unix epoch.
nanos

integer

Non-negative fractions of a second at nanosecond resolution. Must be from 0 to 999,999,999 inclusive.

DeviceMetadata

Characteristics of the user's device.

JSON representation 
{
  "productName": string,
  "manufacturer": string,
  "deviceClass": string,
  "screenWidthPx": integer,
  "screenHeightPx": integer,
  "nativePlatform": string,
  "screenDensityDpi": integer,
  "glEsVersion": integer,
  "cpuModel": string,
  "cpuMake": string,
  "ramMb": integer
}
Fields
productName

string

Device model name (e.g. Droid)
manufacturer

string

Device manufacturer (e.g. Motorola)
deviceClass

string

Device class (e.g. tablet)
screenWidthPx

integer

Screen width in pixels
screenHeightPx

integer

Screen height in pixels
nativePlatform

string

Comma separated list of native platforms (e.g. "arm", "arm7")
screenDensityDpi

integer

Screen density in DPI
glEsVersion

integer

OpenGL version
cpuModel

string

Device CPU model, e.g. "MSM8974"
cpuMake

string

Device CPU make, e.g. "Qualcomm"
ramMb

integer

Device RAM in Megabytes, e.g. "2048"

DeveloperComment

Developer entry from conversation between user and developer.

JSON representation 
{
  "text": string,
  "lastModified": {
    object (Timestamp)
  }
}
Fields
text

string

The content of the comment, i.e. reply body.
lastModified

object (Timestamp)

The last time at which this comment was updated.

Methods

get

 Gets a single review.

list

 Lists all reviews.

reply

 Replies to a single review, or updates an existing reply.

Error codes

The operations of this resource, return the following HTTP error codes:

Error code Reason Resolution
5xx Generic error in the Google Play server. Retry your request.

If the problem persists contact your Google Play account manager or submit a support request. Consider checking the Play Status Dashboard for any known outages.
409 Concurrency update error.

There was an attempt to update an object that is being updated. For example, a purchase is getting acknowledged by calling the Play Billing Library's acknowledgePurchase() method and by calling the Play Developer API's purchases.products.acknowledge at the same time.

 Retry your request.