Google Play Developer API . inappproducts

Instance Methods

delete(packageName=*, sku=*)

Delete an in-app product for an app.

get(packageName=*, sku=*)

Returns information about the in-app product specified.

insert(packageName=*, body=None, autoConvertMissingPrices=None)

Creates a new in-app product for an app.

list(packageName=*, token=None, maxResults=None, startIndex=None)

List all the in-app products for an Android app, both subscriptions and managed in-app products..

patch(packageName=*, sku=*, body=None, autoConvertMissingPrices=None)

Updates the details of an in-app product. This method supports patch semantics.

update(packageName=*, sku=*, body=None, autoConvertMissingPrices=None)

Updates the details of an in-app product.

Method Details

delete(packageName=*, sku=*)
Delete an in-app product for an app.

Args:
  packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required)
  sku: string, Unique identifier for the in-app product. (required)
get(packageName=*, sku=*)
Returns information about the in-app product specified.

Args:
  packageName: string, A parameter (required)
  sku: string, Unique identifier for the in-app product. (required)

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # 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).
      "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }
insert(packageName=*, body=None, autoConvertMissingPrices=None)
Creates a new in-app product for an app.

Args:
  packageName: string, Unique identifier for the Android app; for example, "com.spiffygame". (required)
  body: object, The request body.
    The object takes the form of:

{
    "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
    "status": "A String",
    "subscriptionPeriod": "A String", # 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).
    "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
    "packageName": "A String", # The package name of the parent app.
    "listings": { # List of localized title and description data.
      "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
        "description": "A String",
        "title": "A String",
      },
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
    "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
    "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
    "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
      "a_key": { # Region code, as defined by ISO 3166-2.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    },
    "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
    },
  }

  autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # 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).
      "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }
list(packageName=*, token=None, maxResults=None, startIndex=None)
List all the in-app products for an Android app, both subscriptions and managed in-app products..

Args:
  packageName: string, Unique identifier for the Android app with in-app products; for example, "com.spiffygame". (required)
  token: string, A parameter
  maxResults: integer, A parameter
  startIndex: integer, A parameter

Returns:
  An object of the form:

    {
    "kind": "androidpublisher#inappproductsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse".
    "tokenPagination": {
      "nextPageToken": "A String",
      "previousPageToken": "A String",
    },
    "pageInfo": {
      "totalResults": 42,
      "startIndex": 42,
      "resultPerPage": 42,
    },
    "inappproduct": [
      {
          "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
          "status": "A String",
          "subscriptionPeriod": "A String", # 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).
          "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
          "packageName": "A String", # The package name of the parent app.
          "listings": { # List of localized title and description data.
            "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
              "description": "A String",
              "title": "A String",
            },
          },
          "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
          "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
          "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
          "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
            "a_key": { # Region code, as defined by ISO 3166-2.
              "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
            },
          },
          "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
            "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
          },
        },
    ],
  }
patch(packageName=*, sku=*, body=None, autoConvertMissingPrices=None)
Updates the details of an in-app product. This method supports patch semantics.

Args:
  packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required)
  sku: string, Unique identifier for the in-app product. (required)
  body: object, The request body.
    The object takes the form of:

{
    "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
    "status": "A String",
    "subscriptionPeriod": "A String", # 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).
    "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
    "packageName": "A String", # The package name of the parent app.
    "listings": { # List of localized title and description data.
      "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
        "description": "A String",
        "title": "A String",
      },
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
    "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
    "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
    "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
      "a_key": { # Region code, as defined by ISO 3166-2.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    },
    "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
    },
  }

  autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # 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).
      "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }
update(packageName=*, sku=*, body=None, autoConvertMissingPrices=None)
Updates the details of an in-app product.

Args:
  packageName: string, Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". (required)
  sku: string, Unique identifier for the in-app product. (required)
  body: object, The request body.
    The object takes the form of:

{
    "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
    "status": "A String",
    "subscriptionPeriod": "A String", # 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).
    "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
    "packageName": "A String", # The package name of the parent app.
    "listings": { # List of localized title and description data.
      "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
        "description": "A String",
        "title": "A String",
      },
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
    "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
    "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
    "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
      "a_key": { # Region code, as defined by ISO 3166-2.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    },
    "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
      "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
    },
  }

  autoConvertMissingPrices: boolean, If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

Returns:
  An object of the form:

    {
      "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app.
      "status": "A String",
      "subscriptionPeriod": "A String", # 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).
      "gracePeriod": "A String", # Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days)
      "packageName": "A String", # The package name of the parent app.
      "listings": { # List of localized title and description data.
        "a_key": { # The language of the localized data, as defined by BCP 47. i.e.: "en-US", "en-GB".
          "description": "A String",
          "title": "A String",
        },
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.
      "purchaseType": "A String", # Purchase type enum value. Unmodifiable after creation.
      "defaultLanguage": "A String", # The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB".
      "prices": { # Prices per buyer region. None of these prices should be zero. In-app products can never be free.
        "a_key": { # Region code, as defined by ISO 3166-2.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
        },
      },
      "defaultPrice": { # Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
        "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string.
      },
    }