Google Play Android Developer API . inappproducts

Instance Methods

delete(packageName, sku, x__xgafv=None)

Deletes an in-app product (i.e. a managed product or a subscriptions).

get(packageName, sku, x__xgafv=None)

Gets an in-app product, which can be a managed product or a subscription.

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

Creates an in-app product (i.e. a managed product or a subscriptions).

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

Lists all in-app products - both managed products and subscriptions.

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

Patches an in-app product (i.e. a managed product or a subscriptions).

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

Updates an in-app product (i.e. a managed product or a subscriptions).

Method Details

delete(packageName, sku, x__xgafv=None)
Deletes an in-app product (i.e. a managed product or a subscriptions).

Args:
  packageName: string, Package name of the app. (required)
  sku: string, Unique identifier for the in-app product. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(packageName, sku, x__xgafv=None)
Gets an in-app product, which can be a managed product or a subscription.

Args:
  packageName: string, Package name of the app. (required)
  sku: string, Unique identifier for the in-app product. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An in-app product. The resource for InappproductsService.
      "prices": { # 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.
        "a_key": { # Definition of a price, i.e. currency and units.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              # See java/com/google/common/money/CurrencyCode.java
          "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
        },
      },
      "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
      "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
          # Always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            # See java/com/google/common/money/CurrencyCode.java
        "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
          # between P7D (seven days) and P999D (999 days).
      "gracePeriod": "A String", # 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).
      "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
      "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
      "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).
      "listings": { # 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".
        "a_key": { # Store listing of a single in-app product.
          "benefits": [ # Localized entitlement benefits for a subscription.
            "A String",
          ],
          "title": "A String", # Title for the store listing.
          "description": "A String", # Description for the store listing.
        },
      },
      "packageName": "A String", # Package name of the parent app.
      "status": "A String", # The status of the product, e.g. whether it's active.
    }
insert(packageName, body=None, autoConvertMissingPrices=None, x__xgafv=None)
Creates an in-app product (i.e. a managed product or a subscriptions).

Args:
  packageName: string, Package name of the app. (required)
  body: object, The request body.
    The object takes the form of:

{ # An in-app product. The resource for InappproductsService.
    "prices": { # 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.
      "a_key": { # Definition of a price, i.e. currency and units.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            # See java/com/google/common/money/CurrencyCode.java
        "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
      },
    },
    "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
    "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
        # Always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          # See java/com/google/common/money/CurrencyCode.java
      "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
        # between P7D (seven days) and P999D (999 days).
    "gracePeriod": "A String", # 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).
    "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
    "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
    "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).
    "listings": { # 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".
      "a_key": { # Store listing of a single in-app product.
        "benefits": [ # Localized entitlement benefits for a subscription.
          "A String",
        ],
        "title": "A String", # Title for the store listing.
        "description": "A String", # Description for the store listing.
      },
    },
    "packageName": "A String", # Package name of the parent app.
    "status": "A String", # The status of the product, e.g. whether it's active.
  }

  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An in-app product. The resource for InappproductsService.
      "prices": { # 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.
        "a_key": { # Definition of a price, i.e. currency and units.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              # See java/com/google/common/money/CurrencyCode.java
          "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
        },
      },
      "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
      "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
          # Always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            # See java/com/google/common/money/CurrencyCode.java
        "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
          # between P7D (seven days) and P999D (999 days).
      "gracePeriod": "A String", # 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).
      "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
      "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
      "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).
      "listings": { # 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".
        "a_key": { # Store listing of a single in-app product.
          "benefits": [ # Localized entitlement benefits for a subscription.
            "A String",
          ],
          "title": "A String", # Title for the store listing.
          "description": "A String", # Description for the store listing.
        },
      },
      "packageName": "A String", # Package name of the parent app.
      "status": "A String", # The status of the product, e.g. whether it's active.
    }
list(packageName, startIndex=None, token=None, maxResults=None, x__xgafv=None)
Lists all in-app products - both managed products and subscriptions.

Args:
  packageName: string, Package name of the app. (required)
  startIndex: integer, The index of the first element to return.
  token: string, Pagination token. If empty, list starts at the first product.
  maxResults: integer, How many results the list operation should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response listing all in-app products.
    "pageInfo": { # Information about the current page. # Information about the current page.
        #
        # List operations that supports paging return only one "page" of results. This
        # protocol buffer message describes the page that has been returned.
      "resultPerPage": 42, # Maximum number of results returned in one page.
          # ! The number of results included in the API response.
      "startIndex": 42, # Index of the first result returned in the current page.
      "totalResults": 42, # Total number of results available on the backend
          # ! The total number of results in the result set.
    },
    "kind": "A String", # The kind of this response ("androidpublisher#inappproductsListResponse").
    "inappproduct": [ # All in-app products.
      { # An in-app product. The resource for InappproductsService.
          "prices": { # 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.
            "a_key": { # Definition of a price, i.e. currency and units.
              "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                  # See java/com/google/common/money/CurrencyCode.java
              "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
            },
          },
          "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
          "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
              # Always in the developer's Checkout merchant currency.
            "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
                # See java/com/google/common/money/CurrencyCode.java
            "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
          },
          "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
              # between P7D (seven days) and P999D (999 days).
          "gracePeriod": "A String", # 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).
          "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
          "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
          "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).
          "listings": { # 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".
            "a_key": { # Store listing of a single in-app product.
              "benefits": [ # Localized entitlement benefits for a subscription.
                "A String",
              ],
              "title": "A String", # Title for the store listing.
              "description": "A String", # Description for the store listing.
            },
          },
          "packageName": "A String", # Package name of the parent app.
          "status": "A String", # The status of the product, e.g. whether it's active.
        },
    ],
    "tokenPagination": { # Pagination information returned by a List operation when token pagination # Pagination token, to handle a number of products that is over one page.
        # is enabled.
        #
        # List operations that supports paging return only one "page" of results. This
        # protocol buffer message describes the page that has been returned.
        #
        # When using token pagination, clients should use the next/previous token
        # to get another page of the result. The presence or absence of next/previous
        # token indicates whether a next/previous page is available and provides a
        # mean of accessing this page. ListRequest.page_token should be set to either
        # next_page_token or previous_page_token to access another page.
      "previousPageToken": "A String",
      "nextPageToken": "A String", # Tokens to pass to the standard list field 'page_token'. Whenever available,
          # tokens are preferred over manipulating start_index.
    },
  }
