Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / androidpublisher_v2.reviews.html
blob: ed8a8da2b25e1cd78edfe5cf5e254bf2586b911c [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.reviews.html">reviews</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]78 <code><a href="#get">get(packageName, reviewId, translationLanguage=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Returns a single review.</p>
80<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]81 <code><a href="#list">list(packageName, translationLanguage=None, token=None, maxResults=None, startIndex=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Returns a list of reviews. Only reviews from last week will be returned.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#reply">reply(packageName, reviewId, body)</a></code></p>
85<p class="firstline">Reply to a single review, or update an existing reply.</p>
86<h3>Method Details</h3>
87<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]88 <code class="details" id="get">get(packageName, reviewId, translationLanguage=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]89 <pre>Returns a single review.
90
91Args:
92 packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
93 reviewId: string, A parameter (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]94 translationLanguage: string, A parameter
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95
96Returns:
97 An object of the form:
98
99 {
100 "authorName": "A String", # The name of the user who wrote the review.
101 "reviewId": "A String", # Unique identifier for this review.
102 "comments": [ # A repeated field containing comments for the review.
103 {
104 "developerComment": { # A comment from a developer.
105 "lastModified": { # The last time at which this comment was updated.
106 "nanos": 42,
107 "seconds": "A String",
108 },
109 "text": "A String", # The content of the comment, i.e. reply body.
110 },
111 "userComment": { # A comment from a user.
112 "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]113 "originalText": "A String", # 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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]114 "reviewerLanguage": "A 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.
115 "lastModified": { # The last time at which this comment was updated.
116 "nanos": 42,
117 "seconds": "A String",
118 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]119 "thumbsUpCount": 42, # Number of users who have given this review a thumbs up
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]120 "starRating": 42, # The star rating associated with the review, from 1 to 5.
121 "text": "A 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.
122 "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
123 "androidOsVersion": 42, # Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]124 "deviceMetadata": { # Some information about the characteristics of the user's device
125 "screenDensityDpi": 42, # Screen density in DPI
126 "screenHeightPx": 42, # Screen height in pixels
127 "cpuModel": "A String", # Device CPU model e.g. "MSM8974"
128 "productName": "A String", # Device model name (e.g. Droid)
129 "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7")
130 "deviceClass": "A String", # Device class (e.g. tablet)
131 "cpuMake": "A String", # Device CPU make e.g. "Qualcomm"
132 "ramMb": 42, # Device RAM in Megabytes e.g. "2048"
133 "screenWidthPx": 42, # Screen width in pixels
134 "glEsVersion": 42, # OpenGL version
135 "manufacturer": "A String", # Device manufacturer (e.g. Motorola)
136 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]137 "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]138 "thumbsDownCount": 42, # Number of users who have given this review a thumbs down
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]139 },
140 },
141 ],
142 }</pre>
143</div>
144
145<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]146 <code class="details" id="list">list(packageName, translationLanguage=None, token=None, maxResults=None, startIndex=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]147 <pre>Returns a list of reviews. Only reviews from last week will be returned.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]148
149Args:
150 packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]151 translationLanguage: string, A parameter
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]152 token: string, A parameter
153 maxResults: integer, A parameter
154 startIndex: integer, A parameter
155
156Returns:
157 An object of the form:
158
159 {
160 "reviews": [
161 {
162 "authorName": "A String", # The name of the user who wrote the review.
163 "reviewId": "A String", # Unique identifier for this review.
164 "comments": [ # A repeated field containing comments for the review.
165 {
166 "developerComment": { # A comment from a developer.
167 "lastModified": { # The last time at which this comment was updated.
168 "nanos": 42,
169 "seconds": "A String",
170 },
171 "text": "A String", # The content of the comment, i.e. reply body.
172 },
173 "userComment": { # A comment from a user.
174 "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]175 "originalText": "A String", # 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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]176 "reviewerLanguage": "A 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.
177 "lastModified": { # The last time at which this comment was updated.
178 "nanos": 42,
179 "seconds": "A String",
180 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]181 "thumbsUpCount": 42, # Number of users who have given this review a thumbs up
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]182 "starRating": 42, # The star rating associated with the review, from 1 to 5.
183 "text": "A 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.
184 "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
185 "androidOsVersion": 42, # Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]186 "deviceMetadata": { # Some information about the characteristics of the user's device
187 "screenDensityDpi": 42, # Screen density in DPI
188 "screenHeightPx": 42, # Screen height in pixels
189 "cpuModel": "A String", # Device CPU model e.g. "MSM8974"
190 "productName": "A String", # Device model name (e.g. Droid)
191 "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7")
192 "deviceClass": "A String", # Device class (e.g. tablet)
193 "cpuMake": "A String", # Device CPU make e.g. "Qualcomm"
194 "ramMb": 42, # Device RAM in Megabytes e.g. "2048"
195 "screenWidthPx": 42, # Screen width in pixels
196 "glEsVersion": 42, # OpenGL version
197 "manufacturer": "A String", # Device manufacturer (e.g. Motorola)
198 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]199 "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]200 "thumbsDownCount": 42, # Number of users who have given this review a thumbs down
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]201 },
202 },
203 ],
204 },
205 ],
206 "tokenPagination": {
207 "nextPageToken": "A String",
208 "previousPageToken": "A String",
209 },
210 "pageInfo": {
211 "totalResults": 42,
212 "startIndex": 42,
213 "resultPerPage": 42,
214 },
215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="reply">reply(packageName, reviewId, body)</code>
220 <pre>Reply to a single review, or update an existing reply.
221
222Args:
223 packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
224 reviewId: string, A parameter (required)
225 body: object, The request body. (required)
226 The object takes the form of:
227
228{
229 "replyText": "A String", # The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.
230 }
231
232
233Returns:
234 An object of the form:
235
236 {
237 "result": {
238 "replyText": "A String", # The reply text that was applied.
239 "lastEdited": { # The time at which the reply took effect.
240 "nanos": 42,
241 "seconds": "A String",
242 },
243 },
244 }</pre>
245</div>
246
247</body></html>