"description":"Selector specifying which fields to include in a partial response.",
"location":"query",
"type":"string"
},
"key":{
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location":"query",
"type":"string"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"quotaUser":{
"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location":"query",
"type":"string"
},
"userIp":{
"description":"Deprecated. Please use quotaUser instead.",
"location":"query",
"type":"string"
}
},
"protocol":"rest",
"resources":{
"edits":{
"methods":{
"commit":{
"description":"Commits/applies the changes made in this edit back to the app.",
"httpMethod":"POST",
"id":"androidpublisher.edits.commit",
"parameterOrder":[
"packageName",
"editId"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"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.",
"httpMethod":"DELETE",
"id":"androidpublisher.edits.delete",
"parameterOrder":[
"packageName",
"editId"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"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).",
"httpMethod":"GET",
"id":"androidpublisher.edits.get",
"parameterOrder":[
"packageName",
"editId"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"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":"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":"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":"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":"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":"Deletes the image (specified by id) from the edit.",
"httpMethod":"DELETE",
"id":"androidpublisher.edits.images.delete",
"parameterOrder":[
"packageName",
"editId",
"language",
"imageType",
"imageId"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"imageId":{
"description":"Unique identifier an image within the set of images attached to this edit.",
"location":"path",
"required":true,
"type":"string"
},
"imageType":{
"enum":[
"featureGraphic",
"icon",
"phoneScreenshots",
"promoGraphic",
"sevenInchScreenshots",
"tenInchScreenshots",
"tvBanner",
"tvScreenshots",
"wearScreenshots"
],
"enumDescriptions":[
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Deletes all images for the specified language and image type.",
"httpMethod":"DELETE",
"id":"androidpublisher.edits.images.deleteall",
"parameterOrder":[
"packageName",
"editId",
"language",
"imageType"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"imageType":{
"enum":[
"featureGraphic",
"icon",
"phoneScreenshots",
"promoGraphic",
"sevenInchScreenshots",
"tenInchScreenshots",
"tvBanner",
"tvScreenshots",
"wearScreenshots"
],
"enumDescriptions":[
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Lists all images for the specified language and image type.",
"httpMethod":"GET",
"id":"androidpublisher.edits.images.list",
"parameterOrder":[
"packageName",
"editId",
"language",
"imageType"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"imageType":{
"enum":[
"featureGraphic",
"icon",
"phoneScreenshots",
"promoGraphic",
"sevenInchScreenshots",
"tenInchScreenshots",
"tvBanner",
"tvScreenshots",
"wearScreenshots"
],
"enumDescriptions":[
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Deletes the specified localized store listing from an edit.",
"httpMethod":"DELETE",
"id":"androidpublisher.edits.listings.delete",
"parameterOrder":[
"packageName",
"editId",
"language"
],
"parameters":{
"editId":{
"description":"Unique identifier for this 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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Fetches information about a localized store listing.",
"httpMethod":"GET",
"id":"androidpublisher.edits.listings.get",
"parameterOrder":[
"packageName",
"editId",
"language"
],
"parameters":{
"editId":{
"description":"Unique identifier for this 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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Creates or updates a localized store listing. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"androidpublisher.edits.listings.patch",
"parameterOrder":[
"packageName",
"editId",
"language"
],
"parameters":{
"editId":{
"description":"Unique identifier for this 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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Creates or updates a localized store listing.",
"httpMethod":"PUT",
"id":"androidpublisher.edits.listings.update",
"parameterOrder":[
"packageName",
"editId",
"language"
],
"parameters":{
"editId":{
"description":"Unique identifier for this 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\".",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"androidpublisher.edits.tracks.patch",
"parameterOrder":[
"packageName",
"editId",
"track"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.",
"httpMethod":"PUT",
"id":"androidpublisher.edits.tracks.update",
"parameterOrder":[
"packageName",
"editId",
"track"
],
"parameters":{
"editId":{
"description":"Unique identifier for this edit.",
"location":"path",
"required":true,
"type":"string"
},
"packageName":{
"description":"Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
"description":"Creates a new in-app product for an app.",
"httpMethod":"POST",
"id":"androidpublisher.inappproducts.insert",
"parameterOrder":[
"packageName"
],
"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.",
"location":"query",
"type":"boolean"
},
"packageName":{
"description":"Unique identifier for the Android app; for example, \"com.spiffygame\".",
"description":"Updates the details of an in-app product. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"androidpublisher.inappproducts.patch",
"parameterOrder":[
"packageName",
"sku"
],
"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.",
"location":"query",
"type":"boolean"
},
"packageName":{
"description":"Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
"location":"path",
"required":true,
"type":"string"
},
"sku":{
"description":"Unique identifier for the in-app product.",
"description":"Updates the details of an in-app product.",
"httpMethod":"PUT",
"id":"androidpublisher.inappproducts.update",
"parameterOrder":[
"packageName",
"sku"
],
"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.",
"location":"query",
"type":"boolean"
},
"packageName":{
"description":"Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
"location":"path",
"required":true,
"type":"string"
},
"sku":{
"description":"Unique identifier for the in-app product.",
"description":"Refund a user's subscription or in-app purchase order.",
"httpMethod":"POST",
"id":"androidpublisher.orders.refund",
"parameterOrder":[
"packageName",
"orderId"
],
"parameters":{
"orderId":{
"description":"The order ID provided to the user when the subscription or in-app order was purchased.",
"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').",
"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":"Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.",
"description":"The time, in milliseconds since the Epoch, of the newest voided in-app product 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.",
"format":"int64",
"location":"query",
"type":"string"
},
"maxResults":{
"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').",
"location":"path",
"required":true,
"type":"string"
},
"startIndex":{
"format":"uint32",
"location":"query",
"type":"integer"
},
"startTime":{
"description":"The time, in milliseconds since the Epoch, of the oldest voided in-app product 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":"Information about the binary payload of this APK."
},
"versionCode":{
"description":"The version code of the APK, as specified in the APK's manifest file.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"ApkBinary":{
"description":"Represents the binary payload of an APK.",
"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.",
"type":"string"
},
"sha256":{
"description":"A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command.",
"type":"string"
}
},
"type":"object"
},
"ApksAddExternallyHostedRequest":{
"id":"ApksAddExternallyHostedRequest",
"properties":{
"externallyHostedApk":{
"$ref":"ExternallyHostedApk",
"description":"The definition of the externally-hosted APK and where it is located."
}
},
"type":"object"
},
"ApksAddExternallyHostedResponse":{
"id":"ApksAddExternallyHostedResponse",
"properties":{
"externallyHostedApk":{
"$ref":"ExternallyHostedApk",
"description":"The definition of the externally-hosted APK and where it is located."
}
},
"type":"object"
},
"ApksListResponse":{
"id":"ApksListResponse",
"properties":{
"apks":{
"items":{
"$ref":"Apk"
},
"type":"array"
},
"kind":{
"default":"androidpublisher#apksListResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apksListResponse\".",
"type":"string"
}
},
"type":"object"
},
"AppDetails":{
"id":"AppDetails",
"properties":{
"contactEmail":{
"description":"The user-visible support email for this app.",
"type":"string"
},
"contactPhone":{
"description":"The user-visible support telephone number for this app.",
"type":"string"
},
"contactWebsite":{
"description":"The user-visible website for this app.",
"type":"string"
},
"defaultLanguage":{
"description":"Default language code, in BCP 47 format (eg \"en-US\").",
"type":"string"
}
},
"type":"object"
},
"AppEdit":{
"description":"Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.",
"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).",
"type":"string"
},
"id":{
"description":"The ID of the edit that can be used in subsequent API calls.",
"type":"string"
}
},
"type":"object"
},
"Bundle":{
"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.",
"type":"string"
},
"sha256":{
"description":"A sha256 hash of the upload payload, encoded as a hex string and matching the 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.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"BundlesListResponse":{
"id":"BundlesListResponse",
"properties":{
"bundles":{
"items":{
"$ref":"Bundle"
},
"type":"array"
},
"kind":{
"default":"androidpublisher#bundlesListResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#bundlesListResponse\".",
"type":"string"
}
},
"type":"object"
},
"Comment":{
"id":"Comment",
"properties":{
"developerComment":{
"$ref":"DeveloperComment",
"description":"A comment from a developer."
},
"userComment":{
"$ref":"UserComment",
"description":"A comment from a user."
}
},
"type":"object"
},
"DeobfuscationFile":{
"description":"Represents a deobfuscation file.",
"id":"DeobfuscationFile",
"properties":{
"symbolType":{
"description":"The type of the deobfuscation file.",
"type":"string"
}
},
"type":"object"
},
"DeobfuscationFilesUploadResponse":{
"id":"DeobfuscationFilesUploadResponse",
"properties":{
"deobfuscationFile":{
"$ref":"DeobfuscationFile"
}
},
"type":"object"
},
"DeveloperComment":{
"id":"DeveloperComment",
"properties":{
"lastModified":{
"$ref":"Timestamp",
"description":"The last time at which this comment was updated."
},
"text":{
"description":"The content of the comment, i.e. reply body.",
"type":"string"
}
},
"type":"object"
},
"DeviceMetadata":{
"id":"DeviceMetadata",
"properties":{
"cpuMake":{
"description":"Device CPU make e.g. \"Qualcomm\"",
"type":"string"
},
"cpuModel":{
"description":"Device CPU model e.g. \"MSM8974\"",
"description":"Comma separated list of native platforms (e.g. \"arm\", \"arm7\")",
"type":"string"
},
"productName":{
"description":"Device model name (e.g. Droid)",
"type":"string"
},
"ramMb":{
"description":"Device RAM in Megabytes e.g. \"2048\"",
"format":"int32",
"type":"integer"
},
"screenDensityDpi":{
"description":"Screen density in DPI",
"format":"int32",
"type":"integer"
},
"screenHeightPx":{
"description":"Screen height in pixels",
"format":"int32",
"type":"integer"
},
"screenWidthPx":{
"description":"Screen width in pixels",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"ExpansionFile":{
"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.",
"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.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"ExpansionFilesUploadResponse":{
"id":"ExpansionFilesUploadResponse",
"properties":{
"expansionFile":{
"$ref":"ExpansionFile"
}
},
"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",
"id":"ExternallyHostedApk",
"properties":{
"applicationLabel":{
"description":"The application label.",
"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.",
"items":{
"type":"string"
},
"type":"array"
},
"externallyHostedUrl":{
"description":"The URL at which the APK is hosted. This must be an https URL.",
"type":"string"
},
"fileSha1Base64":{
"description":"The SHA1 checksum of this APK, represented as a base64 encoded byte array.",
"type":"string"
},
"fileSha256Base64":{
"description":"The SHA256 checksum of this APK, represented as a base64 encoded byte array.",
"type":"string"
},
"fileSize":{
"description":"The file size in bytes of this APK.",
"format":"int64",
"type":"string"
},
"iconBase64":{
"description":"The icon image from the APK, as a base64 encoded byte array.",
"type":"string"
},
"maximumSdk":{
"description":"The maximum SDK supported by this APK (optional).",
"format":"int32",
"type":"integer"
},
"minimumSdk":{
"description":"The minimum SDK targeted by this APK.",
"format":"int32",
"type":"integer"
},
"nativeCodes":{
"description":"The native code environments supported by this APK (optional).",
"items":{
"type":"string"
},
"type":"array"
},
"packageName":{
"description":"The package name.",
"type":"string"
},
"usesFeatures":{
"description":"The features required by this APK (optional).",
"items":{
"type":"string"
},
"type":"array"
},
"usesPermissions":{
"description":"The permissions requested by this APK.",
"items":{
"$ref":"ExternallyHostedApkUsesPermission"
},
"type":"array"
},
"versionCode":{
"description":"The version code of this APK.",
"format":"int32",
"type":"integer"
},
"versionName":{
"description":"The version name of this APK.",
"type":"string"
}
},
"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":{
"id":"Image",
"properties":{
"id":{
"description":"A unique id representing this image.",
"type":"string"
},
"sha1":{
"description":"A sha1 hash of the image that was uploaded.",
"type":"string"
},
"url":{
"description":"A URL that will serve a preview of the image.",
"type":"string"
}
},
"type":"object"
},
"ImagesDeleteAllResponse":{
"id":"ImagesDeleteAllResponse",
"properties":{
"deleted":{
"items":{
"$ref":"Image"
},
"type":"array"
}
},
"type":"object"
},
"ImagesListResponse":{
"id":"ImagesListResponse",
"properties":{
"images":{
"items":{
"$ref":"Image"
},
"type":"array"
}
},
"type":"object"
},
"ImagesUploadResponse":{
"id":"ImagesUploadResponse",
"properties":{
"image":{
"$ref":"Image"
}
},
"type":"object"
},
"InAppProduct":{
"id":"InAppProduct",
"properties":{
"defaultLanguage":{
"description":"The default language of the localized data, as defined by BCP 47. e.g. \"en-US\", \"en-GB\".",
"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."
},
"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) and \"P7D\" (seven 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\"."
},
"description":"List of localized title and description data.",
"type":"object"
},
"packageName":{
"description":"The package name of the parent app.",
"type":"string"
},
"prices":{
"additionalProperties":{
"$ref":"Price",
"description":"Region code, as defined by ISO 3166-2."
},
"description":"Prices per buyer region. None of these prices should be zero. In-app products can never be free.",
"type":"object"
},
"purchaseType":{
"description":"Purchase type enum value. Unmodifiable after creation.",
"type":"string"
},
"season":{
"$ref":"Season",
"description":"Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions."
},
"sku":{
"description":"The stock-keeping-unit (SKU) of the product, unique within an app.",
"type":"string"
},
"status":{
"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).",
"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":"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":"Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price."
},
"start":{
"$ref":"MonthDay",
"description":"Defines the first day on which the price takes effect."
}
},
"type":"object"
},
"Review":{
"id":"Review",
"properties":{
"authorName":{
"description":"The name of the user who wrote the review.",
"type":"string"
},
"comments":{
"description":"A repeated field containing comments for the review.",
"items":{
"$ref":"Comment"
},
"type":"array"
},
"reviewId":{
"description":"Unique identifier for this review.",
"type":"string"
}
},
"type":"object"
},
"ReviewReplyResult":{
"id":"ReviewReplyResult",
"properties":{
"lastEdited":{
"$ref":"Timestamp",
"description":"The time at which the reply took effect."
},
"replyText":{
"description":"The reply text that was applied.",
"type":"string"
}
},
"type":"object"
},
"ReviewsListResponse":{
"id":"ReviewsListResponse",
"properties":{
"pageInfo":{
"$ref":"PageInfo"
},
"reviews":{
"items":{
"$ref":"Review"
},
"type":"array"
},
"tokenPagination":{
"$ref":"TokenPagination"
}
},
"type":"object"
},
"ReviewsReplyRequest":{
"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.",
"type":"string"
}
},
"type":"object"
},
"ReviewsReplyResponse":{
"id":"ReviewsReplyResponse",
"properties":{
"result":{
"$ref":"ReviewReplyResult"
}
},
"type":"object"
},
"Season":{
"id":"Season",
"properties":{
"end":{
"$ref":"MonthDay",
"description":"Inclusive end date of the recurrence period."
},
"prorations":{
"description":"Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.",
"items":{
"$ref":"Prorate"
},
"type":"array"
},
"start":{
"$ref":"MonthDay",
"description":"Inclusive start date of the recurrence period."
}
},
"type":"object"
},
"SubscriptionCancelSurveyResult":{
"description":"Information provided by the user when they complete the subscription cancellation 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",
"format":"int32",
"type":"integer"
},
"userInputCancelReason":{
"description":"The customized input cancel reason from the user. Only present when cancelReason is 0.",
"type":"string"
}
},
"type":"object"
},
"SubscriptionDeferralInfo":{
"description":"A SubscriptionDeferralInfo contains the data needed to defer a subscription 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.",
"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":"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.",
"id":"SubscriptionPriceChange",
"properties":{
"newPrice":{
"$ref":"Price",
"description":"The new price the subscription will renew with if the price change is accepted 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":"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":"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",
"format":"int32",
"type":"integer"
},
"cancelSurveyResult":{
"$ref":"SubscriptionCancelSurveyResult",
"description":"Information provided by the user when they complete the subscription cancellation 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.",
"type":"string"
},
"developerPayload":{
"description":"A developer-specified string that contains supplemental information 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'.",
"type":"string"
},
"expiryTimeMillis":{
"description":"Time at which the subscription will expire, in milliseconds since the Epoch.",
"format":"int64",
"type":"string"
},
"familyName":{
"description":"The family name of the user when the subscription was purchased. Only 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":"This kind represents a subscriptionPurchase object in the androidpublisher service.",
"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.",
"type":"string"
},
"orderId":{
"description":"The order id of the latest recurring order associated with the purchase of the subscription.",
"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":"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":"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":"ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\".",
"type":"string"
},
"profileId":{
"description":"The profile id of the user when the subscription was purchased. Only 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'.",
"type":"string"
},
"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)",
"format":"int32",
"type":"integer"
},
"startTimeMillis":{
"description":"Time at which the subscription was granted, in milliseconds since 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.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"SubscriptionPurchasesDeferRequest":{
"id":"SubscriptionPurchasesDeferRequest",
"properties":{
"deferralInfo":{
"$ref":"SubscriptionDeferralInfo",
"description":"The information about the new desired expiry time for the subscription."
}
},
"type":"object"
},
"SubscriptionPurchasesDeferResponse":{
"id":"SubscriptionPurchasesDeferResponse",
"properties":{
"newExpiryTimeMillis":{
"description":"The new expiry time for the subscription in milliseconds since the Epoch.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"Testers":{
"id":"Testers",
"properties":{
"googleGroups":{
"items":{
"type":"string"
},
"type":"array"
},
"googlePlusCommunities":{
"items":{
"type":"string"
},
"type":"array"
}
},
"type":"object"
},
"Timestamp":{
"id":"Timestamp",
"properties":{
"nanos":{
"format":"int32",
"type":"integer"
},
"seconds":{
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"TokenPagination":{
"id":"TokenPagination",
"properties":{
"nextPageToken":{
"type":"string"
},
"previousPageToken":{
"type":"string"
}
},
"type":"object"
},
"Track":{
"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.",
"items":{
"$ref":"TrackRelease"
},
"type":"array"
},
"track":{
"description":"Identifier for this track.",
"type":"string"
}
},
"type":"object"
},
"TrackRelease":{
"id":"TrackRelease",
"properties":{
"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.",
"type":"string"
},
"releaseNotes":{
"description":"The description of what is new in the app in this release.",
"items":{
"$ref":"LocalizedText"
},
"type":"array"
},
"status":{
"description":"The desired status of this release.",
"type":"string"
},
"userFraction":{
"description":"Fraction of users who are eligible to receive the release. 0 \u003c fraction \u003c 1. To be set, release status must be \"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"
},
"TracksListResponse":{
"id":"TracksListResponse",
"properties":{
"kind":{
"default":"androidpublisher#tracksListResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#tracksListResponse\".",
"type":"string"
},
"tracks":{
"items":{
"$ref":"Track"
},
"type":"array"
}
},
"type":"object"
},
"UserComment":{
"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.",
"format":"int32",
"type":"integer"
},
"appVersionCode":{
"description":"Integer version code of the app as installed at the time the review 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.",
"type":"string"
},
"device":{
"description":"Codename for the reviewer's device, e.g. klte, flounder. May be absent.",
"type":"string"
},
"deviceMetadata":{
"$ref":"DeviceMetadata",
"description":"Some 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.",
"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.",
"type":"string"
},
"starRating":{
"description":"The star rating associated with the review, from 1 to 5.",
"format":"int32",
"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.",
"type":"string"
},
"thumbsDownCount":{
"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",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"VoidedPurchase":{
"description":"A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.",
"id":"VoidedPurchase",
"properties":{
"kind":{
"default":"androidpublisher#voidedPurchase",
"description":"This kind represents a voided purchase object in the androidpublisher service.",
"type":"string"
},
"purchaseTimeMillis":{
"description":"The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).",
"format":"int64",
"type":"string"
},
"purchaseToken":{
"description":"The token that was generated when a purchase was made. This uniquely identifies a purchase.",
"type":"string"
},
"voidedTimeMillis":{
"description":"The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).",
