Method: monetization.onetimeproducts.purchaseOptions.offers.batchGet

  • The batchGet endpoint reads one or more one-time product offers using a POST HTTP request.

  • The request requires packageName, productId, and purchaseOptionId as path parameters.

  • The request body contains a list of GetOneTimeProductOfferRequest objects, each specifying the offer to retrieve.

  • The response body contains a list of OneTimeProductOffer objects, corresponding to the requested offers.

  • Authorization requires the https://www.googleapis.com/auth/androidpublisher OAuth scope.

Reads one or more one-time product offers.

HTTP request

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) of the updated offers.

Must be equal to the packageName field on all the updated OneTimeProductOffer resources.
productId

string

Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to "-".
purchaseOptionId

string

Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (GetOneTimeProductOfferRequest)
    }
  ]
}
Fields
requests[]

object (GetOneTimeProductOfferRequest)

Required. A list of get requests of up to 100 elements. All requests must retrieve different offers.

Response body

Response message for the offers.batchGet endpoint.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "oneTimeProductOffers": [
    {
      object (OneTimeProductOffer)
    }
  ]
}
Fields
oneTimeProductOffers[]

object (OneTimeProductOffer)

The list of updated one-time product offers, in the same order as the request.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidpublisher

GetOneTimeProductOfferRequest

Request message for GetOneTimeProductOffers.

JSON representation 
{
  "packageName": string,
  "productId": string,
  "purchaseOptionId": string,
  "offerId": string
}
Fields
packageName

string

Required. The parent app (package name) of the offer to get.
productId

string

Required. The parent one-time product (ID) of the offer to get.
purchaseOptionId

string

Required. The parent purchase option (ID) of the offer to get.
offerId

string

Required. The unique offer ID of the offer to get.