patch(packageName, sku, body=None, autoConvertMissingPrices=None, x__xgafv=None)
Patches an in-app product (i.e. a managed product or a subscriptions).

Args:
  packageName: string, Package name of the app. (required)
  sku: string, Unique identifier for the in-app product. (required)
  body: object, The request body.
    The object takes the form of:

{ # An in-app product. The resource for InappproductsService.
    "prices": { # 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.
      "a_key": { # Definition of a price, i.e. currency and units.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            # See java/com/google/common/money/CurrencyCode.java
        "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
      },
    },
    "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
    "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
        # Always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          # See java/com/google/common/money/CurrencyCode.java
      "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
        # between P7D (seven days) and P999D (999 days).
    "gracePeriod": "A String", # 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).
    "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
    "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
    "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).
    "listings": { # 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".
      "a_key": { # Store listing of a single in-app product.
        "benefits": [ # Localized entitlement benefits for a subscription.
          "A String",
        ],
        "title": "A String", # Title for the store listing.
        "description": "A String", # Description for the store listing.
      },
    },
    "packageName": "A String", # Package name of the parent app.
    "status": "A String", # The status of the product, e.g. whether it's active.
  }

  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An in-app product. The resource for InappproductsService.
      "prices": { # 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.
        "a_key": { # Definition of a price, i.e. currency and units.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              # See java/com/google/common/money/CurrencyCode.java
          "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
        },
      },
      "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
      "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
          # Always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            # See java/com/google/common/money/CurrencyCode.java
        "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
          # between P7D (seven days) and P999D (999 days).
      "gracePeriod": "A String", # 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).
      "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
      "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
      "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).
      "listings": { # 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".
        "a_key": { # Store listing of a single in-app product.
          "benefits": [ # Localized entitlement benefits for a subscription.
            "A String",
          ],
          "title": "A String", # Title for the store listing.
          "description": "A String", # Description for the store listing.
        },
      },
      "packageName": "A String", # Package name of the parent app.
      "status": "A String", # The status of the product, e.g. whether it's active.
    }
update(packageName, sku, body=None, autoConvertMissingPrices=None, x__xgafv=None)
Updates an in-app product (i.e. a managed product or a subscriptions).

Args:
  packageName: string, Package name of the app. (required)
  sku: string, Unique identifier for the in-app product. (required)
  body: object, The request body.
    The object takes the form of:

{ # An in-app product. The resource for InappproductsService.
    "prices": { # 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.
      "a_key": { # Definition of a price, i.e. currency and units.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            # See java/com/google/common/money/CurrencyCode.java
        "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
      },
    },
    "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
    "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
        # Always in the developer's Checkout merchant currency.
      "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
          # See java/com/google/common/money/CurrencyCode.java
      "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
    },
    "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
        # between P7D (seven days) and P999D (999 days).
    "gracePeriod": "A String", # 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).
    "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
    "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
    "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).
    "listings": { # 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".
      "a_key": { # Store listing of a single in-app product.
        "benefits": [ # Localized entitlement benefits for a subscription.
          "A String",
        ],
        "title": "A String", # Title for the store listing.
        "description": "A String", # Description for the store listing.
      },
    },
    "packageName": "A String", # Package name of the parent app.
    "status": "A String", # The status of the product, e.g. whether it's active.
  }

  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An in-app product. The resource for InappproductsService.
      "prices": { # 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.
        "a_key": { # Definition of a price, i.e. currency and units.
          "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
              # See java/com/google/common/money/CurrencyCode.java
          "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
        },
      },
      "sku": "A String", # Stock-keeping-unit (SKU) of the product, unique within an app.
      "defaultPrice": { # Definition of a price, i.e. currency and units. # Default price. Cannot be zero, as in-app products are never free.
          # Always in the developer's Checkout merchant currency.
        "currency": "A String", # 3 letter Currency code, as defined by ISO 4217.
            # See java/com/google/common/money/CurrencyCode.java
        "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string.
      },
      "trialPeriod": "A String", # Trial period, specified in ISO 8601 format. Acceptable values are anything
          # between P7D (seven days) and P999D (999 days).
      "gracePeriod": "A String", # 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).
      "purchaseType": "A String", # The type of the product, e.g. a recurring subscription.
      "defaultLanguage": "A String", # Default language of the localized data, as defined by BCP-47. e.g. "en-US".
      "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).
      "listings": { # 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".
        "a_key": { # Store listing of a single in-app product.
          "benefits": [ # Localized entitlement benefits for a subscription.
            "A String",
          ],
          "title": "A String", # Title for the store listing.
          "description": "A String", # Description for the store listing.
        },
      },
      "packageName": "A String", # Package name of the parent app.
      "status": "A String", # The status of the product, e.g. whether it's active.
    }