/androidpublisher/v3/applications/{packageName}/inappproducts

GET

inappproducts

Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field tokenPagination.nextPageToken will be set and the caller should provide its value as a token request parameter to retrieve the next page.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://androidpublisher.googleapis.com//androidpublisher/v3/applications//inappproducts'

Response Example

{
    "inappproduct": [
        {
            "defaultLanguage": "string",
            "defaultPrice": {
                "currency": "string",
                "priceMicros": "string"
            },
            "gracePeriod": "string",
            "listings": {
                "property1": {
                    "benefits": [
                        "string"
                    ],
                    "description": "string",
                    "title": "string"
                },
                "property2": {
                    "benefits": [
                        "string"
                    ],
                    "description": "string",
                    "title": "string"
                }
            },
            "managedProductTaxesAndComplianceSettings": {
                "eeaWithdrawalRightType": "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED",
                "taxRateInfoByRegionCode": {
                    "property1": {
                        "eligibleForStreamingServiceTaxRate": true,
                        "taxTier": "TAX_TIER_UNSPECIFIED"
                    },
                    "property2": {
                        "eligibleForStreamingServiceTaxRate": true,
                        "taxTier": "TAX_TIER_UNSPECIFIED"
                    }
                }
            },
            "packageName": "string",
            "prices": {
                "property1": {
                    "currency": "string",
                    "priceMicros": "string"
                },
                "property2": {
                    "currency": "string",
                    "priceMicros": "string"
                }
            },
            "purchaseType": "purchaseTypeUnspecified",
            "sku": "string",
            "status": "statusUnspecified",
            "subscriptionPeriod": "string",
            "subscriptionTaxesAndComplianceSettings": {
                "eeaWithdrawalRightType": "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED",
                "taxRateInfoByRegionCode": {
                    "property1": {
                        "eligibleForStreamingServiceTaxRate": true,
                        "taxTier": "TAX_TIER_UNSPECIFIED"
                    },
                    "property2": {
                        "eligibleForStreamingServiceTaxRate": true,
                        "taxTier": "TAX_TIER_UNSPECIFIED"
                    }
                }
            },
            "trialPeriod": "string"
        }
    ],
    "kind": "string",
    "pageInfo": {
        "resultPerPage": 0,
        "startIndex": 0,
        "totalResults": 0
    },
    "tokenPagination": {
        "nextPageToken": "string",
        "previousPageToken": "string"
    }
}

Request

Path Params

packageName

string

required

Package name of the app.

Query Params

maxResults

integer

optional

Deprecated and ignored. The page size is determined by the server.

startIndex

integer

optional

Deprecated and ignored. Set the token parameter to rertieve the next page.

token

string

optional

Pagination token. If empty, list starts at the first product.

Responses

🟢200Successful response

application/json

Body

Response listing all in-app products.

inappproduct

array[object (InAppProduct) {13}]

optional

All in-app products.

defaultLanguage

string

optional

Default language of the localized data, as defined by BCP-47. e.g. "en-US".

defaultPrice

object (Price)

optional

Default price. Cannot be zero, as in-app products are never free. Always in the developer's Checkout merchant currency.

gracePeriod

string

optional

Grace period of the subscription, specified in ISO 8601 format. Allows developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values are P0D (zero days), P3D (three days), P7D (seven days), P14D (14 days), and P30D (30 days).

listings

object

optional

List of localized title and description data. Map key is the language of the localized data, as defined by BCP-47, e.g. "en-US".

managedProductTaxesAndComplianceSettings

object (ManagedProductTaxAndComplianceSettings)

optional

Details about taxes and legal compliance. Only applicable to managed products.

packageName

string

optional

Package name of the parent app.

prices

object

optional

Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2.

purchaseType

enum<string>

optional

The type of the product, e.g. a recurring subscription.

Allowed values:

purchaseTypeUnspecifiedmanagedUsersubscription

sku

string

optional

Stock-keeping-unit (SKU) of the product, unique within an app.

status

enum<string>

optional

The status of the product, e.g. whether it's active.

Allowed values:

statusUnspecifiedactiveinactive

subscriptionPeriod

string

optional

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).

subscriptionTaxesAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

optional

Details about taxes and legal compliance. Only applicable to subscription products.

trialPeriod

string

optional

Trial period, specified in ISO 8601 format. Acceptable values are anything between P7D (seven days) and P999D (999 days).

kind

string

optional

The kind of this response ("androidpublisher#inappproductsListResponse").

pageInfo

object (PageInfo)

optional

Deprecated and unset.

resultPerPage

integer <int32>

optional

Maximum number of results returned in one page. ! The number of results included in the API response.

startIndex

integer <int32>

optional

Index of the first result returned in the current page.

totalResults

integer <int32>

optional

Total number of results available on the backend ! The total number of results in the result set.

tokenPagination

object (TokenPagination)

optional

Pagination token, to handle a number of products that is over one page.

nextPageToken

string

optional

Tokens to pass to the standard list field 'page_token'. Whenever available, tokens are preferred over manipulating start_index.

previousPageToken

string

optional

Modified at 2022-09-11 20:51:56

/androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download

/androidpublisher/v3/applications/{packageName}/inappproducts