Google Play Android Developer API (androidpublisher:v3)

2023-12-12

10 new methods | 5 updated methods

Additions

    Methods
  • androidpublisher.inappproducts.batchGet

      Path: androidpublisher/v3/applications/{packageName}/inappproducts:batchGet

      Flat Path: androidpublisher/v3/applications/{packageName}/inappproducts:batchGet

      HTTP Method: GET

      Parameters:

        packageName

          Description: Package name of the app.

          Location: path

          Required: Yes

          Type: string

        sku

          Description: Unique identifier for the in-app products.

          Location: query

          Repeated: Yes

          Type: string

      Parameter Order: packageName

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

      Description: Reads multiple in-app products, which can be managed products or subscriptions. This method should not be used to retrieve subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.

  • androidpublisher.inappproducts.batchUpdate

      Path: androidpublisher/v3/applications/{packageName}/inappproducts:batchUpdate

      Flat Path: androidpublisher/v3/applications/{packageName}/inappproducts:batchUpdate

      HTTP Method: POST

      Parameters:

        packageName

          Description: Package name of the app.

          Location: path

          Required: Yes

          Type: string

      Parameter Order: packageName

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

      Description: Updates or inserts one or more in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should no longer be used to update subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.

  • androidpublisher.inappproducts.batchDelete

      Path: androidpublisher/v3/applications/{packageName}/inappproducts:batchDelete

      Flat Path: androidpublisher/v3/applications/{packageName}/inappproducts:batchDelete

      HTTP Method: POST

      Parameters:

        packageName

          Description: Package name of the app.

          Location: path

          Required: Yes

          Type: string

      Parameter Order: packageName

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

      Description: Deletes in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should not be used to delete subscriptions. See [this article](https://android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-june-2023.html) for more information.

  • androidpublisher.monetization.subscriptions.batchGet

      Path: androidpublisher/v3/applications/{packageName}/subscriptions:batchGet

      Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions:batchGet

      HTTP Method: GET

      Parameters:

        packageName

          Description: Required. The parent app (package name) for which the subscriptions should be retrieved. Must be equal to the package_name field on all the requests.

          Location: path

          Required: Yes

          Type: string

        productIds

          Description: Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different.

          Location: query

          Repeated: Yes

          Type: string

      Parameter Order: packageName

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

      Description: Reads one or more subscriptions.

  • androidpublisher.monetization.subscriptions.batchUpdate

      Path: androidpublisher/v3/applications/{packageName}/subscriptions:batchUpdate

      Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions:batchUpdate

      HTTP Method: POST

      Parameters:

        packageName

          Description: Required. The parent app (package name) for which the subscriptions should be updated. Must be equal to the package_name field on all the Subscription resources.

          Location: path

          Required: Yes

          Type: string

      Parameter Order: packageName

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

      Description: Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

  • androidpublisher.monetization.subscriptions.basePlans.batchUpdateStates

      Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchUpdateStates

      Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchUpdateStates

      HTTP Method: POST

      Parameters:

        packageName

          Description: Required. The parent app (package name) of the updated base plans.

          Location: path

          Required: Yes

          Type: string

        productId

          Description: Required. The product ID of the parent subscription, if all updated base plans belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

    • packageName
    • productId
    • Scopes: https://www.googleapis.com/auth/androidpublisher

      Description: Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

  • androidpublisher.monetization.subscriptions.basePlans.batchMigratePrices

      Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchMigratePrices

      Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchMigratePrices

      HTTP Method: POST

      Parameters:

        packageName

          Description: Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the Subscription resources.

          Location: path

          Required: Yes

          Type: string

        productId

          Description: Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

    • packageName
    • productId
    • Scopes: https://www.googleapis.com/auth/androidpublisher

      Description: Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

  • androidpublisher.monetization.subscriptions.basePlans.offers.batchGet

      Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet

      Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet

      HTTP Method: POST

      Parameters:

        packageName

          Description: Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the requests.

          Location: path

          Required: Yes

          Type: string

        productId

          Description: Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.

          Location: path

          Required: Yes

          Type: string

        basePlanId

          Description: Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans.

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

    • packageName
    • productId
    • basePlanId
    • Scopes: https://www.googleapis.com/auth/androidpublisher

      Description: Reads one or more subscription offers.

  • androidpublisher.monetization.subscriptions.basePlans.offers.batchUpdate

      Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdate

      Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdate

      HTTP Method: POST

      Parameters:

        packageName

          Description: Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.

          Location: path

          Required: Yes

          Type: string

        productId

          Description: Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.

          Location: path

          Required: Yes

          Type: string

        basePlanId

          Description: Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

    • packageName
    • productId
    • basePlanId
    • Scopes: https://www.googleapis.com/auth/androidpublisher

      Description: Updates a batch of subscription offers. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

  • androidpublisher.monetization.subscriptions.basePlans.offers.batchUpdateStates

      Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates

      Flat Path: androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates

      HTTP Method: POST

      Parameters:

        packageName

          Description: Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.

          Location: path

          Required: Yes

          Type: string

        productId

          Description: Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.

          Location: path

          Required: Yes

          Type: string

        basePlanId

          Description: Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

    • packageName
    • productId
    • basePlanId
    • Scopes: https://www.googleapis.com/auth/androidpublisher

      Description: Updates a batch of subscription offer states. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Updates

    Methods
  • androidpublisher.inappproducts.update

      Parameters:

        latencyTolerance

          Description: Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

          Location: query

          Type: string

          Enum Descriptions:

        • Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
        • The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
        • The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
        • Enum:

        • PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT

  • androidpublisher.inappproducts.patch

      Parameters:

        latencyTolerance

          Description: Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

          Location: query

          Type: string

          Enum Descriptions:

        • Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
        • The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
        • The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
        • Enum:

        • PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT

  • androidpublisher.inappproducts.delete

      Parameters:

        latencyTolerance

          Description: Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

          Location: query

          Type: string

          Enum Descriptions:

        • Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
        • The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
        • The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
        • Enum:

        • PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT

  • androidpublisher.monetization.subscriptions.patch

      Parameters:

        allowMissing

          Description: Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored.

          Location: query

          Type: boolean

        latencyTolerance

          Description: Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

          Location: query

          Type: string

          Enum Descriptions:

        • Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
        • The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
        • The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
        • Enum:

        • PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT

  • androidpublisher.monetization.subscriptions.basePlans.offers.patch

      Parameters:

        allowMissing

          Description: Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored.

          Location: query

          Type: boolean

        latencyTolerance

          Description: Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

          Location: query

          Type: string

          Enum Descriptions:

        • Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
        • The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
        • The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
        • Enum:

        • PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE
        • PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT