API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. Edits
  2. Edits.apklistings
  3. Edits.apks
  4. Edits.deobfuscationfiles
  5. Edits.details
  6. Edits.expansionfiles
  7. Edits.images
  8. Edits.listings
  9. Edits.testers
  10. Edits.tracks
  11. Entitlements
  12. Inappproducts
  13. Purchases.products
  14. Purchases.subscriptions
  15. Reviews

Edits

For Edits Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
commit POST  /packageName/edits/editId:commit Commits/applies the changes made in this edit back to the app.
delete DELETE  /packageName/edits/editId 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.
get GET  /packageName/edits/editId Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).
insert POST  /packageName/edits Creates a new edit for an app, populated with the app's current state.
validate POST  /packageName/edits/editId:validate Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.

Edits.apklistings

For Edits.apklistings Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
delete DELETE  /packageName/edits/editId/apks/apkVersionCode/listings/language Deletes the APK-specific localized listing for a specified APK and language code.
deleteall DELETE  /packageName/edits/editId/apks/apkVersionCode/listings Deletes all the APK-specific localized listings for a specified APK.
get GET  /packageName/edits/editId/apks/apkVersionCode/listings/language Fetches the APK-specific localized listing for a specified APK and language code.
list GET  /packageName/edits/editId/apks/apkVersionCode/listings Lists all the APK-specific localized listings for a specified APK.
patch PATCH  /packageName/edits/editId/apks/apkVersionCode/listings/language Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.
update PUT  /packageName/edits/editId/apks/apkVersionCode/listings/language Updates or creates the APK-specific localized listing for a specified APK and language code.

Edits.apks

For Edits.apks Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
addexternallyhosted POST  /packageName/edits/editId/apks/externallyHosted 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.
list GET  /packageName/edits/editId/apks Lists all current APKs for the specified package and edit.
upload POST
https://www.googleapis.com/upload/androidpublisher/v2/applications/packageName/edits/editId/apks

Edits.deobfuscationfiles

For Edits.deobfuscationfiles Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
upload POST
https://www.googleapis.com/upload/androidpublisher/v2/applications/packageName/edits/editId/apks/apkVersionCode/deobfuscationFiles/deobfuscationFileType
Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.

Edits.details

For Edits.details Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
get GET  /packageName/edits/editId/details Fetches app details for this edit. This includes the default language and developer support contact information.
patch PATCH  /packageName/edits/editId/details Updates app details for this edit. This method supports patch semantics.
update PUT  /packageName/edits/editId/details Updates app details for this edit.

Edits.expansionfiles

For Edits.expansionfiles Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
get GET  /packageName/edits/editId/apks/apkVersionCode/expansionFiles/expansionFileType Fetches the Expansion File configuration for the APK specified.
patch PATCH  /packageName/edits/editId/apks/apkVersionCode/expansionFiles/expansionFileType 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.
update PUT  /packageName/edits/editId/apks/apkVersionCode/expansionFiles/expansionFileType Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.
upload POST
https://www.googleapis.com/upload/androidpublisher/v2/applications/packageName/edits/editId/apks/apkVersionCode/expansionFiles/expansionFileType
Uploads and attaches a new Expansion File to the APK specified.

Edits.images

For Edits.images Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
delete DELETE  /packageName/edits/editId/listings/language/imageType/imageId Deletes the image (specified by id) from the edit.
deleteall DELETE  /packageName/edits/editId/listings/language/imageType Deletes all images for the specified language and image type.
list GET  /packageName/edits/editId/listings/language/imageType Lists all images for the specified language and image type.
upload POST
https://www.googleapis.com/upload/androidpublisher/v2/applications/packageName/edits/editId/listings/language/imageType
Uploads a new image and adds it to the list of images for the specified language and image type.

Edits.listings

For Edits.listings Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
delete DELETE  /packageName/edits/editId/listings/language Deletes the specified localized store listing from an edit.
deleteall DELETE  /packageName/edits/editId/listings Deletes all localized listings from an edit.
get GET  /packageName/edits/editId/listings/language Fetches information about a localized store listing.
list GET  /packageName/edits/editId/listings Returns all of the localized store listings attached to this edit.
patch PATCH  /packageName/edits/editId/listings/language Creates or updates a localized store listing. This method supports patch semantics.
update PUT  /packageName/edits/editId/listings/language Creates or updates a localized store listing.

Edits.testers

For Edits.testers Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
get GET  /packageName/edits/editId/testers/track
patch PATCH  /packageName/edits/editId/testers/track
update PUT  /packageName/edits/editId/testers/track

Edits.tracks

For Edits.tracks Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
get GET  /packageName/edits/editId/tracks/track Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.
list GET  /packageName/edits/editId/tracks Lists all the track configurations for this edit.
patch PATCH  /packageName/edits/editId/tracks/track 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.
update PUT  /packageName/edits/editId/tracks/track 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.

Entitlements

For Entitlements Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
list GET  /packageName/entitlements Lists the user's current inapp item or subscription entitlements

Inappproducts

For Inappproducts Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
batch POST  /inappproducts/batch
delete DELETE  /packageName/inappproducts/sku Delete an in-app product for an app.
get GET  /packageName/inappproducts/sku Returns information about the in-app product specified.
insert POST  /packageName/inappproducts Creates a new in-app product for an app.
list GET  /packageName/inappproducts List all the in-app products for an Android app, both subscriptions and managed in-app products..
patch PATCH  /packageName/inappproducts/sku Updates the details of an in-app product. This method supports patch semantics.
update PUT  /packageName/inappproducts/sku Updates the details of an in-app product.

Purchases.products

For Purchases.products Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
get GET  /packageName/purchases/products/productId/tokens/token Checks the purchase and consumption status of an inapp item.

Purchases.subscriptions

For Purchases.subscriptions Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
cancel POST  /packageName/purchases/subscriptions/subscriptionId/tokens/token:cancel Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
defer POST  /packageName/purchases/subscriptions/subscriptionId/tokens/token:defer Defers a user's subscription purchase until a specified future expiration time.
get GET  /packageName/purchases/subscriptions/subscriptionId/tokens/token Checks whether a user's subscription purchase is valid and returns its expiry time.
refund POST  /packageName/purchases/subscriptions/subscriptionId/tokens/token:refund Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.
revoke POST  /packageName/purchases/subscriptions/subscriptionId/tokens/token:revoke Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.

Reviews

For Reviews Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/androidpublisher/v2/applications, unless otherwise noted
get GET  /packageName/reviews/reviewId Returns a single review.
list GET  /packageName/reviews Returns a list of reviews.
reply POST  /packageName/reviews/reviewId:reply Reply to a single review, or update an existing reply.