AI-generated Key Takeaways
-
This API call allows you to delete purchase options for one or multiple one-time products.
-
By default, the operation fails if offers exist under the purchase options, but you can use the
force
parameter to delete associated offers as well. -
The request requires the package name and product ID (or "-" for multiple products), and includes a list of
DeletePurchaseOptionRequest
objects in the request body. -
Each
DeletePurchaseOptionRequest
specifies the package name, product ID, and purchase option ID to be deleted, with optional fields for latency tolerance and force deletion. -
The response body is empty on success and requires the
https://www.googleapis.com/auth/androidpublisher
OAuth scope for authorization.
- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- DeletePurchaseOptionRequest
- Try it!
Deletes purchase options across one or multiple one-time products.
By default this operation will fail if there are any existing offers under the deleted purchase options. Use the force parameter to override the default behavior.
HTTP request
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchDelete
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
packageName |
Required. The parent app (package name) of the purchase options to delete. |
productId |
Required. The product ID of the parent one-time product, if all purchase options to delete belong to the same one-time product. If this batch delete spans multiple one-time products, set this field to "-". |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requests": [
{
object ( |
Fields | |
---|---|
requests[] |
Required. A list of delete requests of up to 100 elements. All requests must delete purchase options from different one-time products. |
Response body
If successful, the response body is an empty JSON object.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidpublisher
DeletePurchaseOptionRequest
Request message for deleting a purchase option.
JSON representation |
---|
{
"packageName": string,
"productId": string,
"purchaseOptionId": string,
"latencyTolerance": enum ( |
Fields | |
---|---|
packageName |
Required. The parent app (package name) of the purchase option to delete. |
productId |
Required. The parent one-time product (ID) of the purchase option to delete. |
purchaseOptionId |
Required. The purchase option ID of the purchase option to delete. |
latencyTolerance |
Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. |
force |
Optional. This field has no effect for purchase options with no offers under them. For purchase options with associated offers: * If |