blob: d7e8324ab3d7ee62030ad48271ebff293bd89ec4 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="androidpublisher_v3.html">Google Play Developer API</a> . <a href="androidpublisher_v3.reviews.html">reviews</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(packageName, reviewId, translationLanguage=None)</a></code></p>
<p class="firstline">Returns a single review.</p>
<p class="toc_element">
<code><a href="#list">list(packageName, maxResults=None, startIndex=None, token=None, translationLanguage=None)</a></code></p>
<p class="firstline">Returns a list of reviews. Only reviews from last week will be returned.</p>
<p class="toc_element">
<code><a href="#reply">reply(packageName, reviewId, body=None)</a></code></p>
<p class="firstline">Reply to a single review, or update an existing reply.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(packageName, reviewId, translationLanguage=None)</code>
<pre>Returns a single review.
Args:
packageName: string, Unique identifier for the Android app for which we want reviews; for example, &quot;com.spiffygame&quot;. (required)
reviewId: string, A parameter (required)
translationLanguage: string, A parameter
Returns:
An object of the form:
{
&quot;authorName&quot;: &quot;A String&quot;, # The name of the user who wrote the review.
&quot;comments&quot;: [ # A repeated field containing comments for the review.
{
&quot;developerComment&quot;: { # A comment from a developer.
&quot;lastModified&quot;: { # The last time at which this comment was updated.
&quot;nanos&quot;: 42,
&quot;seconds&quot;: &quot;A String&quot;,
},
&quot;text&quot;: &quot;A String&quot;, # The content of the comment, i.e. reply body.
},
&quot;userComment&quot;: { # A comment from a user.
&quot;androidOsVersion&quot;: 42, # Integer Android SDK version of the user&#x27;s device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
&quot;appVersionCode&quot;: 42, # Integer version code of the app as installed at the time the review was written. May be absent.
&quot;appVersionName&quot;: &quot;A String&quot;, # String version name of the app as installed at the time the review was written. May be absent.
&quot;device&quot;: &quot;A String&quot;, # Codename for the reviewer&#x27;s device, e.g. klte, flounder. May be absent.
&quot;deviceMetadata&quot;: { # Some information about the characteristics of the user&#x27;s device
&quot;cpuMake&quot;: &quot;A String&quot;, # Device CPU make e.g. &quot;Qualcomm&quot;
&quot;cpuModel&quot;: &quot;A String&quot;, # Device CPU model e.g. &quot;MSM8974&quot;
&quot;deviceClass&quot;: &quot;A String&quot;, # Device class (e.g. tablet)
&quot;glEsVersion&quot;: 42, # OpenGL version
&quot;manufacturer&quot;: &quot;A String&quot;, # Device manufacturer (e.g. Motorola)
&quot;nativePlatform&quot;: &quot;A String&quot;, # Comma separated list of native platforms (e.g. &quot;arm&quot;, &quot;arm7&quot;)
&quot;productName&quot;: &quot;A String&quot;, # Device model name (e.g. Droid)
&quot;ramMb&quot;: 42, # Device RAM in Megabytes e.g. &quot;2048&quot;
&quot;screenDensityDpi&quot;: 42, # Screen density in DPI
&quot;screenHeightPx&quot;: 42, # Screen height in pixels
&quot;screenWidthPx&quot;: 42, # Screen width in pixels
},
&quot;lastModified&quot;: { # The last time at which this comment was updated.
&quot;nanos&quot;: 42,
&quot;seconds&quot;: &quot;A String&quot;,
},
&quot;originalText&quot;: &quot;A String&quot;, # Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank.
&quot;reviewerLanguage&quot;: &quot;A String&quot;, # 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.
&quot;starRating&quot;: 42, # The star rating associated with the review, from 1 to 5.
&quot;text&quot;: &quot;A String&quot;, # 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.
&quot;thumbsDownCount&quot;: 42, # Number of users who have given this review a thumbs down
&quot;thumbsUpCount&quot;: 42, # Number of users who have given this review a thumbs up
},
},
],
&quot;reviewId&quot;: &quot;A String&quot;, # Unique identifier for this review.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(packageName, maxResults=None, startIndex=None, token=None, translationLanguage=None)</code>
<pre>Returns a list of reviews. Only reviews from last week will be returned.
Args:
packageName: string, Unique identifier for the Android app for which we want reviews; for example, &quot;com.spiffygame&quot;. (required)
maxResults: integer, A parameter
startIndex: integer, A parameter
token: string, A parameter
translationLanguage: string, A parameter
Returns:
An object of the form:
{
&quot;pageInfo&quot;: {
&quot;resultPerPage&quot;: 42,
&quot;startIndex&quot;: 42,
&quot;totalResults&quot;: 42,
},
&quot;reviews&quot;: [
{
&quot;authorName&quot;: &quot;A String&quot;, # The name of the user who wrote the review.
&quot;comments&quot;: [ # A repeated field containing comments for the review.
{
&quot;developerComment&quot;: { # A comment from a developer.
&quot;lastModified&quot;: { # The last time at which this comment was updated.
&quot;nanos&quot;: 42,
&quot;seconds&quot;: &quot;A String&quot;,
},
&quot;text&quot;: &quot;A String&quot;, # The content of the comment, i.e. reply body.
},
&quot;userComment&quot;: { # A comment from a user.
&quot;androidOsVersion&quot;: 42, # Integer Android SDK version of the user&#x27;s device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
&quot;appVersionCode&quot;: 42, # Integer version code of the app as installed at the time the review was written. May be absent.
&quot;appVersionName&quot;: &quot;A String&quot;, # String version name of the app as installed at the time the review was written. May be absent.
&quot;device&quot;: &quot;A String&quot;, # Codename for the reviewer&#x27;s device, e.g. klte, flounder. May be absent.
&quot;deviceMetadata&quot;: { # Some information about the characteristics of the user&#x27;s device
&quot;cpuMake&quot;: &quot;A String&quot;, # Device CPU make e.g. &quot;Qualcomm&quot;
&quot;cpuModel&quot;: &quot;A String&quot;, # Device CPU model e.g. &quot;MSM8974&quot;
&quot;deviceClass&quot;: &quot;A String&quot;, # Device class (e.g. tablet)
&quot;glEsVersion&quot;: 42, # OpenGL version
&quot;manufacturer&quot;: &quot;A String&quot;, # Device manufacturer (e.g. Motorola)
&quot;nativePlatform&quot;: &quot;A String&quot;, # Comma separated list of native platforms (e.g. &quot;arm&quot;, &quot;arm7&quot;)
&quot;productName&quot;: &quot;A String&quot;, # Device model name (e.g. Droid)
&quot;ramMb&quot;: 42, # Device RAM in Megabytes e.g. &quot;2048&quot;
&quot;screenDensityDpi&quot;: 42, # Screen density in DPI
&quot;screenHeightPx&quot;: 42, # Screen height in pixels
&quot;screenWidthPx&quot;: 42, # Screen width in pixels
},
&quot;lastModified&quot;: { # The last time at which this comment was updated.
&quot;nanos&quot;: 42,
&quot;seconds&quot;: &quot;A String&quot;,
},
&quot;originalText&quot;: &quot;A String&quot;, # Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank.
&quot;reviewerLanguage&quot;: &quot;A String&quot;, # 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.
&quot;starRating&quot;: 42, # The star rating associated with the review, from 1 to 5.
&quot;text&quot;: &quot;A String&quot;, # 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.
&quot;thumbsDownCount&quot;: 42, # Number of users who have given this review a thumbs down
&quot;thumbsUpCount&quot;: 42, # Number of users who have given this review a thumbs up
},
},
],
&quot;reviewId&quot;: &quot;A String&quot;, # Unique identifier for this review.
},
],
&quot;tokenPagination&quot;: {
&quot;nextPageToken&quot;: &quot;A String&quot;,
&quot;previousPageToken&quot;: &quot;A String&quot;,
},
}</pre>
</div>
<div class="method">
<code class="details" id="reply">reply(packageName, reviewId, body=None)</code>
<pre>Reply to a single review, or update an existing reply.
Args:
packageName: string, Unique identifier for the Android app for which we want reviews; for example, &quot;com.spiffygame&quot;. (required)
reviewId: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{
&quot;replyText&quot;: &quot;A String&quot;, # The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.
}
Returns:
An object of the form:
{
&quot;result&quot;: {
&quot;lastEdited&quot;: { # The time at which the reply took effect.
&quot;nanos&quot;: 42,
&quot;seconds&quot;: &quot;A String&quot;,
},
&quot;replyText&quot;: &quot;A String&quot;, # The reply text that was applied.
},
}</pre>
</div>
</body></html>