Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / androidpublisher_v2.reviews.html
blob: 0e8d71b2af4717ab86c55e5e742af9af2aceae4c [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">
78 <code><a href="#get">get(packageName, reviewId)</a></code></p>
79<p class="firstline">Returns a single review.</p>
80<p class="toc_element">
81 <code><a href="#list">list(packageName, token=None, maxResults=None, startIndex=None)</a></code></p>
82<p class="firstline">Returns a list of reviews.</p>
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">
88 <code class="details" id="get">get(packageName, reviewId)</code>
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)
94
95Returns:
96 An object of the form:
97
98 {
99 "authorName": "A String", # The name of the user who wrote the review.
100 "reviewId": "A String", # Unique identifier for this review.
101 "comments": [ # A repeated field containing comments for the review.
102 {
103 "developerComment": { # A comment from a developer.
104 "lastModified": { # The last time at which this comment was updated.
105 "nanos": 42,
106 "seconds": "A String",
107 },
108 "text": "A String", # The content of the comment, i.e. reply body.
109 },
110 "userComment": { # A comment from a user.
111 "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
112 "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.
113 "lastModified": { # The last time at which this comment was updated.
114 "nanos": 42,
115 "seconds": "A String",
116 },
117 "starRating": 42, # The star rating associated with the review, from 1 to 5.
118 "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.
119 "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
120 "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.
121 "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
122 },
123 },
124 ],
125 }</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="list">list(packageName, token=None, maxResults=None, startIndex=None)</code>
130 <pre>Returns a list of reviews.
131
132Args:
133 packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
134 token: string, A parameter
135 maxResults: integer, A parameter
136 startIndex: integer, A parameter
137
138Returns:
139 An object of the form:
140
141 {
142 "reviews": [
143 {
144 "authorName": "A String", # The name of the user who wrote the review.
145 "reviewId": "A String", # Unique identifier for this review.
146 "comments": [ # A repeated field containing comments for the review.
147 {
148 "developerComment": { # A comment from a developer.
149 "lastModified": { # The last time at which this comment was updated.
150 "nanos": 42,
151 "seconds": "A String",
152 },
153 "text": "A String", # The content of the comment, i.e. reply body.
154 },
155 "userComment": { # A comment from a user.
156 "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
157 "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.
158 "lastModified": { # The last time at which this comment was updated.
159 "nanos": 42,
160 "seconds": "A String",
161 },
162 "starRating": 42, # The star rating associated with the review, from 1 to 5.
163 "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.
164 "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
165 "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.
166 "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
167 },
168 },
169 ],
170 },
171 ],
172 "tokenPagination": {
173 "nextPageToken": "A String",
174 "previousPageToken": "A String",
175 },
176 "pageInfo": {
177 "totalResults": 42,
178 "startIndex": 42,
179 "resultPerPage": 42,
180 },
181 }</pre>
182</div>
183
184<div class="method">
185 <code class="details" id="reply">reply(packageName, reviewId, body)</code>
186 <pre>Reply to a single review, or update an existing reply.
187
188Args:
189 packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
190 reviewId: string, A parameter (required)
191 body: object, The request body. (required)
192 The object takes the form of:
193
194{
195 "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.
196 }
197
198
199Returns:
200 An object of the form:
201
202 {
203 "result": {
204 "replyText": "A String", # The reply text that was applied.
205 "lastEdited": { # The time at which the reply took effect.
206 "nanos": 42,
207 "seconds": "A String",
208 },
209 },
210 }</pre>
211</div>
212
213</body></html>