| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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_v3.html">Google Play Developer API</a> . <a href="androidpublisher_v3.reviews.html">reviews</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(packageName, reviewId, translationLanguage=None)</a></code></p> |
| 79 | <p class="firstline">Returns a single review.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(packageName, maxResults=None, startIndex=None, token=None, translationLanguage=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Returns a list of reviews. Only reviews from last week will be returned.</p> |
| 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#reply">reply(packageName, reviewId, body=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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, translationLanguage=None)</code> |
| 89 | <pre>Returns a single review. |
| 90 | |
| 91 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 92 | packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 93 | reviewId: string, A parameter (required) |
| 94 | translationLanguage: string, A parameter |
| 95 | |
| 96 | Returns: |
| 97 | An object of the form: |
| 98 | |
| 99 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 100 | "authorName": "A String", # The name of the user who wrote the review. |
| 101 | "comments": [ # A repeated field containing comments for the review. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | "text": "A String", # The content of the comment, i.e. reply body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | "userComment": { # A comment from a user. |
| 111 | "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. |
| 112 | "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent. |
| 113 | "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent. |
| 114 | "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent. |
| 115 | "deviceMetadata": { # Some information about the characteristics of the user's device |
| 116 | "cpuMake": "A String", # Device CPU make e.g. "Qualcomm" |
| 117 | "cpuModel": "A String", # Device CPU model e.g. "MSM8974" |
| 118 | "deviceClass": "A String", # Device class (e.g. tablet) |
| 119 | "glEsVersion": 42, # OpenGL version |
| 120 | "manufacturer": "A String", # Device manufacturer (e.g. Motorola) |
| 121 | "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7") |
| 122 | "productName": "A String", # Device model name (e.g. Droid) |
| 123 | "ramMb": 42, # Device RAM in Megabytes e.g. "2048" |
| 124 | "screenDensityDpi": 42, # Screen density in DPI |
| 125 | "screenHeightPx": 42, # Screen height in pixels |
| 126 | "screenWidthPx": 42, # Screen width in pixels |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | "lastModified": { # The last time at which this comment was updated. |
| 129 | "nanos": 42, |
| 130 | "seconds": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "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. |
| 133 | "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. |
| 134 | "starRating": 42, # The star rating associated with the review, from 1 to 5. |
| 135 | "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. |
| 136 | "thumbsDownCount": 42, # Number of users who have given this review a thumbs down |
| 137 | "thumbsUpCount": 42, # Number of users who have given this review a thumbs up |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 138 | }, |
| 139 | }, |
| 140 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "reviewId": "A String", # Unique identifier for this review. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 142 | }</pre> |
| 143 | </div> |
| 144 | |
| 145 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | <code class="details" id="list">list(packageName, maxResults=None, startIndex=None, token=None, translationLanguage=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 147 | <pre>Returns a list of reviews. Only reviews from last week will be returned. |
| 148 | |
| 149 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 150 | packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | maxResults: integer, A parameter |
| 152 | startIndex: integer, A parameter |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | token: string, A parameter |
| 154 | translationLanguage: string, A parameter |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 155 | |
| 156 | Returns: |
| 157 | An object of the form: |
| 158 | |
| 159 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "pageInfo": { |
| 161 | "resultPerPage": 42, |
| 162 | "startIndex": 42, |
| 163 | "totalResults": 42, |
| 164 | }, |
| 165 | "reviews": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 166 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 167 | "authorName": "A String", # The name of the user who wrote the review. |
| 168 | "comments": [ # A repeated field containing comments for the review. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 169 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | "developerComment": { # A comment from a developer. |
| 171 | "lastModified": { # The last time at which this comment was updated. |
| 172 | "nanos": 42, |
| 173 | "seconds": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 174 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | "text": "A String", # The content of the comment, i.e. reply body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 176 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 177 | "userComment": { # A comment from a user. |
| 178 | "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. |
| 179 | "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent. |
| 180 | "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent. |
| 181 | "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent. |
| 182 | "deviceMetadata": { # Some information about the characteristics of the user's device |
| 183 | "cpuMake": "A String", # Device CPU make e.g. "Qualcomm" |
| 184 | "cpuModel": "A String", # Device CPU model e.g. "MSM8974" |
| 185 | "deviceClass": "A String", # Device class (e.g. tablet) |
| 186 | "glEsVersion": 42, # OpenGL version |
| 187 | "manufacturer": "A String", # Device manufacturer (e.g. Motorola) |
| 188 | "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7") |
| 189 | "productName": "A String", # Device model name (e.g. Droid) |
| 190 | "ramMb": 42, # Device RAM in Megabytes e.g. "2048" |
| 191 | "screenDensityDpi": 42, # Screen density in DPI |
| 192 | "screenHeightPx": 42, # Screen height in pixels |
| 193 | "screenWidthPx": 42, # Screen width in pixels |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 194 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 195 | "lastModified": { # The last time at which this comment was updated. |
| 196 | "nanos": 42, |
| 197 | "seconds": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 198 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 199 | "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. |
| 200 | "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. |
| 201 | "starRating": 42, # The star rating associated with the review, from 1 to 5. |
| 202 | "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. |
| 203 | "thumbsDownCount": 42, # Number of users who have given this review a thumbs down |
| 204 | "thumbsUpCount": 42, # Number of users who have given this review a thumbs up |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 205 | }, |
| 206 | }, |
| 207 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | "reviewId": "A String", # Unique identifier for this review. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 209 | }, |
| 210 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 211 | "tokenPagination": { |
| 212 | "nextPageToken": "A String", |
| 213 | "previousPageToken": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 214 | }, |
| 215 | }</pre> |
| 216 | </div> |
| 217 | |
| 218 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 219 | <code class="details" id="reply">reply(packageName, reviewId, body=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 220 | <pre>Reply to a single review, or update an existing reply. |
| 221 | |
| 222 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 224 | reviewId: string, A parameter (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 225 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 226 | The object takes the form of: |
| 227 | |
| 228 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | |
| 233 | Returns: |
| 234 | An object of the form: |
| 235 | |
| 236 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "result": { |
| 238 | "lastEdited": { # The time at which the reply took effect. |
| 239 | "nanos": 42, |
| 240 | "seconds": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 241 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 242 | "replyText": "A String", # The reply text that was applied. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 243 | }, |
| 244 | }</pre> |
| 245 | </div> |
| 246 | |
| 247 | </body></html> |