Method: monetization.onetimeproducts.purchaseOptions.offers.list

  • This page details how to list all offers under a given app, product, or purchase option using an HTTP GET request.

  • The request uses path parameters for the package name, product ID, and purchase option ID to specify the scope of the offers to be listed.

  • Optional query parameters such as pageSize and pageToken are available for controlling the number of results and retrieving subsequent pages.

  • The request body must be empty for this specific API call.

  • The response body contains a list of one-time product offers and an optional nextPageToken for pagination, requiring the https://www.googleapis.com/auth/androidpublisher authorization scope.

Lists all offers under a given app, product, or purchase option.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) for which the offers should be read.
productId

string

Required. The parent one-time product (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.
purchaseOptionId

string

Required. The parent purchase option (ID) for which the offers should be read. May be specified as '-' to read all offers under a one-time product or an app. Must be specified as '-' if productId is specified as '-'.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of offers to return. The service may return fewer than this value. If unspecified, at most 50 offers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous ListOneTimeProductsOffers call. Provide this to retrieve the subsequent page.

When paginating, productId, packageName and purchaseOptionId provided to ListOneTimeProductsOffersRequest must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for offers.list.

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

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

object (OneTimeProductOffer)

The oneTimeProduct offers from the specified request.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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