Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / androidpublisher_v3.reviews.html
blob: f17edc5a104d14281d967839a2bb4180f87c0108 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.reviews.html">reviews</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]78 <code><a href="#get">get(packageName, reviewId, translationLanguage=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a single review.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#list">list(packageName, maxResults=None, startIndex=None, translationLanguage=None, token=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists all reviews.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#reply">reply(packageName, reviewId, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Replies to a single review, or updates an existing reply.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88 <code class="details" id="get">get(packageName, reviewId, translationLanguage=None, x__xgafv=None)</code>
89 <pre>Gets a single review.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90
91Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]92 packageName: string, Package name of the app. (required)
93 reviewId: string, Unique identifier for a review. (required)
94 translationLanguage: string, Language localization code.
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99
100Returns:
101 An object of the form:
102
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103 { # An Android app review.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;comments&quot;: [ # A repeated field containing comments for the review.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 { # An entry of conversation between user and developer.
106 &quot;developerComment&quot;: { # Developer entry from conversation between user and developer. # A comment from a developer.
107 &quot;lastModified&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The last time at which this comment was updated.
108 # calendar, encoded as a count of seconds and fractions of seconds at
109 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
110 # January 1, 1970.
111 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution.
112 # Must be from 0 to 999,999,999 inclusive.
113 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;text&quot;: &quot;A String&quot;, # The content of the comment, i.e. reply body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 &quot;userComment&quot;: { # User entry from conversation between user and developer. # A comment from a user.
118 &quot;deviceMetadata&quot;: { # Characteristics of the user&#x27;s device. # Information about the characteristics of the user&#x27;s device.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;deviceClass&quot;: &quot;A String&quot;, # Device class (e.g. tablet)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 &quot;cpuModel&quot;: &quot;A String&quot;, # Device CPU model, e.g. &quot;MSM8974&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;glEsVersion&quot;: 42, # OpenGL version
122 &quot;manufacturer&quot;: &quot;A String&quot;, # Device manufacturer (e.g. Motorola)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 &quot;ramMb&quot;: 42, # Device RAM in Megabytes, e.g. &quot;2048&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 &quot;productName&quot;: &quot;A String&quot;, # Device model name (e.g. Droid)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 &quot;screenHeightPx&quot;: 42, # Screen height in pixels
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;nativePlatform&quot;: &quot;A String&quot;, # Comma separated list of native platforms (e.g. &quot;arm&quot;, &quot;arm7&quot;)
127 &quot;cpuMake&quot;: &quot;A String&quot;, # Device CPU make, e.g. &quot;Qualcomm&quot;
128 &quot;screenDensityDpi&quot;: 42, # Screen density in DPI
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 &quot;screenWidthPx&quot;: 42, # Screen width in pixels
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 &quot;thumbsUpCount&quot;: 42, # Number of users who have given this review a thumbs up.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;starRating&quot;: 42, # The star rating associated with the review, from 1 to 5.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]133 &quot;originalText&quot;: &quot;A String&quot;, # Untranslated text of the review, where the review was translated.
134 # If the review was not translated this is left blank.
135 &quot;reviewerLanguage&quot;: &quot;A String&quot;, # Language code for the reviewer. This is taken from the device
136 # settings so is not guaranteed to match the language the review
137 # is written in. May be absent.
138 &quot;device&quot;: &quot;A String&quot;, # Codename for the reviewer&#x27;s device, e.g. klte, flounder. May be absent.
139 &quot;androidOsVersion&quot;: 42, # Integer Android SDK version of the user&#x27;s device at the time the
140 # review was written, e.g. 23 is Marshmallow. May be absent.
141 &quot;appVersionCode&quot;: 42, # Integer version code of the app as installed at the time the
142 # review was written. May be absent.
143 &quot;lastModified&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The last time at which this comment was updated.
144 # calendar, encoded as a count of seconds and fractions of seconds at
145 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
146 # January 1, 1970.
147 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution.
148 # Must be from 0 to 999,999,999 inclusive.
149 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch.
150 },
151 &quot;text&quot;: &quot;A String&quot;, # The content of the comment, i.e. review body. In some cases
152 # users have been able to write a review with separate title and
153 # body; in those cases the title and body are concatenated and
154 # separated by a tab character.
155 &quot;appVersionName&quot;: &quot;A String&quot;, # String version name of the app as installed at the time the
156 # review was written. May be absent.
157 &quot;thumbsDownCount&quot;: 42, # Number of users who have given this review a thumbs down.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 },
159 },
160 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]161 &quot;authorName&quot;: &quot;A String&quot;, # The name of the user who wrote the review.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;reviewId&quot;: &quot;A String&quot;, # Unique identifier for this review.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 }</pre>
164</div>
165
166<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]167 <code class="details" id="list">list(packageName, maxResults=None, startIndex=None, translationLanguage=None, token=None, x__xgafv=None)</code>
168 <pre>Lists all reviews.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169
170Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]171 packageName: string, Package name of the app. (required)
172 maxResults: integer, How many results the list operation should return.
173 startIndex: integer, The index of the first element to return.
174 translationLanguage: string, Language localization code.
175 token: string, Pagination token. If empty, list starts at the first review.
176 x__xgafv: string, V1 error format.
177 Allowed values
178 1 - v1 error format
179 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180
181Returns:
182 An object of the form:
183
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]184 { # Response listing reviews.
185 &quot;reviews&quot;: [ # List of reviews.
186 { # An Android app review.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;comments&quot;: [ # A repeated field containing comments for the review.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]188 { # An entry of conversation between user and developer.
189 &quot;developerComment&quot;: { # Developer entry from conversation between user and developer. # A comment from a developer.
190 &quot;lastModified&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The last time at which this comment was updated.
191 # calendar, encoded as a count of seconds and fractions of seconds at
192 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
193 # January 1, 1970.
194 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution.
195 # Must be from 0 to 999,999,999 inclusive.
196 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;text&quot;: &quot;A String&quot;, # The content of the comment, i.e. reply body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]200 &quot;userComment&quot;: { # User entry from conversation between user and developer. # A comment from a user.
201 &quot;deviceMetadata&quot;: { # Characteristics of the user&#x27;s device. # Information about the characteristics of the user&#x27;s device.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202 &quot;deviceClass&quot;: &quot;A String&quot;, # Device class (e.g. tablet)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]203 &quot;cpuModel&quot;: &quot;A String&quot;, # Device CPU model, e.g. &quot;MSM8974&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]204 &quot;glEsVersion&quot;: 42, # OpenGL version
205 &quot;manufacturer&quot;: &quot;A String&quot;, # Device manufacturer (e.g. Motorola)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]206 &quot;ramMb&quot;: 42, # Device RAM in Megabytes, e.g. &quot;2048&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]207 &quot;productName&quot;: &quot;A String&quot;, # Device model name (e.g. Droid)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;screenHeightPx&quot;: 42, # Screen height in pixels
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]209 &quot;nativePlatform&quot;: &quot;A String&quot;, # Comma separated list of native platforms (e.g. &quot;arm&quot;, &quot;arm7&quot;)
210 &quot;cpuMake&quot;: &quot;A String&quot;, # Device CPU make, e.g. &quot;Qualcomm&quot;
211 &quot;screenDensityDpi&quot;: 42, # Screen density in DPI
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]212 &quot;screenWidthPx&quot;: 42, # Screen width in pixels
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]214 &quot;thumbsUpCount&quot;: 42, # Number of users who have given this review a thumbs up.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]215 &quot;starRating&quot;: 42, # The star rating associated with the review, from 1 to 5.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 &quot;originalText&quot;: &quot;A String&quot;, # Untranslated text of the review, where the review was translated.
217 # If the review was not translated this is left blank.
218 &quot;reviewerLanguage&quot;: &quot;A String&quot;, # Language code for the reviewer. This is taken from the device
219 # settings so is not guaranteed to match the language the review
220 # is written in. May be absent.
221 &quot;device&quot;: &quot;A String&quot;, # Codename for the reviewer&#x27;s device, e.g. klte, flounder. May be absent.
222 &quot;androidOsVersion&quot;: 42, # Integer Android SDK version of the user&#x27;s device at the time the
223 # review was written, e.g. 23 is Marshmallow. May be absent.
224 &quot;appVersionCode&quot;: 42, # Integer version code of the app as installed at the time the
225 # review was written. May be absent.
226 &quot;lastModified&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The last time at which this comment was updated.
227 # calendar, encoded as a count of seconds and fractions of seconds at
228 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
229 # January 1, 1970.
230 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution.
231 # Must be from 0 to 999,999,999 inclusive.
232 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch.
233 },
234 &quot;text&quot;: &quot;A String&quot;, # The content of the comment, i.e. review body. In some cases
235 # users have been able to write a review with separate title and
236 # body; in those cases the title and body are concatenated and
237 # separated by a tab character.
238 &quot;appVersionName&quot;: &quot;A String&quot;, # String version name of the app as installed at the time the
239 # review was written. May be absent.
240 &quot;thumbsDownCount&quot;: 42, # Number of users who have given this review a thumbs down.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 },
242 },
243 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]244 &quot;authorName&quot;: &quot;A String&quot;, # The name of the user who wrote the review.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 &quot;reviewId&quot;: &quot;A String&quot;, # Unique identifier for this review.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 },
247 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]248 &quot;pageInfo&quot;: { # Information about the current page. # Information about the current page.
249 #
250 # List operations that supports paging return only one &quot;page&quot; of results. This
251 # protocol buffer message describes the page that has been returned.
252 &quot;resultPerPage&quot;: 42, # Maximum number of results returned in one page.
253 # ! The number of results included in the API response.
254 &quot;startIndex&quot;: 42, # Index of the first result returned in the current page.
255 &quot;totalResults&quot;: 42, # Total number of results available on the backend
256 # ! The total number of results in the result set.
257 },
258 &quot;tokenPagination&quot;: { # Pagination information returned by a List operation when token pagination # Pagination token, to handle a number of products that is over one page.
259 # is enabled.
260 #
261 # List operations that supports paging return only one &quot;page&quot; of results. This
262 # protocol buffer message describes the page that has been returned.
263 #
264 # When using token pagination, clients should use the next/previous token
265 # to get another page of the result. The presence or absence of next/previous
266 # token indicates whether a next/previous page is available and provides a
267 # mean of accessing this page. ListRequest.page_token should be set to either
268 # next_page_token or previous_page_token to access another page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 &quot;previousPageToken&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]270 &quot;nextPageToken&quot;: &quot;A String&quot;, # Tokens to pass to the standard list field &#x27;page_token&#x27;. Whenever available,
271 # tokens are preferred over manipulating start_index.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 },
273 }</pre>
274</div>
275
276<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]277 <code class="details" id="reply">reply(packageName, reviewId, body=None, x__xgafv=None)</code>
278 <pre>Replies to a single review, or updates an existing reply.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279
280Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]281 packageName: string, Package name of the app. (required)
282 reviewId: string, Unique identifier for a review. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]283 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 The object takes the form of:
285
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]286{ # Request to reply to review or update existing reply.
287 &quot;replyText&quot;: &quot;A String&quot;, # The text to set as the reply. Replies of more than approximately 350
288 # characters will be rejected. HTML tags will be stripped.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 }
290
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]291 x__xgafv: string, V1 error format.
292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295
296Returns:
297 An object of the form:
298
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]299 { # Response on status of replying to a review.
300 &quot;result&quot;: { # The result of replying/updating a reply to review. # The result of replying/updating a reply to review.
301 &quot;lastEdited&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The time at which the reply took effect.
302 # calendar, encoded as a count of seconds and fractions of seconds at
303 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
304 # January 1, 1970.
305 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution.
306 # Must be from 0 to 999,999,999 inclusive.
307 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]309 &quot;replyText&quot;: &quot;A String&quot;, # The reply text that was applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 },
311 }</pre>
312</div>
313
314</body></html>