File: androidpublisher_v3.reviews.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (247 lines) | stat: -rw-r--r-- 10,083 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<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, translationLanguage=None, token=None, maxResults=None, startIndex=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)</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, "com.spiffygame". (required)
  reviewId: string, A parameter (required)
  translationLanguage: string, A parameter

Returns:
  An object of the form:

    {
    "authorName": "A String", # The name of the user who wrote the review.
    "reviewId": "A String", # Unique identifier for this review.
    "comments": [ # A repeated field containing comments for the review.
      {
        "developerComment": { # A comment from a developer.
          "lastModified": { # The last time at which this comment was updated.
            "nanos": 42,
            "seconds": "A String",
          },
          "text": "A String", # The content of the comment, i.e. reply body.
        },
        "userComment": { # A comment from a user.
          "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
          "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.
          "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.
          "lastModified": { # The last time at which this comment was updated.
            "nanos": 42,
            "seconds": "A String",
          },
          "thumbsUpCount": 42, # Number of users who have given this review a thumbs up
          "starRating": 42, # The star rating associated with the review, from 1 to 5.
          "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.
          "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
          "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.
          "deviceMetadata": { # Some information about the characteristics of the user's device
            "screenDensityDpi": 42, # Screen density in DPI
            "screenHeightPx": 42, # Screen height in pixels
            "cpuModel": "A String", # Device CPU model e.g. "MSM8974"
            "productName": "A String", # Device model name (e.g. Droid)
            "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7")
            "deviceClass": "A String", # Device class (e.g. tablet)
            "cpuMake": "A String", # Device CPU make e.g. "Qualcomm"
            "ramMb": 42, # Device RAM in Megabytes e.g. "2048"
            "screenWidthPx": 42, # Screen width in pixels
            "glEsVersion": 42, # OpenGL version
            "manufacturer": "A String", # Device manufacturer (e.g. Motorola)
          },
          "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
          "thumbsDownCount": 42, # Number of users who have given this review a thumbs down
        },
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(packageName, translationLanguage=None, token=None, maxResults=None, startIndex=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, "com.spiffygame". (required)
  translationLanguage: string, A parameter
  token: string, A parameter
  maxResults: integer, A parameter
  startIndex: integer, A parameter

Returns:
  An object of the form:

    {
    "reviews": [
      {
        "authorName": "A String", # The name of the user who wrote the review.
        "reviewId": "A String", # Unique identifier for this review.
        "comments": [ # A repeated field containing comments for the review.
          {
            "developerComment": { # A comment from a developer.
              "lastModified": { # The last time at which this comment was updated.
                "nanos": 42,
                "seconds": "A String",
              },
              "text": "A String", # The content of the comment, i.e. reply body.
            },
            "userComment": { # A comment from a user.
              "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
              "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.
              "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.
              "lastModified": { # The last time at which this comment was updated.
                "nanos": 42,
                "seconds": "A String",
              },
              "thumbsUpCount": 42, # Number of users who have given this review a thumbs up
              "starRating": 42, # The star rating associated with the review, from 1 to 5.
              "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.
              "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
              "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.
              "deviceMetadata": { # Some information about the characteristics of the user's device
                "screenDensityDpi": 42, # Screen density in DPI
                "screenHeightPx": 42, # Screen height in pixels
                "cpuModel": "A String", # Device CPU model e.g. "MSM8974"
                "productName": "A String", # Device model name (e.g. Droid)
                "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7")
                "deviceClass": "A String", # Device class (e.g. tablet)
                "cpuMake": "A String", # Device CPU make e.g. "Qualcomm"
                "ramMb": 42, # Device RAM in Megabytes e.g. "2048"
                "screenWidthPx": 42, # Screen width in pixels
                "glEsVersion": 42, # OpenGL version
                "manufacturer": "A String", # Device manufacturer (e.g. Motorola)
              },
              "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
              "thumbsDownCount": 42, # Number of users who have given this review a thumbs down
            },
          },
        ],
      },
    ],
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="reply">reply(packageName, reviewId, body)</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, "com.spiffygame". (required)
  reviewId: string, A parameter (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "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.
  }


Returns:
  An object of the form:

    {
    "result": {
      "replyText": "A String", # The reply text that was applied.
      "lastEdited": { # The time at which the reply took effect.
        "nanos": 42,
        "seconds": "A String",
      },
    },
  }</pre>
</div>

</body></html>