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