diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index aacd48dbb0..08e9df12de 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -8,36 +8,63 @@ } } }, - "basePath": "/androidpublisher/v3/applications/", - "baseUrl": "https://www.googleapis.com/androidpublisher/v3/applications/", - "batchPath": "batch/androidpublisher/v3", + "basePath": "", + "baseUrl": "https://www.googleapis.com/", + "batchPath": "batch/androidpublisher", "canonicalName": "Android Publisher", - "description": "Accesses Android application developers' Google Play accounts.", + "description": "Lets Android application developers access their Google Play accounts.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/android-publisher", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/944s_nQUBB2zQT_SQbdy8UnEiHI\"", "icons": { - "x16": "https://www.google.com/images/icons/product/android-16.png", - "x32": "https://www.google.com/images/icons/product/android-32.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "androidpublisher:v3", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://www.mtls.googleapis.com/", "name": "androidpublisher", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, "alt": { "default": "json", - "description": "Data format for the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -60,12 +87,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -75,7 +107,8 @@ "edits": { "methods": { "commit": { - "description": "Commits/applies the changes made in this edit back to the app.", + "description": "Commits an app edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}:commit", "httpMethod": "POST", "id": "androidpublisher.edits.commit", "parameterOrder": [ @@ -84,19 +117,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}:commit", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}:commit", "response": { "$ref": "AppEdit" }, @@ -105,7 +138,8 @@ ] }, "delete": { - "description": "Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.", + "description": "Deletes an app edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "httpMethod": "DELETE", "id": "androidpublisher.edits.delete", "parameterOrder": [ @@ -114,25 +148,26 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "get": { - "description": "Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).", + "description": "Gets an app edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "httpMethod": "GET", "id": "androidpublisher.edits.get", "parameterOrder": [ @@ -141,19 +176,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}", "response": { "$ref": "AppEdit" }, @@ -162,7 +197,8 @@ ] }, "insert": { - "description": "Creates a new edit for an app, populated with the app's current state.", + "description": "Creates a new edit for an app.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits", "httpMethod": "POST", "id": "androidpublisher.edits.insert", "parameterOrder": [ @@ -170,13 +206,13 @@ ], "parameters": { "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits", + "path": "androidpublisher/v3/applications/{packageName}/edits", "request": { "$ref": "AppEdit" }, @@ -188,7 +224,8 @@ ] }, "validate": { - "description": "Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.", + "description": "Validates an app edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}:validate", "httpMethod": "POST", "id": "androidpublisher.edits.validate", "parameterOrder": [ @@ -197,19 +234,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}:validate", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}:validate", "response": { "$ref": "AppEdit" }, @@ -222,7 +259,8 @@ "apks": { "methods": { "addexternallyhosted": { - "description": "Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.", + "description": "Creates a new APK without uploading the APK itself to Google Play, instead\nhosting the APK at a specified URL. This function is only available to\norganizations using Managed Play whose application is configured to\nrestrict distribution to the organizations.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/externallyHosted", "httpMethod": "POST", "id": "androidpublisher.edits.apks.addexternallyhosted", "parameterOrder": [ @@ -231,19 +269,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks/externallyHosted", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/externallyHosted", "request": { "$ref": "ApksAddExternallyHostedRequest" }, @@ -255,6 +293,8 @@ ] }, "list": { + "description": "Lists all current APKs of the app and edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "httpMethod": "GET", "id": "androidpublisher.edits.apks.list", "parameterOrder": [ @@ -263,19 +303,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "response": { "$ref": "ApksListResponse" }, @@ -284,6 +324,8 @@ ] }, "upload": { + "description": "Uploads an APK and adds to the current edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "httpMethod": "POST", "id": "androidpublisher.edits.apks.upload", "mediaUpload": { @@ -291,12 +333,8 @@ "application/octet-stream", "application/vnd.android.package-archive" ], - "maxSize": "1GB", + "maxSize": "10737418240", "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks" - }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks" @@ -309,19 +347,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks", "response": { "$ref": "Apk" }, @@ -335,6 +373,8 @@ "bundles": { "methods": { "list": { + "description": "Lists all current Android App Bundles of the app and edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "httpMethod": "GET", "id": "androidpublisher.edits.bundles.list", "parameterOrder": [ @@ -343,19 +383,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/bundles", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "response": { "$ref": "BundlesListResponse" }, @@ -364,19 +404,16 @@ ] }, "upload": { - "description": "Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.", + "description": "Uploads a new Android App Bundle to this edit.\nIf you are using the Google API client libraries, please increase the\ntimeout of the http request before calling this endpoint\n(a timeout of 2 minutes is recommended).\nSee [Timeouts and\nErrors](https://developers.google.com/api-client-library/java/google-api-java-client/errors)\nfor an example in java.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "httpMethod": "POST", "id": "androidpublisher.edits.bundles.upload", "mediaUpload": { "accept": [ "application/octet-stream" ], - "maxSize": "10GB", + "maxSize": "10737418240", "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles" - }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles" @@ -389,24 +426,24 @@ ], "parameters": { "ackBundleInstallationWarning": { - "description": "Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB).", + "description": "Must be set to true if the bundle installation may trigger a warning on\nuser devices (for example, if installation size may be over a threshold,\ntypically 100 MB).", "location": "query", "type": "boolean" }, "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/bundles", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles", "response": { "$ref": "Bundle" }, @@ -420,19 +457,16 @@ "deobfuscationfiles": { "methods": { "upload": { - "description": "Uploads the deobfuscation file of the specified APK. If a deobfuscation or symbolication file already exists, it will be replaced. See https://developer.android.com/studio/build/shrink-code to learn more about deobfuscation files.", + "description": "Uploads a new deobfuscation file and attaches to the specified APK.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}", "httpMethod": "POST", "id": "androidpublisher.edits.deobfuscationfiles.upload", "mediaUpload": { "accept": [ "application/octet-stream" ], - "maxSize": "300MB", + "maxSize": "31457280", "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}" - }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}" @@ -447,20 +481,18 @@ ], "parameters": { "apkVersionCode": { - "description": "The version code of the APK whose deobfuscation file is being uploaded.", + "description": "The version code of the APK whose Deobfuscation File is being\nuploaded.", "format": "int32", "location": "path", "required": true, "type": "integer" }, "deobfuscationFileType": { + "description": "The type of the deobfuscation file.", "enum": [ - "nativeCode", - "proguard" - ], - "enumDescriptions": [ - "", - "" + "deobfuscationFileTypeUnspecified", + "proguard", + "nativeCode" ], "location": "path", "required": true, @@ -473,13 +505,13 @@ "type": "string" }, "packageName": { - "description": "Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, \"com.spiffygame\".", + "description": "Unique identifier for the Android app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}", "response": { "$ref": "DeobfuscationFilesUploadResponse" }, @@ -493,7 +525,8 @@ "details": { "methods": { "get": { - "description": "Fetches app details for this edit. This includes the default language and developer support contact information.", + "description": "Gets details of an app.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "httpMethod": "GET", "id": "androidpublisher.edits.details.get", "parameterOrder": [ @@ -502,19 +535,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/details", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "response": { "$ref": "AppDetails" }, @@ -523,7 +556,8 @@ ] }, "patch": { - "description": "Updates app details for this edit. This method supports patch semantics.", + "description": "Patches details of an app.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "httpMethod": "PATCH", "id": "androidpublisher.edits.details.patch", "parameterOrder": [ @@ -532,19 +566,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/details", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "request": { "$ref": "AppDetails" }, @@ -556,7 +590,8 @@ ] }, "update": { - "description": "Updates app details for this edit.", + "description": "Updates details of an app.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "httpMethod": "PUT", "id": "androidpublisher.edits.details.update", "parameterOrder": [ @@ -565,19 +600,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/details", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/details", "request": { "$ref": "AppDetails" }, @@ -593,7 +628,8 @@ "expansionfiles": { "methods": { "get": { - "description": "Fetches the Expansion File configuration for the APK specified.", + "description": "Fetches the expansion file configuration for the specified APK.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "httpMethod": "GET", "id": "androidpublisher.edits.expansionfiles.get", "parameterOrder": [ @@ -604,39 +640,37 @@ ], "parameters": { "apkVersionCode": { - "description": "The version code of the APK whose Expansion File configuration is being read or modified.", + "description": "The version code of the APK whose expansion file configuration is being\nread or modified.", "format": "int32", "location": "path", "required": true, "type": "integer" }, "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "expansionFileType": { + "description": "The file type of the file configuration which is being read or modified.", "enum": [ + "expansionFileTypeUnspecified", "main", "patch" ], - "enumDescriptions": [ - "", - "" - ], "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "response": { "$ref": "ExpansionFile" }, @@ -645,7 +679,8 @@ ] }, "patch": { - "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.", + "description": "Patches the APK's expansion file configuration to reference another APK's\nexpansion file.\nTo add a new expansion file use the Upload method.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "httpMethod": "PATCH", "id": "androidpublisher.edits.expansionfiles.patch", "parameterOrder": [ @@ -656,39 +691,37 @@ ], "parameters": { "apkVersionCode": { - "description": "The version code of the APK whose Expansion File configuration is being read or modified.", + "description": "The version code of the APK whose expansion file configuration is being\nread or modified.", "format": "int32", "location": "path", "required": true, "type": "integer" }, "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "expansionFileType": { + "description": "The file type of the expansion file configuration which is being updated.", "enum": [ + "expansionFileTypeUnspecified", "main", "patch" ], - "enumDescriptions": [ - "", - "" - ], "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "request": { "$ref": "ExpansionFile" }, @@ -700,7 +733,8 @@ ] }, "update": { - "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.", + "description": "Updates the APK's expansion file configuration to reference another APK's\nexpansion file.\nTo add a new expansion file use the Upload method.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "httpMethod": "PUT", "id": "androidpublisher.edits.expansionfiles.update", "parameterOrder": [ @@ -711,39 +745,37 @@ ], "parameters": { "apkVersionCode": { - "description": "The version code of the APK whose Expansion File configuration is being read or modified.", + "description": "The version code of the APK whose expansion file configuration is being\nread or modified.", "format": "int32", "location": "path", "required": true, "type": "integer" }, "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "expansionFileType": { + "description": "The file type of the file configuration which is being read or modified.", "enum": [ + "expansionFileTypeUnspecified", "main", "patch" ], - "enumDescriptions": [ - "", - "" - ], "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "request": { "$ref": "ExpansionFile" }, @@ -755,19 +787,16 @@ ] }, "upload": { - "description": "Uploads and attaches a new Expansion File to the APK specified.", + "description": "Uploads a new expansion file and attaches to the specified APK.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "httpMethod": "POST", "id": "androidpublisher.edits.expansionfiles.upload", "mediaUpload": { "accept": [ "application/octet-stream" ], - "maxSize": "2048MB", + "maxSize": "2147483648", "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}" - }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}" @@ -782,39 +811,37 @@ ], "parameters": { "apkVersionCode": { - "description": "The version code of the APK whose Expansion File configuration is being read or modified.", + "description": "The version code of the APK whose expansion file configuration is being\nread or modified.", "format": "int32", "location": "path", "required": true, "type": "integer" }, "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "expansionFileType": { + "description": "The file type of the expansion file configuration which is being updated.", "enum": [ + "expansionFileTypeUnspecified", "main", "patch" ], - "enumDescriptions": [ - "", - "" - ], "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}", "response": { "$ref": "ExpansionFilesUploadResponse" }, @@ -829,6 +856,7 @@ "methods": { "delete": { "description": "Deletes the image (specified by id) from the edit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}", "httpMethod": "DELETE", "id": "androidpublisher.edits.images.delete", "parameterOrder": [ @@ -840,7 +868,7 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" @@ -852,56 +880,44 @@ "type": "string" }, "imageType": { + "description": "Type of the Image.", "enum": [ - "automotiveScreenshots", - "daydreamStereoImage", - "featureGraphic", - "icon", + "appImageTypeUnspecified", "phoneScreenshots", - "promoGraphic", "sevenInchScreenshots", "tenInchScreenshots", - "tvBanner", "tvScreenshots", - "wearScreenshots" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "wearScreenshots", + "icon", + "featureGraphic", + "promoGraphic", + "tvBanner" ], "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "deleteall": { - "description": "Deletes all images for the specified language and image type.", + "description": "Deletes all images for the specified language and image type.\nReturns an empty response if no images are found.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "httpMethod": "DELETE", "id": "androidpublisher.edits.images.deleteall", "parameterOrder": [ @@ -912,56 +928,43 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "imageType": { + "description": "Type of the Image.\nProviding an image type that refers to no images is a no-op.", "enum": [ - "automotiveScreenshots", - "daydreamStereoImage", - "featureGraphic", - "icon", + "appImageTypeUnspecified", "phoneScreenshots", - "promoGraphic", "sevenInchScreenshots", "tenInchScreenshots", - "tvBanner", "tvScreenshots", - "wearScreenshots" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "wearScreenshots", + "icon", + "featureGraphic", + "promoGraphic", + "tvBanner" ], "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).\nProviding a language that is not supported by the App is a no-op.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "response": { "$ref": "ImagesDeleteAllResponse" }, @@ -970,7 +973,8 @@ ] }, "list": { - "description": "Lists all images for the specified language and image type.", + "description": "Lists all images. The response may be empty.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "httpMethod": "GET", "id": "androidpublisher.edits.images.list", "parameterOrder": [ @@ -981,56 +985,43 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "imageType": { + "description": "Type of the Image. Providing an image type that refers to no images will\nreturn an empty response.", "enum": [ - "automotiveScreenshots", - "daydreamStereoImage", - "featureGraphic", - "icon", + "appImageTypeUnspecified", "phoneScreenshots", - "promoGraphic", "sevenInchScreenshots", "tenInchScreenshots", - "tvBanner", "tvScreenshots", - "wearScreenshots" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "wearScreenshots", + "icon", + "featureGraphic", + "promoGraphic", + "tvBanner" ], "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).\nThere must be a store listing for the specified language.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "response": { "$ref": "ImagesListResponse" }, @@ -1039,19 +1030,16 @@ ] }, "upload": { - "description": "Uploads a new image and adds it to the list of images for the specified language and image type.", + "description": "Uploads an image of the specified language and image type, and adds to the\nedit.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "httpMethod": "POST", "id": "androidpublisher.edits.images.upload", "mediaUpload": { "accept": [ "image/*" ], - "maxSize": "15MB", + "maxSize": "15728640", "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}" - }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}" @@ -1066,56 +1054,43 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "imageType": { + "description": "Type of the Image.", "enum": [ - "automotiveScreenshots", - "daydreamStereoImage", - "featureGraphic", - "icon", + "appImageTypeUnspecified", "phoneScreenshots", - "promoGraphic", "sevenInchScreenshots", "tenInchScreenshots", - "tvBanner", "tvScreenshots", - "wearScreenshots" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "wearScreenshots", + "icon", + "featureGraphic", + "promoGraphic", + "tvBanner" ], "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).\nProviding a language that is not supported by the App is a no-op.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}", "response": { "$ref": "ImagesUploadResponse" }, @@ -1129,7 +1104,8 @@ "listings": { "methods": { "delete": { - "description": "Deletes the specified localized store listing from an edit.", + "description": "Deletes a localized store listing.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "httpMethod": "DELETE", "id": "androidpublisher.edits.listings.delete", "parameterOrder": [ @@ -1139,31 +1115,32 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "deleteall": { - "description": "Deletes all localized listings from an edit.", + "description": "Deletes all store listings.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "httpMethod": "DELETE", "id": "androidpublisher.edits.listings.deleteall", "parameterOrder": [ @@ -1172,25 +1149,26 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "get": { - "description": "Fetches information about a localized store listing.", + "description": "Gets a localized store listing.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "httpMethod": "GET", "id": "androidpublisher.edits.listings.get", "parameterOrder": [ @@ -1200,25 +1178,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "response": { "$ref": "Listing" }, @@ -1227,7 +1205,8 @@ ] }, "list": { - "description": "Returns all of the localized store listings attached to this edit.", + "description": "Lists all localized store listings.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "httpMethod": "GET", "id": "androidpublisher.edits.listings.list", "parameterOrder": [ @@ -1236,19 +1215,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings", "response": { "$ref": "ListingsListResponse" }, @@ -1257,7 +1236,8 @@ ] }, "patch": { - "description": "Creates or updates a localized store listing. This method supports patch semantics.", + "description": "Patches a localized store listing.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "httpMethod": "PATCH", "id": "androidpublisher.edits.listings.patch", "parameterOrder": [ @@ -1267,25 +1247,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "request": { "$ref": "Listing" }, @@ -1298,6 +1278,7 @@ }, "update": { "description": "Creates or updates a localized store listing.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "httpMethod": "PUT", "id": "androidpublisher.edits.listings.update", "parameterOrder": [ @@ -1307,25 +1288,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "language": { - "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/listings/{language}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}", "request": { "$ref": "Listing" }, @@ -1341,6 +1322,8 @@ "testers": { "methods": { "get": { + "description": "Gets testers.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "httpMethod": "GET", "id": "androidpublisher.edits.testers.get", "parameterOrder": [ @@ -1350,25 +1333,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "track": { - "description": "The track to read or modify.", + "description": "The track to read from.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/testers/{track}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "response": { "$ref": "Testers" }, @@ -1377,6 +1360,8 @@ ] }, "patch": { + "description": "Patches testers.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "httpMethod": "PATCH", "id": "androidpublisher.edits.testers.patch", "parameterOrder": [ @@ -1386,25 +1371,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "track": { - "description": "The track to read or modify.", + "description": "The track to update.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/testers/{track}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "request": { "$ref": "Testers" }, @@ -1416,6 +1401,8 @@ ] }, "update": { + "description": "Updates testers.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "httpMethod": "PUT", "id": "androidpublisher.edits.testers.update", "parameterOrder": [ @@ -1425,25 +1412,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "track": { - "description": "The track to read or modify.", + "description": "The track to update.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/testers/{track}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}", "request": { "$ref": "Testers" }, @@ -1459,7 +1446,8 @@ "tracks": { "methods": { "get": { - "description": "Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.", + "description": "Gets a track.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "httpMethod": "GET", "id": "androidpublisher.edits.tracks.get", "parameterOrder": [ @@ -1469,25 +1457,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "track": { - "description": "The track to read or modify.", + "description": "Identifier of the track.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/tracks/{track}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "response": { "$ref": "Track" }, @@ -1496,7 +1484,8 @@ ] }, "list": { - "description": "Lists all the track configurations for this edit.", + "description": "Lists all tracks.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks", "httpMethod": "GET", "id": "androidpublisher.edits.tracks.list", "parameterOrder": [ @@ -1505,19 +1494,19 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/tracks", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks", "response": { "$ref": "TracksListResponse" }, @@ -1526,7 +1515,8 @@ ] }, "patch": { - "description": "Updates the track configuration for the specified track type. This method supports patch semantics.", + "description": "Patches a track.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "httpMethod": "PATCH", "id": "androidpublisher.edits.tracks.patch", "parameterOrder": [ @@ -1536,25 +1526,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "track": { - "description": "The track to read or modify.", + "description": "Identifier of the track.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/tracks/{track}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "request": { "$ref": "Track" }, @@ -1566,7 +1556,8 @@ ] }, "update": { - "description": "Updates the track configuration for the specified track type.", + "description": "Updates a track.", + "flatPath": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "httpMethod": "PUT", "id": "androidpublisher.edits.tracks.update", "parameterOrder": [ @@ -1576,25 +1567,25 @@ ], "parameters": { "editId": { - "description": "Unique identifier for this edit.", + "description": "Identifier of the edit.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "track": { - "description": "The track to read or modify.", + "description": "Identifier of the track.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/edits/{editId}/tracks/{track}", + "path": "androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}", "request": { "$ref": "Track" }, @@ -1612,7 +1603,8 @@ "inappproducts": { "methods": { "delete": { - "description": "Delete an in-app product for an app.", + "description": "Deletes an in-app product (i.e. a managed product or a subscriptions).", + "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "httpMethod": "DELETE", "id": "androidpublisher.inappproducts.delete", "parameterOrder": [ @@ -1621,7 +1613,7 @@ ], "parameters": { "packageName": { - "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -1633,13 +1625,14 @@ "type": "string" } }, - "path": "{packageName}/inappproducts/{sku}", + "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "get": { - "description": "Returns information about the in-app product specified.", + "description": "Gets an in-app product, which can be a managed product or a subscription.", + "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "httpMethod": "GET", "id": "androidpublisher.inappproducts.get", "parameterOrder": [ @@ -1648,6 +1641,7 @@ ], "parameters": { "packageName": { + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -1659,7 +1653,7 @@ "type": "string" } }, - "path": "{packageName}/inappproducts/{sku}", + "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "response": { "$ref": "InAppProduct" }, @@ -1668,7 +1662,8 @@ ] }, "insert": { - "description": "Creates a new in-app product for an app.", + "description": "Creates an in-app product (i.e. a managed product or a subscriptions).", + "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts", "httpMethod": "POST", "id": "androidpublisher.inappproducts.insert", "parameterOrder": [ @@ -1676,18 +1671,18 @@ ], "parameters": { "autoConvertMissingPrices": { - "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.", + "description": "If true the prices for all regions targeted by the parent app that don't\nhave a price specified for this in-app product will be auto converted to\nthe target currency based on the default price. Defaults to false.", "location": "query", "type": "boolean" }, "packageName": { - "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/inappproducts", + "path": "androidpublisher/v3/applications/{packageName}/inappproducts", "request": { "$ref": "InAppProduct" }, @@ -1699,7 +1694,8 @@ ] }, "list": { - "description": "List all the in-app products for an Android app, both subscriptions and managed in-app products..", + "description": "Lists all in-app products - both managed products and subscriptions.", + "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts", "httpMethod": "GET", "id": "androidpublisher.inappproducts.list", "parameterOrder": [ @@ -1707,27 +1703,30 @@ ], "parameters": { "maxResults": { + "description": "How many results the list operation should return.", "format": "uint32", "location": "query", "type": "integer" }, "packageName": { - "description": "Unique identifier for the Android app with in-app products; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "startIndex": { + "description": "The index of the first element to return.", "format": "uint32", "location": "query", "type": "integer" }, "token": { + "description": "Pagination token. If empty, list starts at the first product.", "location": "query", "type": "string" } }, - "path": "{packageName}/inappproducts", + "path": "androidpublisher/v3/applications/{packageName}/inappproducts", "response": { "$ref": "InappproductsListResponse" }, @@ -1736,7 +1735,8 @@ ] }, "patch": { - "description": "Updates the details of an in-app product. This method supports patch semantics.", + "description": "Patches an in-app product (i.e. a managed product or a subscriptions).", + "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "httpMethod": "PATCH", "id": "androidpublisher.inappproducts.patch", "parameterOrder": [ @@ -1745,12 +1745,12 @@ ], "parameters": { "autoConvertMissingPrices": { - "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.", + "description": "If true the prices for all regions targeted by the parent app that don't\nhave a price specified for this in-app product will be auto converted to\nthe target currency based on the default price. Defaults to false.", "location": "query", "type": "boolean" }, "packageName": { - "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -1762,7 +1762,7 @@ "type": "string" } }, - "path": "{packageName}/inappproducts/{sku}", + "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "request": { "$ref": "InAppProduct" }, @@ -1774,7 +1774,8 @@ ] }, "update": { - "description": "Updates the details of an in-app product.", + "description": "Updates an in-app product (i.e. a managed product or a subscriptions).", + "flatPath": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "httpMethod": "PUT", "id": "androidpublisher.inappproducts.update", "parameterOrder": [ @@ -1783,12 +1784,12 @@ ], "parameters": { "autoConvertMissingPrices": { - "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.", + "description": "If true the prices for all regions targeted by the parent app that don't\nhave a price specified for this in-app product will be auto converted to\nthe target currency based on the default price. Defaults to false.", "location": "query", "type": "boolean" }, "packageName": { - "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -1800,7 +1801,7 @@ "type": "string" } }, - "path": "{packageName}/inappproducts/{sku}", + "path": "androidpublisher/v3/applications/{packageName}/inappproducts/{sku}", "request": { "$ref": "InAppProduct" }, @@ -1816,7 +1817,8 @@ "internalappsharingartifacts": { "methods": { "uploadapk": { - "description": "Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.", + "description": "Uploads an APK to internal app sharing.\nIf you are using the Google API client libraries, please increase the\ntimeout of the http request before calling this endpoint\n(a timeout of 2 minutes is recommended).\n\nSee [Timeouts and\nErrors](https://developers.google.com/api-client-library/java/google-api-java-client/errors)\nfor an example in java.", + "flatPath": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk", "httpMethod": "POST", "id": "androidpublisher.internalappsharingartifacts.uploadapk", "mediaUpload": { @@ -1824,12 +1826,8 @@ "application/octet-stream", "application/vnd.android.package-archive" ], - "maxSize": "1GB", + "maxSize": "1073741824", "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk" - }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk" @@ -1841,13 +1839,13 @@ ], "parameters": { "packageName": { - "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "internalappsharing/{packageName}/artifacts/apk", + "path": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk", "response": { "$ref": "InternalAppSharingArtifact" }, @@ -1857,19 +1855,16 @@ "supportsMediaUpload": true }, "uploadbundle": { - "description": "Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.", + "description": "Uploads an app bundle to internal app sharing.\nIf you are using the Google API client libraries, please increase the\ntimeout of the http request before calling this endpoint\n(a timeout of 2 minutes is recommended).\n\nSee [Timeouts and\nErrors](https://developers.google.com/api-client-library/java/google-api-java-client/errors)\nfor an example in java.", + "flatPath": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle", "httpMethod": "POST", "id": "androidpublisher.internalappsharingartifacts.uploadbundle", "mediaUpload": { "accept": [ "application/octet-stream" ], - "maxSize": "10GB", + "maxSize": "10737418240", "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle" - }, "simple": { "multipart": true, "path": "/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle" @@ -1881,13 +1876,13 @@ ], "parameters": { "packageName": { - "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" } }, - "path": "internalappsharing/{packageName}/artifacts/bundle", + "path": "androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle", "response": { "$ref": "InternalAppSharingArtifact" }, @@ -1902,6 +1897,7 @@ "methods": { "refund": { "description": "Refund a user's subscription or in-app purchase order.", + "flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund", "httpMethod": "POST", "id": "androidpublisher.orders.refund", "parameterOrder": [ @@ -1910,24 +1906,24 @@ ], "parameters": { "orderId": { - "description": "The order ID provided to the user when the subscription or in-app order was purchased.", + "description": "The order ID provided to the user when the subscription or in-app order was\npurchased.", "location": "path", "required": true, "type": "string" }, "packageName": { - "description": "The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", + "description": "The package name of the application for which this subscription or in-app\nitem was purchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" }, "revoke": { - "description": "Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional)", + "description": "Whether to revoke the purchased item. If set to true, access to the\nsubscription or in-app item will be terminated immediately. If the item is\na recurring subscription, all future payments will also be terminated.\nConsumed in-app items need to be handled by developer's app. (optional).", "location": "query", "type": "boolean" } }, - "path": "{packageName}/orders/{orderId}:refund", + "path": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] @@ -1940,6 +1936,7 @@ "methods": { "acknowledge": { "description": "Acknowledges a purchase of an inapp item.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge", "httpMethod": "POST", "id": "androidpublisher.purchases.products.acknowledge", "parameterOrder": [ @@ -1949,7 +1946,7 @@ ], "parameters": { "packageName": { - "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').", + "description": "The package name of the application the inapp product was sold in (for\nexample, 'com.some.thing').", "location": "path", "required": true, "type": "string" @@ -1961,13 +1958,13 @@ "type": "string" }, "token": { - "description": "The token provided to the user's device when the subscription was purchased.", + "description": "The token provided to the user's device when the inapp product was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge", + "path": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge", "request": { "$ref": "ProductPurchasesAcknowledgeRequest" }, @@ -1977,6 +1974,7 @@ }, "get": { "description": "Checks the purchase and consumption status of an inapp item.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}", "httpMethod": "GET", "id": "androidpublisher.purchases.products.get", "parameterOrder": [ @@ -1986,7 +1984,7 @@ ], "parameters": { "packageName": { - "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').", + "description": "The package name of the application the inapp product was sold in (for\nexample, 'com.some.thing').", "location": "path", "required": true, "type": "string" @@ -1998,13 +1996,13 @@ "type": "string" }, "token": { - "description": "The token provided to the user's device when the inapp product was purchased.", + "description": "The token provided to the user's device when the inapp product was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/products/{productId}/tokens/{token}", + "path": "androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}", "response": { "$ref": "ProductPurchase" }, @@ -2018,6 +2016,7 @@ "methods": { "acknowledge": { "description": "Acknowledges a subscription purchase.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.acknowledge", "parameterOrder": [ @@ -2027,7 +2026,7 @@ ], "parameters": { "packageName": { - "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", + "description": "The package name of the application for which this subscription was\npurchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" @@ -2039,13 +2038,13 @@ "type": "string" }, "token": { - "description": "The token provided to the user's device when the subscription was purchased.", + "description": "The token provided to the user's device when the subscription was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge", + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge", "request": { "$ref": "SubscriptionPurchasesAcknowledgeRequest" }, @@ -2054,7 +2053,8 @@ ] }, "cancel": { - "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.", + "description": "Cancels a user's subscription purchase. The subscription remains valid\nuntil its expiration time.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.cancel", "parameterOrder": [ @@ -2064,7 +2064,7 @@ ], "parameters": { "packageName": { - "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", + "description": "The package name of the application for which this subscription was\npurchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" @@ -2076,19 +2076,20 @@ "type": "string" }, "token": { - "description": "The token provided to the user's device when the subscription was purchased.", + "description": "The token provided to the user's device when the subscription was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "defer": { - "description": "Defers a user's subscription purchase until a specified future expiration time.", + "description": "Defers a user's subscription purchase until a specified future expiration\ntime.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.defer", "parameterOrder": [ @@ -2098,7 +2099,7 @@ ], "parameters": { "packageName": { - "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", + "description": "The package name of the application for which this subscription was\npurchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" @@ -2110,13 +2111,13 @@ "type": "string" }, "token": { - "description": "The token provided to the user's device when the subscription was purchased.", + "description": "The token provided to the user's device when the subscription was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer", + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer", "request": { "$ref": "SubscriptionPurchasesDeferRequest" }, @@ -2128,7 +2129,8 @@ ] }, "get": { - "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.", + "description": "Checks whether a user's subscription purchase is valid and returns its\nexpiry time.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}", "httpMethod": "GET", "id": "androidpublisher.purchases.subscriptions.get", "parameterOrder": [ @@ -2138,7 +2140,7 @@ ], "parameters": { "packageName": { - "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", + "description": "The package name of the application for which this subscription was\npurchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" @@ -2150,13 +2152,13 @@ "type": "string" }, "token": { - "description": "The token provided to the user's device when the subscription was purchased.", + "description": "The token provided to the user's device when the subscription was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}", + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}", "response": { "$ref": "SubscriptionPurchase" }, @@ -2165,7 +2167,8 @@ ] }, "refund": { - "description": "Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.", + "description": "Refunds a user's subscription purchase, but the subscription remains valid\nuntil its expiration time and it will continue to recur.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.refund", "parameterOrder": [ @@ -2175,31 +2178,32 @@ ], "parameters": { "packageName": { - "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", + "description": "The package name of the application for which this subscription was\npurchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "The purchased subscription ID (for example, 'monthly001').", + "description": "\"The purchased subscription ID (for example, 'monthly001').", "location": "path", "required": true, "type": "string" }, "token": { - "description": "The token provided to the user's device when the subscription was purchased.", + "description": "The token provided to the user's device when the subscription was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund", + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] }, "revoke": { - "description": "Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.", + "description": "Refunds and immediately revokes a user's subscription purchase. Access to\nthe subscription will be terminated immediately and it will stop recurring.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.revoke", "parameterOrder": [ @@ -2209,7 +2213,7 @@ ], "parameters": { "packageName": { - "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", + "description": "The package name of the application for which this subscription was\npurchased (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" @@ -2221,13 +2225,13 @@ "type": "string" }, "token": { - "description": "The token provided to the user's device when the subscription was purchased.", + "description": "The token provided to the user's device when the subscription was\npurchased.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke", + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] @@ -2238,6 +2242,7 @@ "methods": { "list": { "description": "Lists the purchases that were canceled, refunded or charged-back.", + "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases", "httpMethod": "GET", "id": "androidpublisher.purchases.voidedpurchases.list", "parameterOrder": [ @@ -2245,45 +2250,48 @@ ], "parameters": { "endTime": { - "description": "The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.", + "description": "The time, in milliseconds since the Epoch, of the newest voided purchase\nthat you want to see in the response. The value of this parameter cannot\nbe greater than the current time and is ignored if a pagination token is\nset. Default value is current time.\nNote: This filter is applied on the time at which the record is seen as\nvoided by our systems and not the actual voided time returned in the\nresponse.", "format": "int64", "location": "query", "type": "string" }, "maxResults": { + "description": "Defines how many results the list operation should return.\nThe default number depends on the resource collection.", "format": "uint32", "location": "query", "type": "integer" }, "packageName": { - "description": "The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').", + "description": "The package name of the application for which voided purchases need to be\nreturned (for example, 'com.some.thing').", "location": "path", "required": true, "type": "string" }, "startIndex": { + "description": "Defines the index of the first element to return.\nThis can only be used if indexed paging is enabled.", "format": "uint32", "location": "query", "type": "integer" }, "startTime": { - "description": "The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.", + "description": "The time, in milliseconds since the Epoch, of the oldest voided purchase\nthat you want to see in the response. The value of this parameter cannot\nbe older than 30 days and is ignored if a pagination token is set.\nDefault value is current time minus 30 days.\nNote: This filter is applied on the time at which the record is seen as\nvoided by our systems and not the actual voided time returned in the\nresponse.", "format": "int64", "location": "query", "type": "string" }, "token": { + "description": "Defines the token of the page to return, usually taken from\nTokenPagination.\nThis can only be used if token paging is enabled.", "location": "query", "type": "string" }, "type": { - "description": "The type of voided purchases that you want to see in the response. Possible values are: \n- 0: Only voided in-app product purchases will be returned in the response. This is the default value.\n- 1: Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken.", + "description": "The type of voided purchases that you want to see in the response.\nPossible values are:\n0. Only voided in-app product purchases will be returned in the\n response. This is the default value.\n1. Both voided in-app purchases and voided subscription purchases\n will be returned in the response.\n\nNote: Before requesting to receive voided subscription purchases, you\nmust switch to use orderId in the response which uniquely identifies\none-time purchases and subscriptions. Otherwise, you will receive multiple\nsubscription orders with the same PurchaseToken, because subscription\nrenewal orders share the same PurchaseToken.", "format": "int32", "location": "query", "type": "integer" } }, - "path": "{packageName}/purchases/voidedpurchases", + "path": "androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases", "response": { "$ref": "VoidedPurchasesListResponse" }, @@ -2298,7 +2306,8 @@ "reviews": { "methods": { "get": { - "description": "Returns a single review.", + "description": "Gets a single review.", + "flatPath": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}", "httpMethod": "GET", "id": "androidpublisher.reviews.get", "parameterOrder": [ @@ -2307,22 +2316,24 @@ ], "parameters": { "packageName": { - "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "reviewId": { + "description": "Unique identifier for a review.", "location": "path", "required": true, "type": "string" }, "translationLanguage": { + "description": "Language localization code.", "location": "query", "type": "string" } }, - "path": "{packageName}/reviews/{reviewId}", + "path": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}", "response": { "$ref": "Review" }, @@ -2331,7 +2342,8 @@ ] }, "list": { - "description": "Returns a list of reviews. Only reviews from last week will be returned.", + "description": "Lists all reviews.", + "flatPath": "androidpublisher/v3/applications/{packageName}/reviews", "httpMethod": "GET", "id": "androidpublisher.reviews.list", "parameterOrder": [ @@ -2339,31 +2351,35 @@ ], "parameters": { "maxResults": { + "description": "How many results the list operation should return.", "format": "uint32", "location": "query", "type": "integer" }, "packageName": { - "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "startIndex": { + "description": "The index of the first element to return.", "format": "uint32", "location": "query", "type": "integer" }, "token": { + "description": "Pagination token. If empty, list starts at the first review.", "location": "query", "type": "string" }, "translationLanguage": { + "description": "Language localization code.", "location": "query", "type": "string" } }, - "path": "{packageName}/reviews", + "path": "androidpublisher/v3/applications/{packageName}/reviews", "response": { "$ref": "ReviewsListResponse" }, @@ -2372,7 +2388,8 @@ ] }, "reply": { - "description": "Reply to a single review, or update an existing reply.", + "description": "Replies to a single review, or updates an existing reply.", + "flatPath": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}:reply", "httpMethod": "POST", "id": "androidpublisher.reviews.reply", "parameterOrder": [ @@ -2381,18 +2398,19 @@ ], "parameters": { "packageName": { - "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" }, "reviewId": { + "description": "Unique identifier for a review.", "location": "path", "required": true, "type": "string" } }, - "path": "{packageName}/reviews/{reviewId}:reply", + "path": "androidpublisher/v3/applications/{packageName}/reviews/{reviewId}:reply", "request": { "$ref": "ReviewsReplyRequest" }, @@ -2404,172 +2422,21 @@ ] } } - }, - "systemapks": { - "resources": { - "variants": { - "methods": { - "create": { - "description": "Creates a new variant of APK which is suitable for inclusion in a system image.", - "httpMethod": "POST", - "id": "androidpublisher.systemapks.variants.create", - "parameterOrder": [ - "packageName", - "versionCode" - ], - "parameters": { - "packageName": { - "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".", - "location": "path", - "required": true, - "type": "string" - }, - "versionCode": { - "description": "The version code of the App Bundle.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "{packageName}/systemApks/{versionCode}/variants", - "request": { - "$ref": "SystemApkVariantsCreateRequest" - }, - "response": { - "$ref": "Variant" - }, - "scopes": [ - "https://www.googleapis.com/auth/androidpublisher" - ] - }, - "download": { - "description": "Download a previously created APK which is suitable for inclusion in a system image.", - "httpMethod": "GET", - "id": "androidpublisher.systemapks.variants.download", - "parameterOrder": [ - "packageName", - "versionCode", - "variantId" - ], - "parameters": { - "packageName": { - "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".", - "location": "path", - "required": true, - "type": "string" - }, - "variantId": { - "format": "uint32", - "location": "path", - "required": true, - "type": "integer" - }, - "versionCode": { - "description": "The version code of the App Bundle.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "{packageName}/systemApks/{versionCode}/variants/{variantId}:download", - "scopes": [ - "https://www.googleapis.com/auth/androidpublisher" - ], - "supportsMediaDownload": true, - "useMediaDownloadService": true - }, - "get": { - "description": "Returns a previously created system APK variant.", - "httpMethod": "GET", - "id": "androidpublisher.systemapks.variants.get", - "parameterOrder": [ - "packageName", - "versionCode", - "variantId" - ], - "parameters": { - "packageName": { - "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".", - "location": "path", - "required": true, - "type": "string" - }, - "variantId": { - "description": "Unique identifier for this variant.", - "format": "uint32", - "location": "path", - "required": true, - "type": "integer" - }, - "versionCode": { - "description": "The version code of the App Bundle.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "{packageName}/systemApks/{versionCode}/variants/{variantId}", - "response": { - "$ref": "Variant" - }, - "scopes": [ - "https://www.googleapis.com/auth/androidpublisher" - ] - }, - "list": { - "description": "Returns the list of previously created system APK variants.", - "httpMethod": "GET", - "id": "androidpublisher.systemapks.variants.list", - "parameterOrder": [ - "packageName", - "versionCode" - ], - "parameters": { - "packageName": { - "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".", - "location": "path", - "required": true, - "type": "string" - }, - "versionCode": { - "description": "The version code of the App Bundle.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "{packageName}/systemApks/{versionCode}/variants", - "response": { - "$ref": "SystemApkVariantsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/androidpublisher" - ] - } - } - } - } } }, - "revision": "20200602", + "revision": "20200607", "rootUrl": "https://www.googleapis.com/", "schemas": { "Apk": { + "description": "Information about an APK. The resource for ApksService.", "id": "Apk", "properties": { "binary": { "$ref": "ApkBinary", "description": "Information about the binary payload of this APK." }, - "testBinary": { - "$ref": "ApkBinary" - }, "versionCode": { - "description": "The version code of the APK, as specified in the APK's manifest file.", + "description": "The version code of the APK, as specified in the manifest file.", "format": "int32", "type": "integer" } @@ -2581,17 +2448,18 @@ "id": "ApkBinary", "properties": { "sha1": { - "description": "A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.", + "description": "A sha1 hash of the APK payload, encoded as a hex string and matching the\noutput of the sha1sum command.", "type": "string" }, "sha256": { - "description": "A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command.", + "description": "A sha256 hash of the APK payload, encoded as a hex string and matching\nthe output of the sha256sum command.", "type": "string" } }, "type": "object" }, "ApksAddExternallyHostedRequest": { + "description": "Request to create a new externally hosted APK.", "id": "ApksAddExternallyHostedRequest", "properties": { "externallyHostedApk": { @@ -2602,6 +2470,7 @@ "type": "object" }, "ApksAddExternallyHostedResponse": { + "description": "Response for creating a new externally hosted APK.", "id": "ApksAddExternallyHostedResponse", "properties": { "externallyHostedApk": { @@ -2612,23 +2481,25 @@ "type": "object" }, "ApksListResponse": { + "description": "Response listing all APKs.", "id": "ApksListResponse", "properties": { "apks": { + "description": "All APKs.", "items": { "$ref": "Apk" }, "type": "array" }, "kind": { - "default": "androidpublisher#apksListResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apksListResponse\".", + "description": "The kind of this response (\"androidpublisher#apksListResponse\").", "type": "string" } }, "type": "object" }, "AppDetails": { + "description": "The app details. The resource for DetailsService.", "id": "AppDetails", "properties": { "contactEmail": { @@ -2651,33 +2522,34 @@ "type": "object" }, "AppEdit": { - "description": "Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.", + "description": "An app edit. The resource for EditsService.", "id": "AppEdit", "properties": { "expiryTimeSeconds": { - "description": "The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).", + "description": "Output only. The time (as seconds since Epoch) at which the edit will expire and\nwill be no longer valid for use.", "type": "string" }, "id": { - "description": "The ID of the edit that can be used in subsequent API calls.", + "description": "Output only. Identifier of the edit. Can be used in subsequent API calls.", "type": "string" } }, "type": "object" }, "Bundle": { + "description": "Information about a bundle. The resource for BundlesService.", "id": "Bundle", "properties": { "sha1": { - "description": "A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command.", + "description": "A sha1 hash of the upload payload, encoded as a hex string and matching\nthe output of the sha1sum command.", "type": "string" }, "sha256": { - "description": "A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command.", + "description": "A sha256 hash of the upload payload, encoded as a hex string and matching\nthe output of the sha256sum command.", "type": "string" }, "versionCode": { - "description": "The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file.", + "description": "The version code of the Android App Bundle, as specified in the Android App\nBundle's base module APK manifest file.", "format": "int32", "type": "integer" } @@ -2685,23 +2557,25 @@ "type": "object" }, "BundlesListResponse": { + "description": "Response listing all bundles.", "id": "BundlesListResponse", "properties": { "bundles": { + "description": "All bundles.", "items": { "$ref": "Bundle" }, "type": "array" }, "kind": { - "default": "androidpublisher#bundlesListResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#bundlesListResponse\".", + "description": "The kind of this response (\"androidpublisher#bundlesListResponse\").", "type": "string" } }, "type": "object" }, "Comment": { + "description": "An entry of conversation between user and developer.", "id": "Comment", "properties": { "developerComment": { @@ -2715,41 +2589,19 @@ }, "type": "object" }, - "Control": { - "id": "Control", - "properties": { - "modRanges": { - "items": { - "$ref": "ModRange" - }, - "type": "array" - }, - "stratifiedSamplings": { - "items": { - "$ref": "StratifiedSampling" - }, - "type": "array" - }, - "versionCodes": { - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "CountryTargeting": { + "description": "Country targeting specification.", "id": "CountryTargeting", "properties": { "countries": { + "description": "Countries to target, specified as two letter [CLDR\ncodes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html).", "items": { "type": "string" }, "type": "array" }, "includeRestOfWorld": { + "description": "Include \"rest of world\" as well as explicitly targeted countries.", "type": "boolean" } }, @@ -2761,21 +2613,34 @@ "properties": { "symbolType": { "description": "The type of the deobfuscation file.", + "enum": [ + "deobfuscationFileTypeUnspecified", + "proguard", + "nativeCode" + ], + "enumDescriptions": [ + "Unspecified deobfuscation file type.", + "Proguard deobfuscation file type.", + "Native debugging symbols file type." + ], "type": "string" } }, "type": "object" }, "DeobfuscationFilesUploadResponse": { + "description": "Responses for the upload.", "id": "DeobfuscationFilesUploadResponse", "properties": { "deobfuscationFile": { - "$ref": "DeobfuscationFile" + "$ref": "DeobfuscationFile", + "description": "The uploaded Deobfuscation File configuration." } }, "type": "object" }, "DeveloperComment": { + "description": "Developer entry from conversation between user and developer.", "id": "DeveloperComment", "properties": { "lastModified": { @@ -2790,14 +2655,15 @@ "type": "object" }, "DeviceMetadata": { + "description": "Characteristics of the user's device.", "id": "DeviceMetadata", "properties": { "cpuMake": { - "description": "Device CPU make e.g. \"Qualcomm\"", + "description": "Device CPU make, e.g. \"Qualcomm\"", "type": "string" }, "cpuModel": { - "description": "Device CPU model e.g. \"MSM8974\"", + "description": "Device CPU model, e.g. \"MSM8974\"", "type": "string" }, "deviceClass": { @@ -2822,7 +2688,7 @@ "type": "string" }, "ramMb": { - "description": "Device RAM in Megabytes e.g. \"2048\"", + "description": "Device RAM in Megabytes, e.g. \"2048\"", "format": "int32", "type": "integer" }, @@ -2844,38 +2710,17 @@ }, "type": "object" }, - "DeviceSpec": { - "id": "DeviceSpec", - "properties": { - "screenDensity": { - "format": "uint32", - "type": "integer" - }, - "supportedAbis": { - "items": { - "type": "string" - }, - "type": "array" - }, - "supportedLocales": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "ExpansionFile": { + "description": "An expansion file. The resource for ExpansionFilesService.", "id": "ExpansionFile", "properties": { "fileSize": { - "description": "If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.", + "description": "If set, this field indicates that this APK has an expansion file uploaded\nto it: this APK does not reference another APK's expansion file.\nThe field's value is the size of the uploaded expansion file in bytes.", "format": "int64", "type": "string" }, "referencesVersion": { - "description": "If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.", + "description": "If set, this APK's expansion file references another APK's expansion file.\nThe file_size field will not be set.", "format": "int32", "type": "integer" } @@ -2883,16 +2728,18 @@ "type": "object" }, "ExpansionFilesUploadResponse": { + "description": "Response for uploading an expansion file.", "id": "ExpansionFilesUploadResponse", "properties": { "expansionFile": { - "$ref": "ExpansionFile" + "$ref": "ExpansionFile", + "description": "The uploaded expansion file configuration." } }, "type": "object" }, "ExternallyHostedApk": { - "description": "Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel", + "description": "Defines an APK available for this application that is hosted externally\nand not uploaded to Google Play.\nThis function is only available to organizations using Managed Play whose\napplication is configured to restrict distribution to the organizations.", "id": "ExternallyHostedApk", "properties": { "applicationLabel": { @@ -2900,7 +2747,7 @@ "type": "string" }, "certificateBase64s": { - "description": "A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.", + "description": "A certificate (or array of certificates if a certificate-chain is used)\nused to sign this APK, represented as a base64 encoded byte array.", "items": { "type": "string" }, @@ -2911,11 +2758,11 @@ "type": "string" }, "fileSha1Base64": { - "description": "The SHA1 checksum of this APK, represented as a base64 encoded byte array.", + "description": "The sha1 checksum of this APK, represented as a base64 encoded byte\narray.", "type": "string" }, "fileSha256Base64": { - "description": "The SHA256 checksum of this APK, represented as a base64 encoded byte array.", + "description": "The sha256 checksum of this APK, represented as a base64 encoded byte\narray.", "type": "string" }, "fileSize": { @@ -2958,7 +2805,7 @@ "usesPermissions": { "description": "The permissions requested by this APK.", "items": { - "$ref": "ExternallyHostedApkUsesPermission" + "$ref": "UsesPermission" }, "type": "array" }, @@ -2974,23 +2821,8 @@ }, "type": "object" }, - "ExternallyHostedApkUsesPermission": { - "description": "A permission used by this APK.", - "id": "ExternallyHostedApkUsesPermission", - "properties": { - "maxSdkVersion": { - "description": "Optionally, the maximum SDK version for which the permission is required.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "The name of the permission requested.", - "type": "string" - } - }, - "type": "object" - }, "Image": { + "description": "An uploaded image. The resource for ImagesService.", "id": "Image", "properties": { "id": { @@ -2998,11 +2830,11 @@ "type": "string" }, "sha1": { - "description": "A sha1 hash of the image that was uploaded.", + "description": "A sha1 hash of the image.", "type": "string" }, "sha256": { - "description": "A sha256 hash of the image that was uploaded.", + "description": "A sha256 hash of the image.", "type": "string" }, "url": { @@ -3013,9 +2845,11 @@ "type": "object" }, "ImagesDeleteAllResponse": { + "description": "Response for deleting all images.", "id": "ImagesDeleteAllResponse", "properties": { "deleted": { + "description": "The deleted images.", "items": { "$ref": "Image" }, @@ -3025,9 +2859,11 @@ "type": "object" }, "ImagesListResponse": { + "description": "Response listing all images.", "id": "ImagesListResponse", "properties": { "images": { + "description": "All listed Images.", "items": { "$ref": "Image" }, @@ -3037,133 +2873,155 @@ "type": "object" }, "ImagesUploadResponse": { + "description": "Response for uploading an image.", "id": "ImagesUploadResponse", "properties": { "image": { - "$ref": "Image" + "$ref": "Image", + "description": "The uploaded image." } }, "type": "object" }, "InAppProduct": { + "description": "An in-app product. The resource for InappproductsService.", "id": "InAppProduct", "properties": { "defaultLanguage": { - "description": "The default language of the localized data, as defined by BCP 47. e.g. \"en-US\", \"en-GB\".", + "description": "Default language of the localized data, as defined by BCP-47. e.g. \"en-US\".", "type": "string" }, "defaultPrice": { "$ref": "Price", - "description": "Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency." + "description": "Default price. Cannot be zero, as in-app products are never free.\nAlways in the developer's Checkout merchant currency." }, "gracePeriod": { - "description": "Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = \"P3D\" (three days), \"P7D\" (seven days), \"P14D\" (fourteen days), and \"P30D\" (thirty days)", + "description": "Grace period of the subscription, specified in ISO 8601 format. Allows\ndevelopers to give their subscribers a grace period when the payment\nfor the new recurrence period is declined.\nAcceptable values are P0D (zero days), P3D (three days), P7D (seven days),\nP14D (14 days), and P30D (30 days).", "type": "string" }, "listings": { "additionalProperties": { - "$ref": "InAppProductListing", - "description": "The language of the localized data, as defined by BCP 47. i.e.: \"en-US\", \"en-GB\"." + "$ref": "InAppProductListing" }, - "description": "List of localized title and description data.", + "description": "List of localized title and description data. Map key is the language of\nthe localized data, as defined by BCP-47, e.g. \"en-US\".", "type": "object" }, "packageName": { - "description": "The package name of the parent app.", + "description": "Package name of the parent app.", "type": "string" }, "prices": { "additionalProperties": { - "$ref": "Price", - "description": "Region code, as defined by ISO 3166-2." + "$ref": "Price" }, - "description": "Prices per buyer region. None of these prices should be zero. In-app products can never be free.", + "description": "Prices per buyer region. None of these can be zero, as in-app products are\nnever free. Map key is region code, as defined by ISO 3166-2.", "type": "object" }, "purchaseType": { - "description": "Purchase type enum value. Unmodifiable after creation.", - "type": "string" - }, - "resubscribeEligibility": { - "description": "Whether or not the developer wants the specific subscription to be resubscribable. If the developer doesn't use PBL2.0, this value is ignored since the feature is only for developers using PBL2.0. This feature allows users to resubscribe to an expired subscription directly from the subscription center by clicking on a \"Resubscribe\" CTA under the entry for the expired subscription.", + "description": "The type of the product, e.g. a recurring subscription.", + "enum": [ + "purchaseTypeUnspecified", + "managedUser", + "subscription" + ], + "enumDescriptions": [ + "Unspecified purchase type.", + "The default product type - one time purchase.", + "In-app product with a recurring period." + ], "type": "string" }, "sku": { - "description": "The stock-keeping-unit (SKU) of the product, unique within an app.", + "description": "Stock-keeping-unit (SKU) of the product, unique within an app.", "type": "string" }, "status": { + "description": "The status of the product, e.g. whether it's active.", + "enum": [ + "statusUnspecified", + "active", + "inactive" + ], + "enumDescriptions": [ + "Unspecified status.", + "The product is published and active in the store.", + "The product is not published and therefore inactive in the store." + ], "type": "string" }, "subscriptionPeriod": { - "description": "Subscription period, specified in ISO 8601 format. Acceptable values are \"P1W\" (one week), \"P1M\" (one month), \"P3M\" (three months), \"P6M\" (six months), and \"P1Y\" (one year).", + "description": "Subscription period, specified in ISO 8601 format. Acceptable values are\nP1W (one week), P1M (one month), P3M (three months), P6M (six months),\nand P1Y (one year).", "type": "string" }, "trialPeriod": { - "description": "Trial period, specified in ISO 8601 format. Acceptable values are anything between \"P7D\" (seven days) and \"P999D\" (999 days). Seasonal subscriptions cannot have a trial period.", + "description": "Trial period, specified in ISO 8601 format. Acceptable values are anything\nbetween P7D (seven days) and P999D (999 days).", "type": "string" } }, "type": "object" }, "InAppProductListing": { + "description": "Store listing of a single in-app product.", "id": "InAppProductListing", "properties": { "benefits": { - "description": "The localized entitlement benefits of the in-app product. These are supported only for subscriptions.", + "description": "Localized entitlement benefits for a subscription.", "items": { "type": "string" }, "type": "array" }, "description": { - "description": "The localized description of the in-app product. These are deprecated for subscriptions.", + "description": "Description for the store listing.", "type": "string" }, "title": { - "description": "The localized title of the in-app product.", + "description": "Title for the store listing.", "type": "string" } }, "type": "object" }, "InappproductsListResponse": { + "description": "Response listing all in-app products.", "id": "InappproductsListResponse", "properties": { "inappproduct": { + "description": "All in-app products.", "items": { "$ref": "InAppProduct" }, "type": "array" }, "kind": { - "default": "androidpublisher#inappproductsListResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#inappproductsListResponse\".", + "description": "The kind of this response (\"androidpublisher#inappproductsListResponse\").", "type": "string" }, "pageInfo": { - "$ref": "PageInfo" + "$ref": "PageInfo", + "description": "Information about the current page." }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "description": "Pagination token, to handle a number of products that is over one page." } }, "type": "object" }, "InternalAppSharingArtifact": { - "description": "An artifact resource which gets created when uploading an APK or Android App Bundle through internal app sharing.", + "description": "An artifact resource which gets created when uploading an APK or Android\nApp Bundle through internal app sharing.", "id": "InternalAppSharingArtifact", "properties": { "certificateFingerprint": { - "description": "The SHA256 fingerprint of the certificate used to signed the generated artifact.", + "description": "The sha256 fingerprint of the certificate used to sign the generated\nartifact.", "type": "string" }, "downloadUrl": { - "description": "The download URL generated for the uploaded artifact. Users that are authorized to download can follow the link to the Play Store app to install it.", + "description": "The download URL generated for the uploaded artifact.\nUsers that are authorized to download can follow the link to the Play\nStore app to install it.", "type": "string" }, "sha256": { - "description": "The SHA-256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command.", + "description": "The sha256 hash of the artifact represented as a lowercase hexadecimal\nnumber, matching the output of the sha256sum command.", "type": "string" } }, @@ -3174,12 +3032,12 @@ "id": "IntroductoryPriceInfo", "properties": { "introductoryPriceAmountMicros": { - "description": "Introductory price of the subscription, not including tax. The currency is the same as price_currency_code. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.", + "description": "Introductory price of the subscription, not including tax.\nThe currency is the same as price_currency_code. Price is\nexpressed in micro-units, where 1,000,000 micro-units represents one unit\nof the currency. For example, if the subscription price is €1.99,\nprice_amount_micros is 1990000.", "format": "int64", "type": "string" }, "introductoryPriceCurrencyCode": { - "description": "ISO 4217 currency code for the introductory subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\".", + "description": "ISO 4217 currency code for the introductory subscription price.\nFor example, if the price is specified in British pounds sterling,\nprice_currency_code is \"GBP\".", "type": "string" }, "introductoryPriceCycles": { @@ -3188,29 +3046,30 @@ "type": "integer" }, "introductoryPricePeriod": { - "description": "Introductory price period, specified in ISO 8601 format. Common values are (but not limited to) \"P1W\" (one week), \"P1M\" (one month), \"P3M\" (three months), \"P6M\" (six months), and \"P1Y\" (one year).", + "description": "Introductory price period, specified in ISO 8601 format.\nCommon values are (but not limited to) \"P1W\" (one\nweek), \"P1M\" (one month), \"P3M\" (three months), \"P6M\" (six months),\nand \"P1Y\" (one year).", "type": "string" } }, "type": "object" }, "Listing": { + "description": "A localized store listing. The resource for ListingsService.", "id": "Listing", "properties": { "fullDescription": { - "description": "Full description of the app; this may be up to 4000 characters in length.", + "description": "Full description of the app.", "type": "string" }, "language": { - "description": "Language localization code (for example, \"de-AT\" for Austrian German).", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).", "type": "string" }, "shortDescription": { - "description": "Short description of the app (previously known as promo text); this may be up to 80 characters in length.", + "description": "Short description of the app.", "type": "string" }, "title": { - "description": "App's localized title.", + "description": "Localized title of the app.", "type": "string" }, "video": { @@ -3221,14 +3080,15 @@ "type": "object" }, "ListingsListResponse": { + "description": "Response listing all localized listings.", "id": "ListingsListResponse", "properties": { "kind": { - "default": "androidpublisher#listingsListResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#listingsListResponse\".", + "description": "The kind of this response (\"androidpublisher#listingsListResponse\").", "type": "string" }, "listings": { + "description": "All localized listings.", "items": { "$ref": "Listing" }, @@ -3238,45 +3098,36 @@ "type": "object" }, "LocalizedText": { + "description": "Release notes specification, i.e. language and text.", "id": "LocalizedText", "properties": { "language": { - "description": "The language code, in BCP 47 format (eg \"en-US\").", + "description": "Language localization code (a BCP-47 language tag; for example, \"de-AT\"\nfor Austrian German).", "type": "string" }, "text": { - "description": "The text in the given `language`.", - "type": "string" - } - }, - "type": "object" - }, - "ModRange": { - "id": "ModRange", - "properties": { - "end": { - "format": "int64", - "type": "string" - }, - "start": { - "format": "int64", + "description": "The text in the given language.", "type": "string" } }, "type": "object" }, "PageInfo": { + "description": "Information about the current page.\n\nList operations that supports paging return only one \"page\" of results. This\nprotocol buffer message describes the page that has been returned.", "id": "PageInfo", "properties": { "resultPerPage": { + "description": "Maximum number of results returned in one page.\n! The number of results included in the API response.", "format": "int32", "type": "integer" }, "startIndex": { + "description": "Index of the first result returned in the current page.", "format": "int32", "type": "integer" }, "totalResults": { + "description": "Total number of results available on the backend\n! The total number of results in the result set.", "format": "int32", "type": "integer" } @@ -3284,40 +3135,48 @@ "type": "object" }, "Price": { + "description": "Definition of a price, i.e. currency and units.", "id": "Price", "properties": { "currency": { - "description": "3 letter Currency code, as defined by ISO 4217.", + "description": "3 letter Currency code, as defined by ISO 4217.\nSee java/com/google/common/money/CurrencyCode.java", "type": "string" }, "priceMicros": { - "description": "The price in millionths of the currency base unit represented as a string.", + "description": "Price in 1/million of the currency base unit, represented as a string.", "type": "string" } }, "type": "object" }, "ProductPurchase": { - "description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.", + "description": "A ProductPurchase resource indicates the status of a user's inapp\nproduct purchase.", "id": "ProductPurchase", "properties": { "acknowledgementState": { - "description": "The acknowledgement state of the inapp product. Possible values are: \n- Yet to be acknowledged \n- Acknowledged", + "description": "The acknowledgement state of the inapp product. Possible values are:\n0. Yet to be acknowledged\n1. Acknowledged", "format": "int32", "type": "integer" }, "consumptionState": { - "description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed", + "description": "The consumption state of the inapp product. Possible values are:\n0. Yet to be consumed\n1. Consumed", "format": "int32", "type": "integer" }, "developerPayload": { - "description": "A developer-specified string that contains supplemental information about an order.", + "description": "A developer-specified string that contains supplemental\ninformation about an order.", "type": "string" }, "kind": { - "default": "androidpublisher#productPurchase", - "description": "This kind represents an inappPurchase object in the androidpublisher service.", + "description": "This kind represents an inappPurchase object in the androidpublisher\nservice.", + "type": "string" + }, + "obfuscatedExternalAccountId": { + "description": "An obfuscated version of the id that is uniquely associated with the\nuser's account in your app. Only present if specified using\nhttps://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid\nwhen the purchase was made.", + "type": "string" + }, + "obfuscatedExternalProfileId": { + "description": "An obfuscated version of the id that is uniquely associated with the\nuser's profile in your app. Only present if specified using\nhttps://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid\nwhen the purchase was made.", "type": "string" }, "orderId": { @@ -3329,12 +3188,12 @@ "type": "string" }, "purchaseState": { - "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled \n- Pending", + "description": "The purchase state of the order. Possible values are:\n0. Purchased\n1. Canceled\n2. Pending", "format": "int32", "type": "integer" }, "purchaseTimeMillis": { - "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).", + "description": "The time the product was purchased, in milliseconds since the\nepoch (Jan 1, 1970).", "format": "int64", "type": "string" }, @@ -3343,7 +3202,7 @@ "type": "string" }, "purchaseType": { - "description": "The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code) \n- Rewarded (i.e. from watching a video ad instead of paying)", + "description": "The type of purchase of the inapp product. This field is only set if\nthis purchase was not made using the standard in-app billing flow.\nPossible values are:\n0. Test (i.e. purchased from a license testing account)\n1. Promo (i.e. purchased using a promo code)\n2. Rewarded (i.e. from watching a video ad instead of paying)", "format": "int32", "type": "integer" }, @@ -3356,6 +3215,7 @@ "type": "object" }, "ProductPurchasesAcknowledgeRequest": { + "description": "Request for the product.purchases.acknowledge API.", "id": "ProductPurchasesAcknowledgeRequest", "properties": { "developerPayload": { @@ -3366,6 +3226,7 @@ "type": "object" }, "Review": { + "description": "An Android app review.", "id": "Review", "properties": { "authorName": { @@ -3387,6 +3248,7 @@ "type": "object" }, "ReviewReplyResult": { + "description": "The result of replying/updating a reply to review.", "id": "ReviewReplyResult", "properties": { "lastEdited": { @@ -3401,122 +3263,76 @@ "type": "object" }, "ReviewsListResponse": { + "description": "Response listing reviews.", "id": "ReviewsListResponse", "properties": { "pageInfo": { - "$ref": "PageInfo" + "$ref": "PageInfo", + "description": "Information about the current page." }, "reviews": { + "description": "List of reviews.", "items": { "$ref": "Review" }, "type": "array" }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "description": "Pagination token, to handle a number of products that is over one page." } }, "type": "object" }, "ReviewsReplyRequest": { + "description": "Request to reply to review or update existing reply.", "id": "ReviewsReplyRequest", "properties": { "replyText": { - "description": "The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.", + "description": "The text to set as the reply. Replies of more than approximately 350\ncharacters will be rejected. HTML tags will be stripped.", "type": "string" } }, "type": "object" }, "ReviewsReplyResponse": { + "description": "Response on status of replying to a review.", "id": "ReviewsReplyResponse", "properties": { "result": { - "$ref": "ReviewReplyResult" - } - }, - "type": "object" - }, - "Sampling": { - "id": "Sampling", - "properties": { - "modRanges": { - "items": { - "$ref": "ModRange" - }, - "type": "array" - }, - "modulus": { - "format": "int64", - "type": "string" - }, - "salt": { - "format": "int32", - "type": "integer" - }, - "stratifiedSamplings": { - "items": { - "$ref": "StratifiedSampling" - }, - "type": "array" - }, - "useAndroidId": { - "type": "boolean" - } - }, - "type": "object" - }, - "StratifiedSampling": { - "id": "StratifiedSampling", - "properties": { - "modRanges": { - "items": { - "$ref": "ModRange" - }, - "type": "array" - }, - "stratum": { - "$ref": "Stratum" - } - }, - "type": "object" - }, - "Stratum": { - "id": "Stratum", - "properties": { - "brand": { - "type": "string" + "$ref": "ReviewReplyResult", + "description": "The result of replying/updating a reply to review." } }, "type": "object" }, "SubscriptionCancelSurveyResult": { - "description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).", + "description": "Information provided by the user when they complete the subscription\ncancellation flow (cancellation reason survey).", "id": "SubscriptionCancelSurveyResult", "properties": { "cancelSurveyReason": { - "description": "The cancellation reason the user chose in the survey. Possible values are: \n- Other \n- I don't use this service enough \n- Technical issues \n- Cost-related reasons \n- I found a better app", + "description": "The cancellation reason the user chose in the survey.\nPossible values are:\n0. Other\n1. I don't use this service enough\n2. Technical issues\n3. Cost-related reasons\n4. I found a better app", "format": "int32", "type": "integer" }, "userInputCancelReason": { - "description": "The customized input cancel reason from the user. Only present when cancelReason is 0.", + "description": "The customized input cancel reason from the user. Only present when\ncancelReason is 0.", "type": "string" } }, "type": "object" }, "SubscriptionDeferralInfo": { - "description": "A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.", + "description": "A SubscriptionDeferralInfo contains the data needed to defer a\nsubscription purchase to a future expiry time.", "id": "SubscriptionDeferralInfo", "properties": { "desiredExpiryTimeMillis": { - "description": "The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription.", + "description": "The desired next expiry time to assign to the subscription, in\nmilliseconds since the Epoch. The given time must be later/greater\nthan the current expiry time for the subscription.", "format": "int64", "type": "string" }, "expectedExpiryTimeMillis": { - "description": "The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur.", + "description": "The expected expiry time for the subscription. If the current\nexpiry time for the subscription is not the value specified\nhere, the deferral will not occur.", "format": "int64", "type": "string" } @@ -3524,15 +3340,15 @@ "type": "object" }, "SubscriptionPriceChange": { - "description": "Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion.", + "description": "Contains the price change information for a subscription that can be used to\ncontrol the user journey for the price change in the app. This can be in the\nform of seeking confirmation from the user or tailoring the experience for a\nsuccessful conversion.", "id": "SubscriptionPriceChange", "properties": { "newPrice": { "$ref": "Price", - "description": "The new price the subscription will renew with if the price change is accepted by the user." + "description": "The new price the subscription will renew with if the price change is\naccepted by the user." }, "state": { - "description": "The current state of the price change. Possible values are: \n- Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. \n- Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next.", + "description": "The current state of the price change. Possible values are:\n0. Outstanding: State for a pending price change waiting for the user to\n agree. In this state, you can optionally seek confirmation from the\n user using the In-App API.\n1. Accepted: State for an accepted price change that the subscription\n will renew with unless it's canceled. The price change takes effect on\n a future date when the subscription renews. Note that the change might\n not occur when the subscription is renewed next.", "format": "int32", "type": "integer" } @@ -3540,125 +3356,132 @@ "type": "object" }, "SubscriptionPurchase": { - "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.", + "description": "A SubscriptionPurchase resource indicates the status of a user's\nsubscription purchase.", "id": "SubscriptionPurchase", "properties": { "acknowledgementState": { - "description": "The acknowledgement state of the subscription product. Possible values are: \n- Yet to be acknowledged \n- Acknowledged", + "description": "The acknowledgement state of the subscription product. Possible values\nare:\n0. Yet to be acknowledged\n1. Acknowledged", "format": "int32", "type": "integer" }, "autoRenewing": { - "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.", + "description": "Whether the subscription will automatically be renewed when it\nreaches its current expiry time.", "type": "boolean" }, "autoResumeTimeMillis": { - "description": "Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription.", + "description": "Time at which the subscription will be automatically resumed, in\nmilliseconds since the Epoch. Only present if the user has requested to\npause the subscription.", "format": "int64", "type": "string" }, "cancelReason": { - "description": "The reason why a subscription was canceled or is not auto-renewing. Possible values are: \n- User canceled the subscription \n- Subscription was canceled by the system, for example because of a billing problem \n- Subscription was replaced with a new subscription \n- Subscription was canceled by the developer", + "description": "The reason why a subscription was canceled or is not auto-renewing.\nPossible values are:\n0. User canceled the subscription\n1. Subscription was canceled by the system,\n for example because of a billing problem\n2. Subscription was replaced with a new subscription\n3. Subscription was canceled by the developer", "format": "int32", "type": "integer" }, "cancelSurveyResult": { "$ref": "SubscriptionCancelSurveyResult", - "description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey)." + "description": "Information provided by the user when they complete the subscription\ncancellation flow (cancellation reason survey)." }, "countryCode": { - "description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.", + "description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time\nthe subscription was granted.", "type": "string" }, "developerPayload": { - "description": "A developer-specified string that contains supplemental information about an order.", + "description": "A developer-specified string that contains supplemental\ninformation about an order.", "type": "string" }, "emailAddress": { - "description": "The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", + "description": "The email address of the user when the subscription was purchased.\nOnly present for purchases made with 'Subscribe with Google'.", "type": "string" }, "expiryTimeMillis": { - "description": "Time at which the subscription will expire, in milliseconds since the Epoch.", + "description": "Time at which the subscription will expire, in milliseconds\nsince the Epoch.", "format": "int64", "type": "string" }, "externalAccountId": { - "description": "User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow.", + "description": "User account identifier in the third-party service.\nOnly present if account linking happened as part of the subscription\npurchase flow.", "type": "string" }, "familyName": { - "description": "The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", + "description": "The family name of the user when the subscription was purchased.\nOnly present for purchases made with 'Subscribe with Google'.", "type": "string" }, "givenName": { - "description": "The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", + "description": "The given name of the user when the subscription was purchased.\nOnly present for purchases made with 'Subscribe with Google'.", "type": "string" }, "introductoryPriceInfo": { "$ref": "IntroductoryPriceInfo", - "description": "Introductory price information of the subscription. This is only present when the subscription was purchased with an introductory price.\n\nThis field does not indicate the subscription is currently in introductory price period." + "description": "Introductory price information of the subscription. This is only present\nwhen the subscription was purchased with an introductory price.\n\nThis field does not indicate the subscription is currently in introductory\nprice period." }, "kind": { - "default": "androidpublisher#subscriptionPurchase", - "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.", + "description": "This kind represents a subscriptionPurchase object in the androidpublisher\nservice.", "type": "string" }, "linkedPurchaseToken": { - "description": "The purchase token of the originating purchase if this subscription is one of the following: \n- Re-signup of a canceled but non-lapsed subscription \n- Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.", + "description": "The purchase token of the originating purchase if this subscription\nis one of the following:\n0. Re-signup of a canceled but non-lapsed subscription\n1. Upgrade/downgrade from a previous subscription\n\nFor example, suppose a user originally signs up and you receive\npurchase token X, then the user cancels and goes through the\nresignup flow (before their subscription lapses) and you receive\npurchase token Y, and finally the user upgrades their subscription\nand you receive purchase token Z. If you call this API with purchase\ntoken Z, this field will be set to Y. If you call this API with\npurchase token Y, this field will be set to X. If you call this API\nwith purchase token X, this field will not be set.", + "type": "string" + }, + "obfuscatedExternalAccountId": { + "description": "An obfuscated version of the id that is uniquely associated with the\nuser's account in your app. Present for the following purchases:\n * If account linking happened as part of the subscription purchase flow.\n * It was specified using\n https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid\n when the purchase was made.", + "type": "string" + }, + "obfuscatedExternalProfileId": { + "description": "An obfuscated version of the id that is uniquely associated with the\nuser's profile in your app. Only present if specified using\nhttps://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid\nwhen the purchase was made.", "type": "string" }, "orderId": { - "description": "The order id of the latest recurring order associated with the purchase of the subscription.", + "description": "The order id of the latest recurring order associated with\nthe purchase of the subscription.", "type": "string" }, "paymentState": { - "description": "The payment state of the subscription. Possible values are: \n- Payment pending \n- Payment received \n- Free trial \n- Pending deferred upgrade/downgrade", + "description": "The payment state of the subscription. Possible values are:\n0. Payment pending\n1. Payment received\n2. Free trial\n3. Pending deferred upgrade/downgrade", "format": "int32", "type": "integer" }, "priceAmountMicros": { - "description": "Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.", + "description": "Price of the subscription, not including tax. Price is expressed\nin micro-units, where 1,000,000 micro-units represents one unit of\nthe currency. For example, if the subscription price is €1.99,\nprice_amount_micros is 1990000.", "format": "int64", "type": "string" }, "priceChange": { "$ref": "SubscriptionPriceChange", - "description": "The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied.\n\nOnce the subscription renews with the new price or the subscription is canceled, no price change information will be returned." + "description": "The latest price change information available. This is present only when\nthere is an upcoming price change for the subscription yet to be applied.\n\nOnce the subscription renews with the new price or the subscription is\ncanceled, no price change information will be returned." }, "priceCurrencyCode": { - "description": "ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\".", + "description": "ISO 4217 currency code for the subscription price. For example,\nif the price is specified in British pounds sterling,\nprice_currency_code is \"GBP\".", "type": "string" }, "profileId": { - "description": "The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", + "description": "The Google profile id of the user when the subscription was purchased.\nOnly present for purchases made with 'Subscribe with Google'.", "type": "string" }, "profileName": { - "description": "The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", + "description": "The profile name of the user when the subscription was purchased.\nOnly present for purchases made with 'Subscribe with Google'.", "type": "string" }, "promotionCode": { - "description": "The promotion code applied on this purchase. This field is only set if a vanity code promotion is applied when the subscription was purchased.", + "description": "The promotion code applied on this purchase. This field is only set if\na vanity code promotion is applied when the subscription was purchased.", "type": "string" }, "promotionType": { - "description": "The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: \n- One time code \n- Vanity code", + "description": "The type of promotion applied on this purchase. This field is only set if\na promotion is applied when the subscription was purchased. Possible\nvalues are:\n0. One time code\n1. Vanity code", "format": "int32", "type": "integer" }, "purchaseType": { - "description": "The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code)", + "description": "The type of purchase of the subscription. This field is only set if\nthis purchase was not made using the standard in-app billing flow.\nPossible values are:\n0. Test (i.e. purchased from a license testing account)\n1. Promo (i.e. purchased using a promo code)", "format": "int32", "type": "integer" }, "startTimeMillis": { - "description": "Time at which the subscription was granted, in milliseconds since the Epoch.", + "description": "Time at which the subscription was granted, in milliseconds\nsince the Epoch.", "format": "int64", "type": "string" }, "userCancellationTimeMillis": { - "description": "The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.", + "description": "The time at which the subscription was canceled by the user, in\nmilliseconds since the epoch. Only present if cancelReason is 0.", "format": "int64", "type": "string" } @@ -3666,6 +3489,7 @@ "type": "object" }, "SubscriptionPurchasesAcknowledgeRequest": { + "description": "Request for the purchases.subscriptions.acknowledge API.", "id": "SubscriptionPurchasesAcknowledgeRequest", "properties": { "developerPayload": { @@ -3676,6 +3500,7 @@ "type": "object" }, "SubscriptionPurchasesDeferRequest": { + "description": "Request for the purchases.subscriptions.defer API.", "id": "SubscriptionPurchasesDeferRequest", "properties": { "deferralInfo": { @@ -3686,6 +3511,7 @@ "type": "object" }, "SubscriptionPurchasesDeferResponse": { + "description": "Response for the purchases.subscriptions.defer API.", "id": "SubscriptionPurchasesDeferResponse", "properties": { "newExpiryTimeMillis": { @@ -3696,50 +3522,12 @@ }, "type": "object" }, - "SystemApkVariantsCreateRequest": { - "id": "SystemApkVariantsCreateRequest", - "properties": { - "deviceSpec": { - "$ref": "DeviceSpec" - } - }, - "type": "object" - }, - "SystemApkVariantsListResponse": { - "id": "SystemApkVariantsListResponse", - "properties": { - "variants": { - "items": { - "$ref": "Variant" - }, - "type": "array" - } - }, - "type": "object" - }, "Testers": { + "description": "The testers of an app. The resource for TestersService.", "id": "Testers", "properties": { - "autoEnrolledAndroidGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "autoEnrolledGoogleGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "excludedGoogleGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, "googleGroups": { - "description": "A list of all Google Groups, as email addresses, that define testers for this track.", + "description": "All testing Google Groups, as email addresses.", "items": { "type": "string" }, @@ -3749,13 +3537,16 @@ "type": "object" }, "Timestamp": { + "description": "A Timestamp represents a point in time independent of any time zone or local\ncalendar, encoded as a count of seconds and fractions of seconds at\nnanosecond resolution. The count is relative to an epoch at UTC midnight on\nJanuary 1, 1970.", "id": "Timestamp", "properties": { "nanos": { + "description": "Non-negative fractions of a second at nanosecond resolution.\nMust be from 0 to 999,999,999 inclusive.", "format": "int32", "type": "integer" }, "seconds": { + "description": "Represents seconds of UTC time since Unix epoch.", "format": "int64", "type": "string" } @@ -3763,9 +3554,11 @@ "type": "object" }, "TokenPagination": { + "description": "Pagination information returned by a List operation when token pagination\nis enabled.\n\nList operations that supports paging return only one \"page\" of results. This\nprotocol buffer message describes the page that has been returned.\n\nWhen using token pagination, clients should use the next/previous token\nto get another page of the result. The presence or absence of next/previous\ntoken indicates whether a next/previous page is available and provides a\nmean of accessing this page. ListRequest.page_token should be set to either\nnext_page_token or previous_page_token to access another page.", "id": "TokenPagination", "properties": { "nextPageToken": { + "description": "Tokens to pass to the standard list field 'page_token'. Whenever available,\ntokens are preferred over manipulating start_index.", "type": "string" }, "previousPageToken": { @@ -3775,157 +3568,91 @@ "type": "object" }, "Track": { + "description": "A track configuration. The resource for TracksService.", "id": "Track", "properties": { "releases": { - "description": "A list of all active releases in this track during a read request. On an update request, it represents desired changes.", + "description": "In a read request, represents all active releases in the track.\nIn an update request, represents desired changes.", "items": { "$ref": "TrackRelease" }, "type": "array" }, "track": { - "description": "Identifier for this track.", + "description": "Identifier of the track.", "type": "string" } }, "type": "object" }, "TrackRelease": { + "description": "A release within a track.", "id": "TrackRelease", "properties": { - "controls": { - "items": { - "$ref": "Control" - }, - "type": "array" - }, "countryTargeting": { - "$ref": "CountryTargeting" + "$ref": "CountryTargeting", + "description": "Restricts a release to a specific set of countries." }, "inAppUpdatePriority": { - "description": "In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates.", + "description": "In-app update priority of the release. All newly added APKs in the\nrelease will be considered at this priority. Can take values in the range\n[0, 5], with 5 the highest priority. Defaults to 0.\nin_app_update_priority can not be updated once the release is rolled out.\nSee https://developer.android.com/guide/playcore/in-app-updates.", "format": "int32", "type": "integer" }, "name": { - "description": "The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs.", + "description": "The release name. Not required to be unique. If not set, the name is\ngenerated from the APK's version_name. If the release contains multiple\nAPKs, the name is generated from the date.", "type": "string" }, - "pinnedVersions": { - "items": { - "$ref": "TrackReleasePin" - }, - "type": "array" - }, "releaseNotes": { - "description": "The description of what is new in the app in this release.", + "description": "A description of what is new in this release.", "items": { "$ref": "LocalizedText" }, "type": "array" }, - "rollbackEnabled": { - "type": "boolean" - }, - "sampling": { - "$ref": "Sampling" - }, "status": { - "description": "The desired status of this release.", + "description": "The status of the release.", + "enum": [ + "statusUnspecified", + "draft", + "inProgress", + "halted", + "completed" + ], + "enumDescriptions": [ + "Unspecified status.", + "The release's APKs are not being served to users.", + "The release's APKs are being served to a fraction of users, determined by\n'user_fraction'.", + "The release's APKs will no longer be served to users. Users who already\nhave these APKs are unaffected.", + "The release will have no further changes. Its APKs are being served to\nall users, unless they are eligible to APKs of a more recent release." + ], "type": "string" }, "userFraction": { - "description": "Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be \"inProgress\" or \"halted\".", + "description": "Fraction of users who are eligible for a staged release. 0 < fraction < 1.\nCan only be set when status is \"inProgress\" or \"halted\".", "format": "double", "type": "number" }, "versionCodes": { - "description": "A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases.", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "TrackReleasePin": { - "id": "TrackReleasePin", - "properties": { - "targetings": { - "items": { - "$ref": "TrackReleasePinPinTargeting" - }, - "type": "array" - }, - "versionCodes": { - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "TrackReleasePinPinTargeting": { - "id": "TrackReleasePinPinTargeting", - "properties": { - "countryCodes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "devices": { - "items": { - "$ref": "TrackReleasePinPinTargetingDevicePin" - }, - "type": "array" - }, - "phoneskyVersions": { + "description": "Version codes of all APKs in the release. Must include version codes to\nretain from previous releases.", "items": { "format": "int64", "type": "string" }, "type": "array" - }, - "sdkVersions": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - } - }, - "type": "object" - }, - "TrackReleasePinPinTargetingDevicePin": { - "id": "TrackReleasePinPinTargetingDevicePin", - "properties": { - "brand": { - "type": "string" - }, - "device": { - "type": "string" - }, - "product": { - "type": "string" } }, "type": "object" }, "TracksListResponse": { + "description": "Response listing all tracks.", "id": "TracksListResponse", "properties": { "kind": { - "default": "androidpublisher#tracksListResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#tracksListResponse\".", + "description": "The kind of this response (\"androidpublisher#tracksListResponse\").", "type": "string" }, "tracks": { + "description": "All tracks.", "items": { "$ref": "Track" }, @@ -3935,20 +3662,21 @@ "type": "object" }, "UserComment": { + "description": "User entry from conversation between user and developer.", "id": "UserComment", "properties": { "androidOsVersion": { - "description": "Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.", + "description": "Integer Android SDK version of the user's device at the time the\nreview was written, e.g. 23 is Marshmallow. May be absent.", "format": "int32", "type": "integer" }, "appVersionCode": { - "description": "Integer version code of the app as installed at the time the review was written. May be absent.", + "description": "Integer version code of the app as installed at the time the\nreview was written. May be absent.", "format": "int32", "type": "integer" }, "appVersionName": { - "description": "String version name of the app as installed at the time the review was written. May be absent.", + "description": "String version name of the app as installed at the time the\nreview was written. May be absent.", "type": "string" }, "device": { @@ -3957,18 +3685,18 @@ }, "deviceMetadata": { "$ref": "DeviceMetadata", - "description": "Some information about the characteristics of the user's device" + "description": "Information about the characteristics of the user's device." }, "lastModified": { "$ref": "Timestamp", "description": "The last time at which this comment was updated." }, "originalText": { - "description": "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.", + "description": "Untranslated text of the review, where the review was translated.\nIf the review was not translated this is left blank.", "type": "string" }, "reviewerLanguage": { - "description": "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.", + "description": "Language code for the reviewer. This is taken from the device\nsettings so is not guaranteed to match the language the review\nis written in. May be absent.", "type": "string" }, "starRating": { @@ -3977,70 +3705,71 @@ "type": "integer" }, "text": { - "description": "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.", + "description": "The content of the comment, i.e. review body. In some cases\nusers have been able to write a review with separate title and\nbody; in those cases the title and body are concatenated and\nseparated by a tab character.", "type": "string" }, "thumbsDownCount": { - "description": "Number of users who have given this review a thumbs down", + "description": "Number of users who have given this review a thumbs down.", "format": "int32", "type": "integer" }, "thumbsUpCount": { - "description": "Number of users who have given this review a thumbs up", + "description": "Number of users who have given this review a thumbs up.", "format": "int32", "type": "integer" } }, "type": "object" }, - "Variant": { - "description": "Represents the variant of a generated system APK from an uploaded App Bundle.", - "id": "Variant", + "UsesPermission": { + "description": "A permission used by this APK.", + "id": "UsesPermission", "properties": { - "deviceSpec": { - "$ref": "DeviceSpec" - }, - "variantId": { - "format": "uint32", + "maxSdkVersion": { + "description": "Optionally, the maximum SDK version for which the permission is\nrequired.", + "format": "int32", "type": "integer" + }, + "name": { + "description": "The name of the permission requested.", + "type": "string" } }, "type": "object" }, "VoidedPurchase": { - "description": "A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.", + "description": "A VoidedPurchase resource indicates a purchase that was either\ncanceled/refunded/charged-back.", "id": "VoidedPurchase", "properties": { "kind": { - "default": "androidpublisher#voidedPurchase", - "description": "This kind represents a voided purchase object in the androidpublisher service.", + "description": "This kind represents a voided purchase object in the androidpublisher\nservice.", "type": "string" }, "orderId": { - "description": "The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.", + "description": "The order id which uniquely identifies a one-time purchase, subscription\npurchase, or subscription renewal.", "type": "string" }, "purchaseTimeMillis": { - "description": "The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).", + "description": "The time at which the purchase was made, in milliseconds since the\nepoch (Jan 1, 1970).", "format": "int64", "type": "string" }, "purchaseToken": { - "description": "The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API).", + "description": "The token which uniquely identifies a one-time purchase or subscription.\nTo uniquely identify subscription renewals use order_id (available\nstarting from version 3 of the API).", "type": "string" }, "voidedReason": { - "description": "The reason why the purchase was voided, possible values are: \n- Other \n- Remorse \n- Not_received \n- Defective \n- Accidental_purchase \n- Fraud \n- Friendly_fraud \n- Chargeback", + "description": "The reason why the purchase was voided, possible values are:\n0. Other\n1. Remorse\n2. Not_received\n3. Defective\n4. Accidental_purchase\n5. Fraud\n6. Friendly_fraud\n7. Chargeback", "format": "int32", "type": "integer" }, "voidedSource": { - "description": "The initiator of voided purchase, possible values are: \n- User \n- Developer \n- Google", + "description": "The initiator of voided purchase, possible values are:\n0. User\n1. Developer\n2. Google", "format": "int32", "type": "integer" }, "voidedTimeMillis": { - "description": "The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).", + "description": "The time at which the purchase was canceled/refunded/charged-back,\nin milliseconds since the epoch (Jan 1, 1970).", "format": "int64", "type": "string" } @@ -4048,13 +3777,16 @@ "type": "object" }, "VoidedPurchasesListResponse": { + "description": "Response for the voidedpurchases.list API.", "id": "VoidedPurchasesListResponse", "properties": { "pageInfo": { - "$ref": "PageInfo" + "$ref": "PageInfo", + "description": "General pagination information." }, "tokenPagination": { - "$ref": "TokenPagination" + "$ref": "TokenPagination", + "description": "Pagination information for token pagination." }, "voidedPurchases": { "items": { @@ -4066,7 +3798,7 @@ "type": "object" } }, - "servicePath": "androidpublisher/v3/applications/", - "title": "Google Play Developer API", + "servicePath": "", + "title": "Google Play Android Developer API", "version": "v3" } \ No newline at end of file diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index b360c4f3ac..13a69cdb82 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -53,9 +53,21 @@ export namespace androidpublisher_v3 { | GoogleAuth; /** - * Data format for the response. + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. */ alt?: string; + /** + * JSONP + */ + callback?: string; /** * Selector specifying which fields to include in a partial response. */ @@ -73,19 +85,23 @@ export namespace androidpublisher_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** - * Google Play Developer API + * Google Play Android Developer API * - * Accesses Android application developers' Google Play accounts. + * Lets Android application developers access their Google Play accounts. * * @example * const {google} = require('googleapis'); @@ -105,7 +121,6 @@ export namespace androidpublisher_v3 { orders: Resource$Orders; purchases: Resource$Purchases; reviews: Resource$Reviews; - systemapks: Resource$Systemapks; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -121,18 +136,19 @@ export namespace androidpublisher_v3 { this.orders = new Resource$Orders(this.context); this.purchases = new Resource$Purchases(this.context); this.reviews = new Resource$Reviews(this.context); - this.systemapks = new Resource$Systemapks(this.context); } } + /** + * Information about an APK. The resource for ApksService. + */ export interface Schema$Apk { /** * Information about the binary payload of this APK. */ binary?: Schema$ApkBinary; - testBinary?: Schema$ApkBinary; /** - * The version code of the APK, as specified in the APK's manifest file. + * The version code of the APK, as specified in the manifest file. */ versionCode?: number | null; } @@ -149,25 +165,40 @@ export namespace androidpublisher_v3 { */ sha256?: string | null; } + /** + * Request to create a new externally hosted APK. + */ export interface Schema$ApksAddExternallyHostedRequest { /** * The definition of the externally-hosted APK and where it is located. */ externallyHostedApk?: Schema$ExternallyHostedApk; } + /** + * Response for creating a new externally hosted APK. + */ export interface Schema$ApksAddExternallyHostedResponse { /** * The definition of the externally-hosted APK and where it is located. */ externallyHostedApk?: Schema$ExternallyHostedApk; } + /** + * Response listing all APKs. + */ export interface Schema$ApksListResponse { + /** + * All APKs. + */ apks?: Schema$Apk[]; /** - * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse". + * The kind of this response ("androidpublisher#apksListResponse"). */ kind?: string | null; } + /** + * The app details. The resource for DetailsService. + */ export interface Schema$AppDetails { /** * The user-visible support email for this app. @@ -187,18 +218,21 @@ export namespace androidpublisher_v3 { defaultLanguage?: string | null; } /** - * Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation. + * An app edit. The resource for EditsService. */ export interface Schema$AppEdit { /** - * The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch). + * Output only. The time (as seconds since Epoch) at which the edit will expire and will be no longer valid for use. */ expiryTimeSeconds?: string | null; /** - * The ID of the edit that can be used in subsequent API calls. + * Output only. Identifier of the edit. Can be used in subsequent API calls. */ id?: string | null; } + /** + * Information about a bundle. The resource for BundlesService. + */ export interface Schema$Bundle { /** * A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command. @@ -209,17 +243,26 @@ export namespace androidpublisher_v3 { */ sha256?: string | null; /** - * The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file. + * The version code of the Android App Bundle, as specified in the Android App Bundle's base module APK manifest file. */ versionCode?: number | null; } + /** + * Response listing all bundles. + */ export interface Schema$BundlesListResponse { + /** + * All bundles. + */ bundles?: Schema$Bundle[]; /** - * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#bundlesListResponse". + * The kind of this response ("androidpublisher#bundlesListResponse"). */ kind?: string | null; } + /** + * An entry of conversation between user and developer. + */ export interface Schema$Comment { /** * A comment from a developer. @@ -230,13 +273,17 @@ export namespace androidpublisher_v3 { */ userComment?: Schema$UserComment; } - export interface Schema$Control { - modRanges?: Schema$ModRange[]; - stratifiedSamplings?: Schema$StratifiedSampling[]; - versionCodes?: string[] | null; - } + /** + * Country targeting specification. + */ export interface Schema$CountryTargeting { + /** + * Countries to target, specified as two letter [CLDR codes](https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html). + */ countries?: string[] | null; + /** + * Include "rest of world" as well as explicitly targeted countries. + */ includeRestOfWorld?: boolean | null; } /** @@ -248,9 +295,18 @@ export namespace androidpublisher_v3 { */ symbolType?: string | null; } + /** + * Responses for the upload. + */ export interface Schema$DeobfuscationFilesUploadResponse { + /** + * The uploaded Deobfuscation File configuration. + */ deobfuscationFile?: Schema$DeobfuscationFile; } + /** + * Developer entry from conversation between user and developer. + */ export interface Schema$DeveloperComment { /** * The last time at which this comment was updated. @@ -261,13 +317,16 @@ export namespace androidpublisher_v3 { */ text?: string | null; } + /** + * Characteristics of the user's device. + */ export interface Schema$DeviceMetadata { /** - * Device CPU make e.g. "Qualcomm" + * Device CPU make, e.g. "Qualcomm" */ cpuMake?: string | null; /** - * Device CPU model e.g. "MSM8974" + * Device CPU model, e.g. "MSM8974" */ cpuModel?: string | null; /** @@ -291,7 +350,7 @@ export namespace androidpublisher_v3 { */ productName?: string | null; /** - * Device RAM in Megabytes e.g. "2048" + * Device RAM in Megabytes, e.g. "2048" */ ramMb?: number | null; /** @@ -307,26 +366,30 @@ export namespace androidpublisher_v3 { */ screenWidthPx?: number | null; } - export interface Schema$DeviceSpec { - screenDensity?: number | null; - supportedAbis?: string[] | null; - supportedLocales?: string[] | null; - } + /** + * An expansion file. The resource for ExpansionFilesService. + */ export interface Schema$ExpansionFile { /** - * If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes. + * If set, this field indicates that this APK has an expansion file uploaded to it: this APK does not reference another APK's expansion file. The field's value is the size of the uploaded expansion file in bytes. */ fileSize?: string | null; /** - * If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set. + * If set, this APK's expansion file references another APK's expansion file. The file_size field will not be set. */ referencesVersion?: number | null; } + /** + * Response for uploading an expansion file. + */ export interface Schema$ExpansionFilesUploadResponse { + /** + * The uploaded expansion file configuration. + */ expansionFile?: Schema$ExpansionFile; } /** - * Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel + * Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to organizations using Managed Play whose application is configured to restrict distribution to the organizations. */ export interface Schema$ExternallyHostedApk { /** @@ -334,7 +397,7 @@ export namespace androidpublisher_v3 { */ applicationLabel?: string | null; /** - * A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array. + * A certificate (or array of certificates if a certificate-chain is used) used to sign this APK, represented as a base64 encoded byte array. */ certificateBase64s?: string[] | null; /** @@ -342,11 +405,11 @@ export namespace androidpublisher_v3 { */ externallyHostedUrl?: string | null; /** - * The SHA1 checksum of this APK, represented as a base64 encoded byte array. + * The sha1 checksum of this APK, represented as a base64 encoded byte array. */ fileSha1Base64?: string | null; /** - * The SHA256 checksum of this APK, represented as a base64 encoded byte array. + * The sha256 checksum of this APK, represented as a base64 encoded byte array. */ fileSha256Base64?: string | null; /** @@ -380,7 +443,7 @@ export namespace androidpublisher_v3 { /** * The permissions requested by this APK. */ - usesPermissions?: Schema$ExternallyHostedApkUsesPermission[]; + usesPermissions?: Schema$UsesPermission[]; /** * The version code of this APK. */ @@ -391,29 +454,19 @@ export namespace androidpublisher_v3 { versionName?: string | null; } /** - * A permission used by this APK. + * An uploaded image. The resource for ImagesService. */ - export interface Schema$ExternallyHostedApkUsesPermission { - /** - * Optionally, the maximum SDK version for which the permission is required. - */ - maxSdkVersion?: number | null; - /** - * The name of the permission requested. - */ - name?: string | null; - } export interface Schema$Image { /** * A unique id representing this image. */ id?: string | null; /** - * A sha1 hash of the image that was uploaded. + * A sha1 hash of the image. */ sha1?: string | null; /** - * A sha256 hash of the image that was uploaded. + * A sha256 hash of the image. */ sha256?: string | null; /** @@ -421,83 +474,118 @@ export namespace androidpublisher_v3 { */ url?: string | null; } + /** + * Response for deleting all images. + */ export interface Schema$ImagesDeleteAllResponse { + /** + * The deleted images. + */ deleted?: Schema$Image[]; } + /** + * Response listing all images. + */ export interface Schema$ImagesListResponse { + /** + * All listed Images. + */ images?: Schema$Image[]; } + /** + * Response for uploading an image. + */ export interface Schema$ImagesUploadResponse { + /** + * The uploaded image. + */ image?: Schema$Image; } + /** + * An in-app product. The resource for InappproductsService. + */ export interface Schema$InAppProduct { /** - * The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". + * Default language of the localized data, as defined by BCP-47. e.g. "en-US". */ defaultLanguage?: string | null; /** - * Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. + * Default price. Cannot be zero, as in-app products are never free. Always in the developer's Checkout merchant currency. */ defaultPrice?: Schema$Price; /** - * Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days), "P7D" (seven days), "P14D" (fourteen days), and "P30D" (thirty days) + * Grace period of the subscription, specified in ISO 8601 format. Allows developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values are P0D (zero days), P3D (three days), P7D (seven days), P14D (14 days), and P30D (30 days). */ gracePeriod?: string | null; /** - * List of localized title and description data. + * List of localized title and description data. Map key is the language of the localized data, as defined by BCP-47, e.g. "en-US". */ listings?: {[key: string]: Schema$InAppProductListing} | null; /** - * The package name of the parent app. + * Package name of the parent app. */ packageName?: string | null; /** - * Prices per buyer region. None of these prices should be zero. In-app products can never be free. + * Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. */ prices?: {[key: string]: Schema$Price} | null; /** - * Purchase type enum value. Unmodifiable after creation. + * The type of the product, e.g. a recurring subscription. */ purchaseType?: string | null; /** - * Whether or not the developer wants the specific subscription to be resubscribable. If the developer doesn't use PBL2.0, this value is ignored since the feature is only for developers using PBL2.0. This feature allows users to resubscribe to an expired subscription directly from the subscription center by clicking on a "Resubscribe" CTA under the entry for the expired subscription. + * Stock-keeping-unit (SKU) of the product, unique within an app. */ - resubscribeEligibility?: string | null; + sku?: string | null; /** - * The stock-keeping-unit (SKU) of the product, unique within an app. + * The status of the product, e.g. whether it's active. */ - sku?: string | null; status?: string | null; /** - * Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). + * Subscription period, specified in ISO 8601 format. Acceptable values are P1W (one week), P1M (one month), P3M (three months), P6M (six months), and P1Y (one year). */ subscriptionPeriod?: string | null; /** - * Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. + * Trial period, specified in ISO 8601 format. Acceptable values are anything between P7D (seven days) and P999D (999 days). */ trialPeriod?: string | null; } + /** + * Store listing of a single in-app product. + */ export interface Schema$InAppProductListing { /** - * The localized entitlement benefits of the in-app product. These are supported only for subscriptions. + * Localized entitlement benefits for a subscription. */ benefits?: string[] | null; /** - * The localized description of the in-app product. These are deprecated for subscriptions. + * Description for the store listing. */ description?: string | null; /** - * The localized title of the in-app product. + * Title for the store listing. */ title?: string | null; } + /** + * Response listing all in-app products. + */ export interface Schema$InappproductsListResponse { + /** + * All in-app products. + */ inappproduct?: Schema$InAppProduct[]; /** - * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse". + * The kind of this response ("androidpublisher#inappproductsListResponse"). */ kind?: string | null; + /** + * Information about the current page. + */ pageInfo?: Schema$PageInfo; + /** + * Pagination token, to handle a number of products that is over one page. + */ tokenPagination?: Schema$TokenPagination; } /** @@ -505,7 +593,7 @@ export namespace androidpublisher_v3 { */ export interface Schema$InternalAppSharingArtifact { /** - * The SHA256 fingerprint of the certificate used to signed the generated artifact. + * The sha256 fingerprint of the certificate used to sign the generated artifact. */ certificateFingerprint?: string | null; /** @@ -513,7 +601,7 @@ export namespace androidpublisher_v3 { */ downloadUrl?: string | null; /** - * The SHA-256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command. + * The sha256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command. */ sha256?: string | null; } @@ -538,21 +626,24 @@ export namespace androidpublisher_v3 { */ introductoryPricePeriod?: string | null; } + /** + * A localized store listing. The resource for ListingsService. + */ export interface Schema$Listing { /** - * Full description of the app; this may be up to 4000 characters in length. + * Full description of the app. */ fullDescription?: string | null; /** - * Language localization code (for example, "de-AT" for Austrian German). + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). */ language?: string | null; /** - * Short description of the app (previously known as promo text); this may be up to 80 characters in length. + * Short description of the app. */ shortDescription?: string | null; /** - * App's localized title. + * Localized title of the app. */ title?: string | null; /** @@ -560,39 +651,59 @@ export namespace androidpublisher_v3 { */ video?: string | null; } + /** + * Response listing all localized listings. + */ export interface Schema$ListingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse". + * The kind of this response ("androidpublisher#listingsListResponse"). */ kind?: string | null; + /** + * All localized listings. + */ listings?: Schema$Listing[]; } + /** + * Release notes specification, i.e. language and text. + */ export interface Schema$LocalizedText { /** - * The language code, in BCP 47 format (eg "en-US"). + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). */ language?: string | null; /** - * The text in the given `language`. + * The text in the given language. */ text?: string | null; } - export interface Schema$ModRange { - end?: string | null; - start?: string | null; - } + /** + * Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. + */ export interface Schema$PageInfo { + /** + * Maximum number of results returned in one page. ! The number of results included in the API response. + */ resultPerPage?: number | null; + /** + * Index of the first result returned in the current page. + */ startIndex?: number | null; + /** + * Total number of results available on the backend ! The total number of results in the result set. + */ totalResults?: number | null; } + /** + * Definition of a price, i.e. currency and units. + */ export interface Schema$Price { /** - * 3 letter Currency code, as defined by ISO 4217. + * 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java */ currency?: string | null; /** - * The price in millionths of the currency base unit represented as a string. + * Price in 1/million of the currency base unit, represented as a string. */ priceMicros?: string | null; } @@ -601,11 +712,11 @@ export namespace androidpublisher_v3 { */ export interface Schema$ProductPurchase { /** - * The acknowledgement state of the inapp product. Possible values are: - Yet to be acknowledged - Acknowledged + * The acknowledgement state of the inapp product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged */ acknowledgementState?: number | null; /** - * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed + * The consumption state of the inapp product. Possible values are: 0. Yet to be consumed 1. Consumed */ consumptionState?: number | null; /** @@ -616,6 +727,14 @@ export namespace androidpublisher_v3 { * This kind represents an inappPurchase object in the androidpublisher service. */ kind?: string | null; + /** + * An obfuscated version of the id that is uniquely associated with the user's account in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made. + */ + obfuscatedExternalAccountId?: string | null; + /** + * An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made. + */ + obfuscatedExternalProfileId?: string | null; /** * The order id associated with the purchase of the inapp product. */ @@ -625,7 +744,7 @@ export namespace androidpublisher_v3 { */ productId?: string | null; /** - * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending + * The purchase state of the order. Possible values are: 0. Purchased 1. Canceled 2. Pending */ purchaseState?: number | null; /** @@ -637,7 +756,7 @@ export namespace androidpublisher_v3 { */ purchaseToken?: string | null; /** - * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) + * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code) 2. Rewarded (i.e. from watching a video ad instead of paying) */ purchaseType?: number | null; /** @@ -645,12 +764,18 @@ export namespace androidpublisher_v3 { */ quantity?: number | null; } + /** + * Request for the product.purchases.acknowledge API. + */ export interface Schema$ProductPurchasesAcknowledgeRequest { /** * Payload to attach to the purchase. */ developerPayload?: string | null; } + /** + * An Android app review. + */ export interface Schema$Review { /** * The name of the user who wrote the review. @@ -665,6 +790,9 @@ export namespace androidpublisher_v3 { */ reviewId?: string | null; } + /** + * The result of replying/updating a reply to review. + */ export interface Schema$ReviewReplyResult { /** * The time at which the reply took effect. @@ -675,40 +803,47 @@ export namespace androidpublisher_v3 { */ replyText?: string | null; } + /** + * Response listing reviews. + */ export interface Schema$ReviewsListResponse { + /** + * Information about the current page. + */ pageInfo?: Schema$PageInfo; + /** + * List of reviews. + */ reviews?: Schema$Review[]; + /** + * Pagination token, to handle a number of products that is over one page. + */ tokenPagination?: Schema$TokenPagination; } + /** + * Request to reply to review or update existing reply. + */ export interface Schema$ReviewsReplyRequest { /** * The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped. */ replyText?: string | null; } + /** + * Response on status of replying to a review. + */ export interface Schema$ReviewsReplyResponse { + /** + * The result of replying/updating a reply to review. + */ result?: Schema$ReviewReplyResult; } - export interface Schema$Sampling { - modRanges?: Schema$ModRange[]; - modulus?: string | null; - salt?: number | null; - stratifiedSamplings?: Schema$StratifiedSampling[]; - useAndroidId?: boolean | null; - } - export interface Schema$StratifiedSampling { - modRanges?: Schema$ModRange[]; - stratum?: Schema$Stratum; - } - export interface Schema$Stratum { - brand?: string | null; - } /** * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ export interface Schema$SubscriptionCancelSurveyResult { /** - * The cancellation reason the user chose in the survey. Possible values are: - Other - I don't use this service enough - Technical issues - Cost-related reasons - I found a better app + * The cancellation reason the user chose in the survey. Possible values are: 0. Other 1. I don't use this service enough 2. Technical issues 3. Cost-related reasons 4. I found a better app */ cancelSurveyReason?: number | null; /** @@ -725,7 +860,7 @@ export namespace androidpublisher_v3 { */ desiredExpiryTimeMillis?: string | null; /** - * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur. + * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur. */ expectedExpiryTimeMillis?: string | null; } @@ -738,7 +873,7 @@ export namespace androidpublisher_v3 { */ newPrice?: Schema$Price; /** - * The current state of the price change. Possible values are: - Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. - Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next. + * The current state of the price change. Possible values are: 0. Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. 1. Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next. */ state?: number | null; } @@ -747,7 +882,7 @@ export namespace androidpublisher_v3 { */ export interface Schema$SubscriptionPurchase { /** - * The acknowledgement state of the subscription product. Possible values are: - Yet to be acknowledged - Acknowledged + * The acknowledgement state of the subscription product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged */ acknowledgementState?: number | null; /** @@ -759,7 +894,7 @@ export namespace androidpublisher_v3 { */ autoResumeTimeMillis?: string | null; /** - * The reason why a subscription was canceled or is not auto-renewing. Possible values are: - User canceled the subscription - Subscription was canceled by the system, for example because of a billing problem - Subscription was replaced with a new subscription - Subscription was canceled by the developer + * The reason why a subscription was canceled or is not auto-renewing. Possible values are: 0. User canceled the subscription 1. Subscription was canceled by the system, for example because of a billing problem 2. Subscription was replaced with a new subscription 3. Subscription was canceled by the developer */ cancelReason?: number | null; /** @@ -803,19 +938,27 @@ export namespace androidpublisher_v3 { */ kind?: string | null; /** - * The purchase token of the originating purchase if this subscription is one of the following: - Re-signup of a canceled but non-lapsed subscription - Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set. + * The purchase token of the originating purchase if this subscription is one of the following: 0. Re-signup of a canceled but non-lapsed subscription 1. Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set. */ linkedPurchaseToken?: string | null; + /** + * An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made. + */ + obfuscatedExternalAccountId?: string | null; + /** + * An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made. + */ + obfuscatedExternalProfileId?: string | null; /** * The order id of the latest recurring order associated with the purchase of the subscription. */ orderId?: string | null; /** - * The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade + * The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade */ paymentState?: number | null; /** - * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. + * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is &euro;1.99, price_amount_micros is 1990000. */ priceAmountMicros?: string | null; /** @@ -839,11 +982,11 @@ export namespace androidpublisher_v3 { */ promotionCode?: string | null; /** - * The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: - One time code - Vanity code + * The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: 0. One time code 1. Vanity code */ promotionType?: number | null; /** - * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) + * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code) */ purchaseType?: number | null; /** @@ -855,110 +998,127 @@ export namespace androidpublisher_v3 { */ userCancellationTimeMillis?: string | null; } + /** + * Request for the purchases.subscriptions.acknowledge API. + */ export interface Schema$SubscriptionPurchasesAcknowledgeRequest { /** * Payload to attach to the purchase. */ developerPayload?: string | null; } + /** + * Request for the purchases.subscriptions.defer API. + */ export interface Schema$SubscriptionPurchasesDeferRequest { /** * The information about the new desired expiry time for the subscription. */ deferralInfo?: Schema$SubscriptionDeferralInfo; } + /** + * Response for the purchases.subscriptions.defer API. + */ export interface Schema$SubscriptionPurchasesDeferResponse { /** * The new expiry time for the subscription in milliseconds since the Epoch. */ newExpiryTimeMillis?: string | null; } - export interface Schema$SystemApkVariantsCreateRequest { - deviceSpec?: Schema$DeviceSpec; - } - export interface Schema$SystemApkVariantsListResponse { - variants?: Schema$Variant[]; - } + /** + * The testers of an app. The resource for TestersService. + */ export interface Schema$Testers { - autoEnrolledAndroidGroups?: string[] | null; - autoEnrolledGoogleGroups?: string[] | null; - excludedGoogleGroups?: string[] | null; /** - * A list of all Google Groups, as email addresses, that define testers for this track. + * All testing Google Groups, as email addresses. */ googleGroups?: string[] | null; } + /** + * 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. + */ export interface Schema$Timestamp { + /** + * Non-negative fractions of a second at nanosecond resolution. Must be from 0 to 999,999,999 inclusive. + */ nanos?: number | null; + /** + * Represents seconds of UTC time since Unix epoch. + */ seconds?: string | null; } + /** + * Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one "page" 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. + */ export interface Schema$TokenPagination { + /** + * Tokens to pass to the standard list field 'page_token'. Whenever available, tokens are preferred over manipulating start_index. + */ nextPageToken?: string | null; previousPageToken?: string | null; } + /** + * A track configuration. The resource for TracksService. + */ export interface Schema$Track { /** - * A list of all active releases in this track during a read request. On an update request, it represents desired changes. + * In a read request, represents all active releases in the track. In an update request, represents desired changes. */ releases?: Schema$TrackRelease[]; /** - * Identifier for this track. + * Identifier of the track. */ track?: string | null; } + /** + * A release within a track. + */ export interface Schema$TrackRelease { - controls?: Schema$Control[]; + /** + * Restricts a release to a specific set of countries. + */ countryTargeting?: Schema$CountryTargeting; /** - * In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. + * In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. */ inAppUpdatePriority?: number | null; /** - * The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. + * The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date. */ name?: string | null; - pinnedVersions?: Schema$TrackReleasePin[]; /** - * The description of what is new in the app in this release. + * A description of what is new in this release. */ releaseNotes?: Schema$LocalizedText[]; - rollbackEnabled?: boolean | null; - sampling?: Schema$Sampling; /** - * The desired status of this release. + * The status of the release. */ status?: string | null; /** - * Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". + * Fraction of users who are eligible for a staged release. 0 < fraction < 1. Can only be set when status is "inProgress" or "halted". */ userFraction?: number | null; /** - * A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. + * Version codes of all APKs in the release. Must include version codes to retain from previous releases. */ versionCodes?: string[] | null; } - export interface Schema$TrackReleasePin { - targetings?: Schema$TrackReleasePinPinTargeting[]; - versionCodes?: string[] | null; - } - export interface Schema$TrackReleasePinPinTargeting { - countryCodes?: string[] | null; - devices?: Schema$TrackReleasePinPinTargetingDevicePin[]; - phoneskyVersions?: string[] | null; - sdkVersions?: number[] | null; - } - export interface Schema$TrackReleasePinPinTargetingDevicePin { - brand?: string | null; - device?: string | null; - product?: string | null; - } + /** + * Response listing all tracks. + */ export interface Schema$TracksListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse". + * The kind of this response ("androidpublisher#tracksListResponse"). */ kind?: string | null; + /** + * All tracks. + */ tracks?: Schema$Track[]; } + /** + * User entry from conversation between user and developer. + */ export interface Schema$UserComment { /** * Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent. @@ -977,7 +1137,7 @@ export namespace androidpublisher_v3 { */ device?: string | null; /** - * Some information about the characteristics of the user's device + * Information about the characteristics of the user's device. */ deviceMetadata?: Schema$DeviceMetadata; /** @@ -985,7 +1145,7 @@ export namespace androidpublisher_v3 { */ lastModified?: Schema$Timestamp; /** - * 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. + * Untranslated text of the review, where the review was translated. If the review was not translated this is left blank. */ originalText?: string | null; /** @@ -1001,20 +1161,26 @@ export namespace androidpublisher_v3 { */ text?: string | null; /** - * Number of users who have given this review a thumbs down + * Number of users who have given this review a thumbs down. */ thumbsDownCount?: number | null; /** - * Number of users who have given this review a thumbs up + * Number of users who have given this review a thumbs up. */ thumbsUpCount?: number | null; } /** - * Represents the variant of a generated system APK from an uploaded App Bundle. + * A permission used by this APK. */ - export interface Schema$Variant { - deviceSpec?: Schema$DeviceSpec; - variantId?: number | null; + export interface Schema$UsesPermission { + /** + * Optionally, the maximum SDK version for which the permission is required. + */ + maxSdkVersion?: number | null; + /** + * The name of the permission requested. + */ + name?: string | null; } /** * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back. @@ -1037,11 +1203,11 @@ export namespace androidpublisher_v3 { */ purchaseToken?: string | null; /** - * The reason why the purchase was voided, possible values are: - Other - Remorse - Not_received - Defective - Accidental_purchase - Fraud - Friendly_fraud - Chargeback + * The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback */ voidedReason?: number | null; /** - * The initiator of voided purchase, possible values are: - User - Developer - Google + * The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google */ voidedSource?: number | null; /** @@ -1049,8 +1215,17 @@ export namespace androidpublisher_v3 { */ voidedTimeMillis?: string | null; } + /** + * Response for the voidedpurchases.list API. + */ export interface Schema$VoidedPurchasesListResponse { + /** + * General pagination information. + */ pageInfo?: Schema$PageInfo; + /** + * Pagination information for token pagination. + */ tokenPagination?: Schema$TokenPagination; voidedPurchases?: Schema$VoidedPurchase[]; } @@ -1083,7 +1258,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.commit - * @desc Commits/applies the changes made in this edit back to the app. + * @desc Commits an app edit. * @example * // Before running the sample: * // - Enable the API at: @@ -1108,9 +1283,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.commit({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -1131,8 +1306,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1217,7 +1392,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.delete - * @desc Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit. + * @desc Deletes an app edit. * @example * // Before running the sample: * // - Enable the API at: @@ -1242,9 +1417,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.delete({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -1259,8 +1434,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1343,7 +1518,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.get - * @desc Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired). + * @desc Gets an app edit. * @example * // Before running the sample: * // - Enable the API at: @@ -1368,9 +1543,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.get({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -1391,8 +1566,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1477,7 +1652,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.insert - * @desc Creates a new edit for an app, populated with the app's current state. + * @desc Creates a new edit for an app. * @example * // Before running the sample: * // - Enable the API at: @@ -1502,7 +1677,7 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.insert({ - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -1532,7 +1707,7 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Package name of the app. * @param {().AppEdit} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1617,7 +1792,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.validate - * @desc Checks that the edit can be successfully committed. The edit's changes are not applied to the live app. + * @desc Validates an app edit. * @example * // Before running the sample: * // - Enable the API at: @@ -1642,9 +1817,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.validate({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -1665,8 +1840,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1752,37 +1927,37 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Commit extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Delete extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Get extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Insert extends StandardParameters { /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -1793,11 +1968,11 @@ export namespace androidpublisher_v3 { } export interface Params$Resource$Edits$Validate extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } @@ -1810,7 +1985,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.apks.addexternallyhosted - * @desc Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain. + * @desc Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to organizations using Managed Play whose application is configured to restrict distribution to the organizations. * @example * // Before running the sample: * // - Enable the API at: @@ -1835,9 +2010,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.apks.addexternallyhosted({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -1865,8 +2040,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {().ApksAddExternallyHostedRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1962,6 +2137,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.apks.list + * @desc Lists all current APKs of the app and edit. * @example * // Before running the sample: * // - Enable the API at: @@ -1986,9 +2162,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.apks.list({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -2009,8 +2185,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2095,6 +2271,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.apks.upload + * @desc Uploads an APK and adds to the current edit. * @example * // Before running the sample: * // - Enable the API at: @@ -2119,9 +2296,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.apks.upload({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * requestBody: { @@ -2137,7 +2314,6 @@ export namespace androidpublisher_v3 { * // Example response * // { * // "binary": {}, - * // "testBinary": {}, * // "versionCode": 0 * // } * } @@ -2151,8 +2327,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -2247,11 +2423,11 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Apks$Addexternallyhosted extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -2262,22 +2438,22 @@ export namespace androidpublisher_v3 { } export interface Params$Resource$Edits$Apks$List extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Apks$Upload extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -2310,6 +2486,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.bundles.list + * @desc Lists all current Android App Bundles of the app and edit. * @example * // Before running the sample: * // - Enable the API at: @@ -2334,9 +2511,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.bundles.list({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -2357,8 +2534,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2447,7 +2624,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.bundles.upload - * @desc Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java. + * @desc Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](https://developers.google.com/api-client-library/java/google-api-java-client/errors) for an example in java. * @example * // Before running the sample: * // - Enable the API at: @@ -2472,11 +2649,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.bundles.upload({ - * // Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB). + * // Must be set to true if the bundle installation may trigger a warning on + * // user devices (for example, if installation size may be over a threshold, + * // typically 100 MB). * ackBundleInstallationWarning: 'placeholder-value', - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * requestBody: { @@ -2507,8 +2686,8 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {boolean=} params.ackBundleInstallationWarning Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB). - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -2603,11 +2782,11 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Bundles$List extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } @@ -2618,11 +2797,11 @@ export namespace androidpublisher_v3 { */ ackBundleInstallationWarning?: boolean; /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -2655,7 +2834,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.deobfuscationfiles.upload - * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation or symbolication file already exists, it will be replaced. See https://developer.android.com/studio/build/shrink-code to learn more about deobfuscation files. + * @desc Uploads a new deobfuscation file and attaches to the specified APK. * @example * // Before running the sample: * // - Enable the API at: @@ -2680,13 +2859,14 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.deobfuscationfiles.upload({ - * // The version code of the APK whose deobfuscation file is being uploaded. + * // The version code of the APK whose Deobfuscation File is being + * // uploaded. * apkVersionCode: 'placeholder-value', - * + * // The type of the deobfuscation file. * deobfuscationFileType: 'placeholder-value', * // Unique identifier for this edit. * editId: 'placeholder-value', - * // Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, "com.spiffygame". + * // Unique identifier for the Android app. * packageName: 'placeholder-value', * * requestBody: { @@ -2714,10 +2894,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose deobfuscation file is being uploaded. - * @param {string} params.deobfuscationFileType + * @param {integer} params.apkVersionCode The version code of the APK whose Deobfuscation File is being uploaded. + * @param {string} params.deobfuscationFileType The type of the deobfuscation file. * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -2831,11 +3011,11 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Deobfuscationfiles$Upload extends StandardParameters { /** - * The version code of the APK whose deobfuscation file is being uploaded. + * The version code of the APK whose Deobfuscation File is being uploaded. */ apkVersionCode?: number; /** - * + * The type of the deobfuscation file. */ deobfuscationFileType?: string; /** @@ -2843,7 +3023,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, "com.spiffygame". + * Unique identifier for the Android app. */ packageName?: string; @@ -2876,7 +3056,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.details.get - * @desc Fetches app details for this edit. This includes the default language and developer support contact information. + * @desc Gets details of an app. * @example * // Before running the sample: * // - Enable the API at: @@ -2901,9 +3081,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.details.get({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -2926,8 +3106,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3013,7 +3193,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.details.patch - * @desc Updates app details for this edit. This method supports patch semantics. + * @desc Patches details of an app. * @example * // Before running the sample: * // - Enable the API at: @@ -3038,9 +3218,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.details.patch({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -3074,8 +3254,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {().AppDetails} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3162,7 +3342,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.details.update - * @desc Updates app details for this edit. + * @desc Updates details of an app. * @example * // Before running the sample: * // - Enable the API at: @@ -3187,9 +3367,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.details.update({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -3223,8 +3403,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {().AppDetails} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3313,22 +3493,22 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Details$Get extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Details$Patch extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -3340,11 +3520,11 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Details$Update extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -3362,7 +3542,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.expansionfiles.get - * @desc Fetches the Expansion File configuration for the APK specified. + * @desc Fetches the expansion file configuration for the specified APK. * @example * // Before running the sample: * // - Enable the API at: @@ -3387,13 +3567,14 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.expansionfiles.get({ - * // The version code of the APK whose Expansion File configuration is being read or modified. + * // The version code of the APK whose expansion file configuration is being + * // read or modified. * apkVersionCode: 'placeholder-value', - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * + * // The file type of the file configuration which is being read or modified. * expansionFileType: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -3414,10 +3595,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {integer} params.apkVersionCode The version code of the APK whose expansion file configuration is being read or modified. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.expansionFileType The file type of the file configuration which is being read or modified. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3513,7 +3694,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.expansionfiles.patch - * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics. + * @desc Patches the APK's expansion file configuration to reference another APK's expansion file. To add a new expansion file use the Upload method. * @example * // Before running the sample: * // - Enable the API at: @@ -3538,13 +3719,14 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.expansionfiles.patch({ - * // The version code of the APK whose Expansion File configuration is being read or modified. + * // The version code of the APK whose expansion file configuration is being + * // read or modified. * apkVersionCode: 'placeholder-value', - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * + * // The file type of the expansion file configuration which is being updated. * expansionFileType: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -3574,10 +3756,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {integer} params.apkVersionCode The version code of the APK whose expansion file configuration is being read or modified. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.expansionFileType The file type of the expansion file configuration which is being updated. + * @param {string} params.packageName Package name of the app. * @param {().ExpansionFile} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3674,7 +3856,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.expansionfiles.update - * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. + * @desc Updates the APK's expansion file configuration to reference another APK's expansion file. To add a new expansion file use the Upload method. * @example * // Before running the sample: * // - Enable the API at: @@ -3699,13 +3881,14 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.expansionfiles.update({ - * // The version code of the APK whose Expansion File configuration is being read or modified. + * // The version code of the APK whose expansion file configuration is being + * // read or modified. * apkVersionCode: 'placeholder-value', - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * + * // The file type of the file configuration which is being read or modified. * expansionFileType: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -3735,10 +3918,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {integer} params.apkVersionCode The version code of the APK whose expansion file configuration is being read or modified. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.expansionFileType The file type of the file configuration which is being read or modified. + * @param {string} params.packageName Package name of the app. * @param {().ExpansionFile} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3835,7 +4018,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.expansionfiles.upload - * @desc Uploads and attaches a new Expansion File to the APK specified. + * @desc Uploads a new expansion file and attaches to the specified APK. * @example * // Before running the sample: * // - Enable the API at: @@ -3860,13 +4043,14 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.expansionfiles.upload({ - * // The version code of the APK whose Expansion File configuration is being read or modified. + * // The version code of the APK whose expansion file configuration is being + * // read or modified. * apkVersionCode: 'placeholder-value', - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * + * // The file type of the expansion file configuration which is being updated. * expansionFileType: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * requestBody: { @@ -3894,10 +4078,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {integer} params.apkVersionCode The version code of the APK whose expansion file configuration is being read or modified. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.expansionFileType The file type of the expansion file configuration which is being updated. + * @param {string} params.packageName Package name of the app. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -4011,38 +4195,38 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Expansionfiles$Get extends StandardParameters { /** - * The version code of the APK whose Expansion File configuration is being read or modified. + * The version code of the APK whose expansion file configuration is being read or modified. */ apkVersionCode?: number; /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * + * The file type of the file configuration which is being read or modified. */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Expansionfiles$Patch extends StandardParameters { /** - * The version code of the APK whose Expansion File configuration is being read or modified. + * The version code of the APK whose expansion file configuration is being read or modified. */ apkVersionCode?: number; /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * + * The file type of the expansion file configuration which is being updated. */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -4054,19 +4238,19 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Expansionfiles$Update extends StandardParameters { /** - * The version code of the APK whose Expansion File configuration is being read or modified. + * The version code of the APK whose expansion file configuration is being read or modified. */ apkVersionCode?: number; /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * + * The file type of the file configuration which is being read or modified. */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -4078,19 +4262,19 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Expansionfiles$Upload extends StandardParameters { /** - * The version code of the APK whose Expansion File configuration is being read or modified. + * The version code of the APK whose expansion file configuration is being read or modified. */ apkVersionCode?: number; /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * + * The file type of the expansion file configuration which is being updated. */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -4148,15 +4332,16 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.images.delete({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', * // Unique identifier an image within the set of images attached to this edit. * imageId: 'placeholder-value', - * + * // Type of the Image. * imageType: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -4171,11 +4356,11 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. + * @param {string} params.editId Identifier of the edit. * @param {string} params.imageId Unique identifier an image within the set of images attached to this edit. - * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.imageType Type of the Image. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4271,7 +4456,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.images.deleteall - * @desc Deletes all images for the specified language and image type. + * @desc Deletes all images for the specified language and image type. Returns an empty response if no images are found. * @example * // Before running the sample: * // - Enable the API at: @@ -4296,13 +4481,16 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.images.deleteall({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * + * // Type of the Image. + * // Providing an image type that refers to no images is a no-op. * imageType: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). + * // Providing a language that is not supported by the App is a no-op. * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -4322,10 +4510,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.imageType Type of the Image. Providing an image type that refers to no images is a no-op. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). Providing a language that is not supported by the App is a no-op. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4418,7 +4606,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.images.list - * @desc Lists all images for the specified language and image type. + * @desc Lists all images. The response may be empty. * @example * // Before running the sample: * // - Enable the API at: @@ -4443,13 +4631,16 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.images.list({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * + * // Type of the Image. Providing an image type that refers to no images will + * // return an empty response. * imageType: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). + * // There must be a store listing for the specified language. * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -4469,10 +4660,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.imageType Type of the Image. Providing an image type that refers to no images will return an empty response. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). There must be a store listing for the specified language. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4561,7 +4752,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.images.upload - * @desc Uploads a new image and adds it to the list of images for the specified language and image type. + * @desc Uploads an image of the specified language and image type, and adds to the edit. * @example * // Before running the sample: * // - Enable the API at: @@ -4586,13 +4777,15 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.images.upload({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * + * // Type of the Image. * imageType: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). + * // Providing a language that is not supported by the App is a no-op. * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * requestBody: { @@ -4620,10 +4813,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.imageType Type of the Image. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). Providing a language that is not supported by the App is a no-op. + * @param {string} params.packageName Package name of the app. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -4723,7 +4916,7 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Images$Delete extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** @@ -4731,72 +4924,72 @@ export namespace androidpublisher_v3 { */ imageId?: string; /** - * + * Type of the Image. */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Images$Deleteall extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * + * Type of the Image. Providing an image type that refers to no images is a no-op. */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). Providing a language that is not supported by the App is a no-op. */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Images$List extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * + * Type of the Image. Providing an image type that refers to no images will return an empty response. */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). There must be a store listing for the specified language. */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Images$Upload extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * + * Type of the Image. */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). Providing a language that is not supported by the App is a no-op. */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -4829,7 +5022,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.listings.delete - * @desc Deletes the specified localized store listing from an edit. + * @desc Deletes a localized store listing. * @example * // Before running the sample: * // - Enable the API at: @@ -4854,11 +5047,12 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.listings.delete({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -4873,9 +5067,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4959,7 +5153,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.listings.deleteall - * @desc Deletes all localized listings from an edit. + * @desc Deletes all store listings. * @example * // Before running the sample: * // - Enable the API at: @@ -4984,9 +5178,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.listings.deleteall({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -5001,8 +5195,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5086,7 +5280,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.listings.get - * @desc Fetches information about a localized store listing. + * @desc Gets a localized store listing. * @example * // Before running the sample: * // - Enable the API at: @@ -5111,11 +5305,12 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.listings.get({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -5139,9 +5334,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5227,7 +5422,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.listings.list - * @desc Returns all of the localized store listings attached to this edit. + * @desc Lists all localized store listings. * @example * // Before running the sample: * // - Enable the API at: @@ -5252,9 +5447,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.listings.list({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -5275,8 +5470,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5367,7 +5562,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.listings.patch - * @desc Creates or updates a localized store listing. This method supports patch semantics. + * @desc Patches a localized store listing. * @example * // Before running the sample: * // - Enable the API at: @@ -5392,11 +5587,12 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.listings.patch({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -5432,9 +5628,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). + * @param {string} params.packageName Package name of the app. * @param {().Listing} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5546,11 +5742,12 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.listings.update({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * // Language localization code (a BCP-47 language tag; for example, "de-AT" + * // for Austrian German). * language: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -5586,9 +5783,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.language Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). + * @param {string} params.packageName Package name of the app. * @param {().Listing} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5677,67 +5874,67 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Listings$Delete extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Listings$Deleteall extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Listings$Get extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Listings$List extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Listings$Patch extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -5749,15 +5946,15 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Listings$Update extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". + * Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -5775,6 +5972,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.testers.get + * @desc Gets testers. * @example * // Before running the sample: * // - Enable the API at: @@ -5799,20 +5997,17 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.testers.get({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * // The track to read or modify. + * // The track to read from. * track: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "autoEnrolledAndroidGroups": [], - * // "autoEnrolledGoogleGroups": [], - * // "excludedGoogleGroups": [], * // "googleGroups": [] * // } * } @@ -5826,9 +6021,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. + * @param {string} params.track The track to read from. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5914,6 +6109,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.testers.patch + * @desc Patches testers. * @example * // Before running the sample: * // - Enable the API at: @@ -5938,20 +6134,17 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.testers.patch({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * // The track to read or modify. + * // The track to update. * track: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "autoEnrolledAndroidGroups": [], - * // "autoEnrolledGoogleGroups": [], - * // "excludedGoogleGroups": [], * // "googleGroups": [] * // } * }, @@ -5960,9 +6153,6 @@ export namespace androidpublisher_v3 { * * // Example response * // { - * // "autoEnrolledAndroidGroups": [], - * // "autoEnrolledGoogleGroups": [], - * // "excludedGoogleGroups": [], * // "googleGroups": [] * // } * } @@ -5976,9 +6166,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. + * @param {string} params.track The track to update. * @param {().Testers} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6065,6 +6255,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.testers.update + * @desc Updates testers. * @example * // Before running the sample: * // - Enable the API at: @@ -6089,20 +6280,17 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.testers.update({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * // The track to read or modify. + * // The track to update. * track: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "autoEnrolledAndroidGroups": [], - * // "autoEnrolledGoogleGroups": [], - * // "excludedGoogleGroups": [], * // "googleGroups": [] * // } * }, @@ -6111,9 +6299,6 @@ export namespace androidpublisher_v3 { * * // Example response * // { - * // "autoEnrolledAndroidGroups": [], - * // "autoEnrolledGoogleGroups": [], - * // "excludedGoogleGroups": [], * // "googleGroups": [] * // } * } @@ -6127,9 +6312,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. + * @param {string} params.track The track to update. * @param {().Testers} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6218,30 +6403,30 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Testers$Get extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * The track to read or modify. + * The track to read from. */ track?: string; } export interface Params$Resource$Edits$Testers$Patch extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * The track to read or modify. + * The track to update. */ track?: string; @@ -6253,15 +6438,15 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Testers$Update extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * The track to read or modify. + * The track to update. */ track?: string; @@ -6279,7 +6464,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.get - * @desc Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track. + * @desc Gets a track. * @example * // Before running the sample: * // - Enable the API at: @@ -6304,11 +6489,11 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.tracks.get({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * // The track to read or modify. + * // Identifier of the track. * track: 'placeholder-value', * }); * console.log(res.data); @@ -6329,9 +6514,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. + * @param {string} params.track Identifier of the track. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6416,7 +6601,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.list - * @desc Lists all the track configurations for this edit. + * @desc Lists all tracks. * @example * // Before running the sample: * // - Enable the API at: @@ -6441,9 +6626,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.tracks.list({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * }); * console.log(res.data); @@ -6464,8 +6649,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6554,7 +6739,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.patch - * @desc Updates the track configuration for the specified track type. This method supports patch semantics. + * @desc Patches a track. * @example * // Before running the sample: * // - Enable the API at: @@ -6579,11 +6764,11 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.tracks.patch({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * // The track to read or modify. + * // Identifier of the track. * track: 'placeholder-value', * * // Request body metadata @@ -6613,9 +6798,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. + * @param {string} params.track Identifier of the track. * @param {().Track} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6702,7 +6887,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.update - * @desc Updates the track configuration for the specified track type. + * @desc Updates a track. * @example * // Before running the sample: * // - Enable the API at: @@ -6727,11 +6912,11 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.edits.tracks.update({ - * // Unique identifier for this edit. + * // Identifier of the edit. * editId: 'placeholder-value', - * // Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * // The track to read or modify. + * // Identifier of the track. * track: 'placeholder-value', * * // Request body metadata @@ -6761,9 +6946,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. + * @param {string} params.editId Identifier of the edit. + * @param {string} params.packageName Package name of the app. + * @param {string} params.track Identifier of the track. * @param {().Track} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6851,41 +7036,41 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Tracks$Get extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * The track to read or modify. + * Identifier of the track. */ track?: string; } export interface Params$Resource$Edits$Tracks$List extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; } export interface Params$Resource$Edits$Tracks$Patch extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * The track to read or modify. + * Identifier of the track. */ track?: string; @@ -6897,15 +7082,15 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Edits$Tracks$Update extends StandardParameters { /** - * Unique identifier for this edit. + * Identifier of the edit. */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * The track to read or modify. + * Identifier of the track. */ track?: string; @@ -6923,7 +7108,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.delete - * @desc Delete an in-app product for an app. + * @desc Deletes an in-app product (i.e. a managed product or a subscriptions). * @example * // Before running the sample: * // - Enable the API at: @@ -6948,7 +7133,7 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.inappproducts.delete({ - * // Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * // Unique identifier for the in-app product. * sku: 'placeholder-value', @@ -6965,7 +7150,7 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {string} params.packageName Package name of the app. * @param {string} params.sku Unique identifier for the in-app product. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7050,7 +7235,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.get - * @desc Returns information about the in-app product specified. + * @desc Gets an in-app product, which can be a managed product or a subscription. * @example * // Before running the sample: * // - Enable the API at: @@ -7075,6 +7260,7 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.inappproducts.get({ + * // Package name of the app. * packageName: 'placeholder-value', * // Unique identifier for the in-app product. * sku: 'placeholder-value', @@ -7090,7 +7276,6 @@ export namespace androidpublisher_v3 { * // "packageName": "my_packageName", * // "prices": {}, * // "purchaseType": "my_purchaseType", - * // "resubscribeEligibility": "my_resubscribeEligibility", * // "sku": "my_sku", * // "status": "my_status", * // "subscriptionPeriod": "my_subscriptionPeriod", @@ -7107,7 +7292,7 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName + * @param {string} params.packageName Package name of the app. * @param {string} params.sku Unique identifier for the in-app product. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7194,7 +7379,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.insert - * @desc Creates a new in-app product for an app. + * @desc Creates an in-app product (i.e. a managed product or a subscriptions). * @example * // Before running the sample: * // - Enable the API at: @@ -7219,9 +7404,11 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.inappproducts.insert({ - * // If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. + * // If true the prices for all regions targeted by the parent app that don't + * // have a price specified for this in-app product will be auto converted to + * // the target currency based on the default price. Defaults to false. * autoConvertMissingPrices: 'placeholder-value', - * // Unique identifier for the Android app; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * // Request body metadata @@ -7235,7 +7422,6 @@ export namespace androidpublisher_v3 { * // "packageName": "my_packageName", * // "prices": {}, * // "purchaseType": "my_purchaseType", - * // "resubscribeEligibility": "my_resubscribeEligibility", * // "sku": "my_sku", * // "status": "my_status", * // "subscriptionPeriod": "my_subscriptionPeriod", @@ -7254,7 +7440,6 @@ export namespace androidpublisher_v3 { * // "packageName": "my_packageName", * // "prices": {}, * // "purchaseType": "my_purchaseType", - * // "resubscribeEligibility": "my_resubscribeEligibility", * // "sku": "my_sku", * // "status": "my_status", * // "subscriptionPeriod": "my_subscriptionPeriod", @@ -7272,7 +7457,7 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {string} params.packageName Package name of the app. * @param {().InAppProduct} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7359,7 +7544,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.list - * @desc List all the in-app products for an Android app, both subscriptions and managed in-app products.. + * @desc Lists all in-app products - both managed products and subscriptions. * @example * // Before running the sample: * // - Enable the API at: @@ -7384,12 +7569,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.inappproducts.list({ + * // How many results the list operation should return. * maxResults: 'placeholder-value', - * // Unique identifier for the Android app with in-app products; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * + * // The index of the first element to return. * startIndex: 'placeholder-value', - * + * // Pagination token. If empty, list starts at the first product. * token: 'placeholder-value', * }); * console.log(res.data); @@ -7412,10 +7598,10 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxResults - * @param {string} params.packageName Unique identifier for the Android app with in-app products; for example, "com.spiffygame". - * @param {integer=} params.startIndex - * @param {string=} params.token + * @param {integer=} params.maxResults How many results the list operation should return. + * @param {string} params.packageName Package name of the app. + * @param {integer=} params.startIndex The index of the first element to return. + * @param {string=} params.token Pagination token. If empty, list starts at the first product. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7508,7 +7694,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.patch - * @desc Updates the details of an in-app product. This method supports patch semantics. + * @desc Patches an in-app product (i.e. a managed product or a subscriptions). * @example * // Before running the sample: * // - Enable the API at: @@ -7533,9 +7719,11 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.inappproducts.patch({ - * // If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. + * // If true the prices for all regions targeted by the parent app that don't + * // have a price specified for this in-app product will be auto converted to + * // the target currency based on the default price. Defaults to false. * autoConvertMissingPrices: 'placeholder-value', - * // Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * // Unique identifier for the in-app product. * sku: 'placeholder-value', @@ -7551,7 +7739,6 @@ export namespace androidpublisher_v3 { * // "packageName": "my_packageName", * // "prices": {}, * // "purchaseType": "my_purchaseType", - * // "resubscribeEligibility": "my_resubscribeEligibility", * // "sku": "my_sku", * // "status": "my_status", * // "subscriptionPeriod": "my_subscriptionPeriod", @@ -7570,7 +7757,6 @@ export namespace androidpublisher_v3 { * // "packageName": "my_packageName", * // "prices": {}, * // "purchaseType": "my_purchaseType", - * // "resubscribeEligibility": "my_resubscribeEligibility", * // "sku": "my_sku", * // "status": "my_status", * // "subscriptionPeriod": "my_subscriptionPeriod", @@ -7588,7 +7774,7 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {string} params.packageName Package name of the app. * @param {string} params.sku Unique identifier for the in-app product. * @param {().InAppProduct} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7676,7 +7862,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.update - * @desc Updates the details of an in-app product. + * @desc Updates an in-app product (i.e. a managed product or a subscriptions). * @example * // Before running the sample: * // - Enable the API at: @@ -7701,9 +7887,11 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.inappproducts.update({ - * // If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. + * // If true the prices for all regions targeted by the parent app that don't + * // have a price specified for this in-app product will be auto converted to + * // the target currency based on the default price. Defaults to false. * autoConvertMissingPrices: 'placeholder-value', - * // Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * // Unique identifier for the in-app product. * sku: 'placeholder-value', @@ -7719,7 +7907,6 @@ export namespace androidpublisher_v3 { * // "packageName": "my_packageName", * // "prices": {}, * // "purchaseType": "my_purchaseType", - * // "resubscribeEligibility": "my_resubscribeEligibility", * // "sku": "my_sku", * // "status": "my_status", * // "subscriptionPeriod": "my_subscriptionPeriod", @@ -7738,7 +7925,6 @@ export namespace androidpublisher_v3 { * // "packageName": "my_packageName", * // "prices": {}, * // "purchaseType": "my_purchaseType", - * // "resubscribeEligibility": "my_resubscribeEligibility", * // "sku": "my_sku", * // "status": "my_status", * // "subscriptionPeriod": "my_subscriptionPeriod", @@ -7756,7 +7942,7 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {string} params.packageName Package name of the app. * @param {string} params.sku Unique identifier for the in-app product. * @param {().InAppProduct} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7846,7 +8032,7 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Inappproducts$Delete extends StandardParameters { /** - * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** @@ -7857,7 +8043,7 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Inappproducts$Get extends StandardParameters { /** - * + * Package name of the app. */ packageName?: string; /** @@ -7872,7 +8058,7 @@ export namespace androidpublisher_v3 { */ autoConvertMissingPrices?: boolean; /** - * Unique identifier for the Android app; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -7884,19 +8070,19 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Inappproducts$List extends StandardParameters { /** - * + * How many results the list operation should return. */ maxResults?: number; /** - * Unique identifier for the Android app with in-app products; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * + * The index of the first element to return. */ startIndex?: number; /** - * + * Pagination token. If empty, list starts at the first product. */ token?: string; } @@ -7907,7 +8093,7 @@ export namespace androidpublisher_v3 { */ autoConvertMissingPrices?: boolean; /** - * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** @@ -7927,7 +8113,7 @@ export namespace androidpublisher_v3 { */ autoConvertMissingPrices?: boolean; /** - * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** @@ -7949,7 +8135,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.internalappsharingartifacts.uploadapk - * @desc Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java. + * @desc Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](https://developers.google.com/api-client-library/java/google-api-java-client/errors) for an example in java. * @example * // Before running the sample: * // - Enable the API at: @@ -7974,7 +8160,7 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.internalappsharingartifacts.uploadapk({ - * // Unique identifier for the Android app; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * requestBody: { @@ -8004,7 +8190,7 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {string} params.packageName Package name of the app. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -8104,7 +8290,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.internalappsharingartifacts.uploadbundle - * @desc Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java. + * @desc Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](https://developers.google.com/api-client-library/java/google-api-java-client/errors) for an example in java. * @example * // Before running the sample: * // - Enable the API at: @@ -8129,7 +8315,7 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.internalappsharingartifacts.uploadbundle({ - * // Unique identifier for the Android app; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', * * requestBody: { @@ -8159,7 +8345,7 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {string} params.packageName Package name of the app. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -8261,7 +8447,7 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Internalappsharingartifacts$Uploadapk extends StandardParameters { /** - * Unique identifier for the Android app; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -8288,7 +8474,7 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Internalappsharingartifacts$Uploadbundle extends StandardParameters { /** - * Unique identifier for the Android app; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; @@ -8346,11 +8532,16 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.orders.refund({ - * // The order ID provided to the user when the subscription or in-app order was purchased. + * // The order ID provided to the user when the subscription or in-app order was + * // purchased. * orderId: 'placeholder-value', - * // The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). + * // The package name of the application for which this subscription or in-app + * // item was purchased (for example, 'com.some.thing'). * packageName: 'placeholder-value', - * // Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional) + * // Whether to revoke the purchased item. If set to true, access to the + * // subscription or in-app item will be terminated immediately. If the item is + * // a recurring subscription, all future payments will also be terminated. + * // Consumed in-app items need to be handled by developer's app. (optional). * revoke: 'placeholder-value', * }); * console.log(res.data); @@ -8367,7 +8558,7 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.orderId The order ID provided to the user when the subscription or in-app order was purchased. * @param {string} params.packageName The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). - * @param {boolean=} params.revoke Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional) + * @param {boolean=} params.revoke Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8459,7 +8650,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; /** - * Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional) + * Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional). */ revoke?: boolean; } @@ -8512,11 +8703,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.products.acknowledge({ - * // The package name of the application the inapp product was sold in (for example, 'com.some.thing'). + * // The package name of the application the inapp product was sold in (for + * // example, 'com.some.thing'). * packageName: 'placeholder-value', * // The inapp product SKU (for example, 'com.some.thing.inapp1'). * productId: 'placeholder-value', - * // The token provided to the user's device when the subscription was purchased. + * // The token provided to the user's device when the inapp product was + * // purchased. * token: 'placeholder-value', * * // Request body metadata @@ -8541,7 +8734,7 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing'). * @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. + * @param {string} params.token The token provided to the user's device when the inapp product was purchased. * @param {().ProductPurchasesAcknowledgeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8651,11 +8844,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.products.get({ - * // The package name of the application the inapp product was sold in (for example, 'com.some.thing'). + * // The package name of the application the inapp product was sold in (for + * // example, 'com.some.thing'). * packageName: 'placeholder-value', * // The inapp product SKU (for example, 'com.some.thing.inapp1'). * productId: 'placeholder-value', - * // The token provided to the user's device when the inapp product was purchased. + * // The token provided to the user's device when the inapp product was + * // purchased. * token: 'placeholder-value', * }); * console.log(res.data); @@ -8666,6 +8861,8 @@ export namespace androidpublisher_v3 { * // "consumptionState": 0, * // "developerPayload": "my_developerPayload", * // "kind": "my_kind", + * // "obfuscatedExternalAccountId": "my_obfuscatedExternalAccountId", + * // "obfuscatedExternalProfileId": "my_obfuscatedExternalProfileId", * // "orderId": "my_orderId", * // "productId": "my_productId", * // "purchaseState": 0, @@ -8783,7 +8980,7 @@ export namespace androidpublisher_v3 { */ productId?: string; /** - * The token provided to the user's device when the subscription was purchased. + * The token provided to the user's device when the inapp product was purchased. */ token?: string; @@ -8841,11 +9038,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.subscriptions.acknowledge({ - * // The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + * // The package name of the application for which this subscription was + * // purchased (for example, 'com.some.thing'). * packageName: 'placeholder-value', * // The purchased subscription ID (for example, 'monthly001'). * subscriptionId: 'placeholder-value', - * // The token provided to the user's device when the subscription was purchased. + * // The token provided to the user's device when the subscription was + * // purchased. * token: 'placeholder-value', * * // Request body metadata @@ -8980,11 +9179,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.subscriptions.cancel({ - * // The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + * // The package name of the application for which this subscription was + * // purchased (for example, 'com.some.thing'). * packageName: 'placeholder-value', * // The purchased subscription ID (for example, 'monthly001'). * subscriptionId: 'placeholder-value', - * // The token provided to the user's device when the subscription was purchased. + * // The token provided to the user's device when the subscription was + * // purchased. * token: 'placeholder-value', * }); * console.log(res.data); @@ -9110,11 +9311,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.subscriptions.defer({ - * // The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + * // The package name of the application for which this subscription was + * // purchased (for example, 'com.some.thing'). * packageName: 'placeholder-value', * // The purchased subscription ID (for example, 'monthly001'). * subscriptionId: 'placeholder-value', - * // The token provided to the user's device when the subscription was purchased. + * // The token provided to the user's device when the subscription was + * // purchased. * token: 'placeholder-value', * * // Request body metadata @@ -9265,11 +9468,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.subscriptions.get({ - * // The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + * // The package name of the application for which this subscription was + * // purchased (for example, 'com.some.thing'). * packageName: 'placeholder-value', * // The purchased subscription ID (for example, 'monthly001'). * subscriptionId: 'placeholder-value', - * // The token provided to the user's device when the subscription was purchased. + * // The token provided to the user's device when the subscription was + * // purchased. * token: 'placeholder-value', * }); * console.log(res.data); @@ -9291,6 +9496,8 @@ export namespace androidpublisher_v3 { * // "introductoryPriceInfo": {}, * // "kind": "my_kind", * // "linkedPurchaseToken": "my_linkedPurchaseToken", + * // "obfuscatedExternalAccountId": "my_obfuscatedExternalAccountId", + * // "obfuscatedExternalProfileId": "my_obfuscatedExternalProfileId", * // "orderId": "my_orderId", * // "paymentState": 0, * // "priceAmountMicros": "my_priceAmountMicros", @@ -9433,11 +9640,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.subscriptions.refund({ - * // The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + * // The package name of the application for which this subscription was + * // purchased (for example, 'com.some.thing'). * packageName: 'placeholder-value', - * // The purchased subscription ID (for example, 'monthly001'). + * // "The purchased subscription ID (for example, 'monthly001'). * subscriptionId: 'placeholder-value', - * // The token provided to the user's device when the subscription was purchased. + * // The token provided to the user's device when the subscription was + * // purchased. * token: 'placeholder-value', * }); * console.log(res.data); @@ -9453,7 +9662,7 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). + * @param {string} params.subscriptionId "The purchased subscription ID (for example, 'monthly001'). * @param {string} params.token The token provided to the user's device when the subscription was purchased. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9563,11 +9772,13 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.subscriptions.revoke({ - * // The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + * // The package name of the application for which this subscription was + * // purchased (for example, 'com.some.thing'). * packageName: 'placeholder-value', * // The purchased subscription ID (for example, 'monthly001'). * subscriptionId: 'placeholder-value', - * // The token provided to the user's device when the subscription was purchased. + * // The token provided to the user's device when the subscription was + * // purchased. * token: 'placeholder-value', * }); * console.log(res.data); @@ -9744,7 +9955,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; /** - * The purchased subscription ID (for example, 'monthly001'). + * "The purchased subscription ID (for example, 'monthly001'). */ subscriptionId?: string; /** @@ -9801,21 +10012,47 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.purchases.voidedpurchases.list({ - * // The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. + * // The time, in milliseconds since the Epoch, of the newest voided purchase + * // that you want to see in the response. The value of this parameter cannot + * // be greater than the current time and is ignored if a pagination token is + * // set. Default value is current time. + * // Note: This filter is applied on the time at which the record is seen as + * // voided by our systems and not the actual voided time returned in the + * // response. * endTime: 'placeholder-value', - * + * // Defines how many results the list operation should return. + * // The default number depends on the resource collection. * maxResults: 'placeholder-value', - * // The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). + * // The package name of the application for which voided purchases need to be + * // returned (for example, 'com.some.thing'). * packageName: 'placeholder-value', - * + * // Defines the index of the first element to return. + * // This can only be used if indexed paging is enabled. * startIndex: 'placeholder-value', - * // The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. + * // The time, in milliseconds since the Epoch, of the oldest voided purchase + * // that you want to see in the response. The value of this parameter cannot + * // be older than 30 days and is ignored if a pagination token is set. + * // Default value is current time minus 30 days. + * // Note: This filter is applied on the time at which the record is seen as + * // voided by our systems and not the actual voided time returned in the + * // response. * startTime: 'placeholder-value', - * + * // Defines the token of the page to return, usually taken from + * // TokenPagination. + * // This can only be used if token paging is enabled. * token: 'placeholder-value', - * // The type of voided purchases that you want to see in the response. Possible values are: - * // - 0: Only voided in-app product purchases will be returned in the response. This is the default value. - * // - 1: Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken. + * // The type of voided purchases that you want to see in the response. + * // Possible values are: + * // 0. Only voided in-app product purchases will be returned in the + * // response. This is the default value. + * // 1. Both voided in-app purchases and voided subscription purchases + * // will be returned in the response. + * // + * // Note: Before requesting to receive voided subscription purchases, you + * // must switch to use orderId in the response which uniquely identifies + * // one-time purchases and subscriptions. Otherwise, you will receive multiple + * // subscription orders with the same PurchaseToken, because subscription + * // renewal orders share the same PurchaseToken. * type: 'placeholder-value', * }); * console.log(res.data); @@ -9838,12 +10075,12 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string=} params.endTime The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. - * @param {integer=} params.maxResults + * @param {integer=} params.maxResults Defines how many results the list operation should return. The default number depends on the resource collection. * @param {string} params.packageName The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). - * @param {integer=} params.startIndex + * @param {integer=} params.startIndex Defines the index of the first element to return. This can only be used if indexed paging is enabled. * @param {string=} params.startTime The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. - * @param {string=} params.token - * @param {integer=} params.type The type of voided purchases that you want to see in the response. Possible values are: - 0: Only voided in-app product purchases will be returned in the response. This is the default value. - 1: Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken. + * @param {string=} params.token Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled. + * @param {integer=} params.type The type of voided purchases that you want to see in the response. Possible values are: 0. Only voided in-app product purchases will be returned in the response. This is the default value. 1. Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9942,7 +10179,7 @@ export namespace androidpublisher_v3 { */ endTime?: string; /** - * + * Defines how many results the list operation should return. The default number depends on the resource collection. */ maxResults?: number; /** @@ -9950,7 +10187,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; /** - * + * Defines the index of the first element to return. This can only be used if indexed paging is enabled. */ startIndex?: number; /** @@ -9958,11 +10195,11 @@ export namespace androidpublisher_v3 { */ startTime?: string; /** - * + * Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled. */ token?: string; /** - * The type of voided purchases that you want to see in the response. Possible values are: - 0: Only voided in-app product purchases will be returned in the response. This is the default value. - 1: Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken. + * The type of voided purchases that you want to see in the response. Possible values are: 0. Only voided in-app product purchases will be returned in the response. This is the default value. 1. Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken. */ type?: number; } @@ -9975,7 +10212,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.reviews.get - * @desc Returns a single review. + * @desc Gets a single review. * @example * // Before running the sample: * // - Enable the API at: @@ -10000,11 +10237,11 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.reviews.get({ - * // Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * + * // Unique identifier for a review. * reviewId: 'placeholder-value', - * + * // Language localization code. * translationLanguage: 'placeholder-value', * }); * console.log(res.data); @@ -10026,9 +10263,9 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". - * @param {string} params.reviewId - * @param {string=} params.translationLanguage + * @param {string} params.packageName Package name of the app. + * @param {string} params.reviewId Unique identifier for a review. + * @param {string=} params.translationLanguage Language localization code. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10113,7 +10350,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.reviews.list - * @desc Returns a list of reviews. Only reviews from last week will be returned. + * @desc Lists all reviews. * @example * // Before running the sample: * // - Enable the API at: @@ -10138,14 +10375,15 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.reviews.list({ + * // How many results the list operation should return. * maxResults: 'placeholder-value', - * // Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * + * // The index of the first element to return. * startIndex: 'placeholder-value', - * + * // Pagination token. If empty, list starts at the first review. * token: 'placeholder-value', - * + * // Language localization code. * translationLanguage: 'placeholder-value', * }); * console.log(res.data); @@ -10167,11 +10405,11 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxResults - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". - * @param {integer=} params.startIndex - * @param {string=} params.token - * @param {string=} params.translationLanguage + * @param {integer=} params.maxResults How many results the list operation should return. + * @param {string} params.packageName Package name of the app. + * @param {integer=} params.startIndex The index of the first element to return. + * @param {string=} params.token Pagination token. If empty, list starts at the first review. + * @param {string=} params.translationLanguage Language localization code. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10259,7 +10497,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.reviews.reply - * @desc Reply to a single review, or update an existing reply. + * @desc Replies to a single review, or updates an existing reply. * @example * // Before running the sample: * // - Enable the API at: @@ -10284,9 +10522,9 @@ export namespace androidpublisher_v3 { * * // Do the magic * const res = await androidpublisher.reviews.reply({ - * // Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * // Package name of the app. * packageName: 'placeholder-value', - * + * // Unique identifier for a review. * reviewId: 'placeholder-value', * * // Request body metadata @@ -10314,8 +10552,8 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". - * @param {string} params.reviewId + * @param {string} params.packageName Package name of the app. + * @param {string} params.reviewId Unique identifier for a review. * @param {().ReviewsReplyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10407,47 +10645,47 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Reviews$Get extends StandardParameters { /** - * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * + * Unique identifier for a review. */ reviewId?: string; /** - * + * Language localization code. */ translationLanguage?: string; } export interface Params$Resource$Reviews$List extends StandardParameters { /** - * + * How many results the list operation should return. */ maxResults?: number; /** - * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * + * The index of the first element to return. */ startIndex?: number; /** - * + * Pagination token. If empty, list starts at the first review. */ token?: string; /** - * + * Language localization code. */ translationLanguage?: string; } export interface Params$Resource$Reviews$Reply extends StandardParameters { /** - * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * Package name of the app. */ packageName?: string; /** - * + * Unique identifier for a review. */ reviewId?: string; @@ -10456,633 +10694,4 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$ReviewsReplyRequest; } - - export class Resource$Systemapks { - context: APIRequestContext; - variants: Resource$Systemapks$Variants; - constructor(context: APIRequestContext) { - this.context = context; - this.variants = new Resource$Systemapks$Variants(this.context); - } - } - - export class Resource$Systemapks$Variants { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * androidpublisher.systemapks.variants.create - * @desc Creates a new variant of APK which is suitable for inclusion in a system image. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const androidpublisher = google.androidpublisher('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/androidpublisher'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await androidpublisher.systemapks.variants.create({ - * // Unique identifier for the Android app; for example, "com.spiffygame". - * packageName: 'placeholder-value', - * // The version code of the App Bundle. - * versionCode: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deviceSpec": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "deviceSpec": {}, - * // "variantId": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias androidpublisher.systemapks.variants.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". - * @param {string} params.versionCode The version code of the App Bundle. - * @param {().SystemApkVariantsCreateRequest} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params: Params$Resource$Systemapks$Variants$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Systemapks$Variants$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Systemapks$Variants$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Systemapks$Variants$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Systemapks$Variants$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Systemapks$Variants$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Systemapks$Variants$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Systemapks$Variants$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['packageName', 'versionCode'], - pathParams: ['packageName', 'versionCode'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * androidpublisher.systemapks.variants.download - * @desc Download a previously created APK which is suitable for inclusion in a system image. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const androidpublisher = google.androidpublisher('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/androidpublisher'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await androidpublisher.systemapks.variants.download({ - * // Unique identifier for the Android app; for example, "com.spiffygame". - * packageName: 'placeholder-value', - * - * variantId: 'placeholder-value', - * // The version code of the App Bundle. - * versionCode: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias androidpublisher.systemapks.variants.download - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". - * @param {integer} params.variantId - * @param {string} params.versionCode The version code of the App Bundle. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - download( - params: Params$Resource$Systemapks$Variants$Download, - options: StreamMethodOptions - ): GaxiosPromise; - download( - params?: Params$Resource$Systemapks$Variants$Download, - options?: MethodOptions - ): GaxiosPromise; - download( - params: Params$Resource$Systemapks$Variants$Download, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - download( - params: Params$Resource$Systemapks$Variants$Download, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - download( - params: Params$Resource$Systemapks$Variants$Download, - callback: BodyResponseCallback - ): void; - download(callback: BodyResponseCallback): void; - download( - paramsOrCallback?: - | Params$Resource$Systemapks$Variants$Download - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Systemapks$Variants$Download; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Systemapks$Variants$Download; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}:download' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['packageName', 'versionCode', 'variantId'], - pathParams: ['packageName', 'variantId', 'versionCode'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * androidpublisher.systemapks.variants.get - * @desc Returns a previously created system APK variant. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const androidpublisher = google.androidpublisher('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/androidpublisher'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await androidpublisher.systemapks.variants.get({ - * // Unique identifier for the Android app; for example, "com.spiffygame". - * packageName: 'placeholder-value', - * // Unique identifier for this variant. - * variantId: 'placeholder-value', - * // The version code of the App Bundle. - * versionCode: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "deviceSpec": {}, - * // "variantId": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias androidpublisher.systemapks.variants.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". - * @param {integer} params.variantId Unique identifier for this variant. - * @param {string} params.versionCode The version code of the App Bundle. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params: Params$Resource$Systemapks$Variants$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Systemapks$Variants$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Systemapks$Variants$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Systemapks$Variants$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Systemapks$Variants$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Systemapks$Variants$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Systemapks$Variants$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Systemapks$Variants$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['packageName', 'versionCode', 'variantId'], - pathParams: ['packageName', 'variantId', 'versionCode'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * androidpublisher.systemapks.variants.list - * @desc Returns the list of previously created system APK variants. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const androidpublisher = google.androidpublisher('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/androidpublisher'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await androidpublisher.systemapks.variants.list({ - * // Unique identifier for the Android app; for example, "com.spiffygame". - * packageName: 'placeholder-value', - * // The version code of the App Bundle. - * versionCode: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "variants": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias androidpublisher.systemapks.variants.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". - * @param {string} params.versionCode The version code of the App Bundle. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params: Params$Resource$Systemapks$Variants$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Systemapks$Variants$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Systemapks$Variants$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Systemapks$Variants$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Systemapks$Variants$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Systemapks$Variants$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Systemapks$Variants$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Systemapks$Variants$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['packageName', 'versionCode'], - pathParams: ['packageName', 'versionCode'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback<{} | void> - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Systemapks$Variants$Create - extends StandardParameters { - /** - * Unique identifier for the Android app; for example, "com.spiffygame". - */ - packageName?: string; - /** - * The version code of the App Bundle. - */ - versionCode?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SystemApkVariantsCreateRequest; - } - export interface Params$Resource$Systemapks$Variants$Download - extends StandardParameters { - /** - * Unique identifier for the Android app; for example, "com.spiffygame". - */ - packageName?: string; - /** - * - */ - variantId?: number; - /** - * The version code of the App Bundle. - */ - versionCode?: string; - } - export interface Params$Resource$Systemapks$Variants$Get - extends StandardParameters { - /** - * Unique identifier for the Android app; for example, "com.spiffygame". - */ - packageName?: string; - /** - * Unique identifier for this variant. - */ - variantId?: number; - /** - * The version code of the App Bundle. - */ - versionCode?: string; - } - export interface Params$Resource$Systemapks$Variants$List - extends StandardParameters { - /** - * Unique identifier for the Android app; for example, "com.spiffygame". - */ - packageName?: string; - /** - * The version code of the App Bundle. - */ - versionCode?: string; - } }