docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/androidpublisher_v3.reviews.html b/docs/dyn/androidpublisher_v3.reviews.html
index 55e77e4..d7e8324 100644
--- a/docs/dyn/androidpublisher_v3.reviews.html
+++ b/docs/dyn/androidpublisher_v3.reviews.html
@@ -78,7 +78,7 @@
<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>
+ <code><a href="#list">list(packageName, maxResults=None, startIndex=None, token=None, translationLanguage=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=None)</a></code></p>
@@ -89,7 +89,7 @@
<pre>Returns a single review.
Args:
- packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
+ 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
@@ -97,120 +97,120 @@
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.
+ "authorName": "A String", # The name of the user who wrote the 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",
+ "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.
+ "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",
+ "userComment": { # A comment from a user.
+ "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.
+ "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
+ "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
+ "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
+ "deviceMetadata": { # Some information about the characteristics of the user's device
+ "cpuMake": "A String", # Device CPU make e.g. "Qualcomm"
+ "cpuModel": "A String", # Device CPU model e.g. "MSM8974"
+ "deviceClass": "A String", # Device class (e.g. tablet)
+ "glEsVersion": 42, # OpenGL version
+ "manufacturer": "A String", # Device manufacturer (e.g. Motorola)
+ "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7")
+ "productName": "A String", # Device model name (e.g. Droid)
+ "ramMb": 42, # Device RAM in Megabytes e.g. "2048"
+ "screenDensityDpi": 42, # Screen density in DPI
+ "screenHeightPx": 42, # Screen height in pixels
+ "screenWidthPx": 42, # Screen width in pixels
},
- "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)
+ "lastModified": { # The last time at which this comment was updated.
+ "nanos": 42,
+ "seconds": "A String",
},
- "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
+ "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.
+ "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.
+ "thumbsDownCount": 42, # Number of users who have given this review a thumbs down
+ "thumbsUpCount": 42, # Number of users who have given this review a thumbs up
},
},
],
+ "reviewId": "A String", # Unique identifier for this review.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(packageName, translationLanguage=None, token=None, maxResults=None, startIndex=None)</code>
+ <code class="details" id="list">list(packageName, maxResults=None, startIndex=None, token=None, translationLanguage=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
+ packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
maxResults: integer, A parameter
startIndex: integer, A parameter
+ token: string, A parameter
+ translationLanguage: string, A parameter
Returns:
An object of the form:
{
- "reviews": [
+ "pageInfo": {
+ "resultPerPage": 42,
+ "startIndex": 42,
+ "totalResults": 42,
+ },
+ "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.
+ "authorName": "A String", # The name of the user who wrote the 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",
+ "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.
+ "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",
+ "userComment": { # A comment from a user.
+ "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.
+ "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
+ "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
+ "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
+ "deviceMetadata": { # Some information about the characteristics of the user's device
+ "cpuMake": "A String", # Device CPU make e.g. "Qualcomm"
+ "cpuModel": "A String", # Device CPU model e.g. "MSM8974"
+ "deviceClass": "A String", # Device class (e.g. tablet)
+ "glEsVersion": 42, # OpenGL version
+ "manufacturer": "A String", # Device manufacturer (e.g. Motorola)
+ "nativePlatform": "A String", # Comma separated list of native platforms (e.g. "arm", "arm7")
+ "productName": "A String", # Device model name (e.g. Droid)
+ "ramMb": 42, # Device RAM in Megabytes e.g. "2048"
+ "screenDensityDpi": 42, # Screen density in DPI
+ "screenHeightPx": 42, # Screen height in pixels
+ "screenWidthPx": 42, # Screen width in pixels
},
- "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)
+ "lastModified": { # The last time at which this comment was updated.
+ "nanos": 42,
+ "seconds": "A String",
},
- "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
+ "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.
+ "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.
+ "thumbsDownCount": 42, # Number of users who have given this review a thumbs down
+ "thumbsUpCount": 42, # Number of users who have given this review a thumbs up
},
},
],
+ "reviewId": "A String", # Unique identifier for this review.
},
],
- "tokenPagination": {
- "nextPageToken": "A String",
- "previousPageToken": "A String",
- },
- "pageInfo": {
- "totalResults": 42,
- "startIndex": 42,
- "resultPerPage": 42,
+ "tokenPagination": {
+ "nextPageToken": "A String",
+ "previousPageToken": "A String",
},
}</pre>
</div>
@@ -220,13 +220,13 @@
<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)
+ 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.
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.
+ "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.
}
@@ -234,12 +234,12 @@
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",
+ "result": {
+ "lastEdited": { # The time at which the reply took effect.
+ "nanos": 42,
+ "seconds": "A String",
},
+ "replyText": "A String", # The reply text that was applied.
},
}</pre>
</div>