• Home
• com.google.apis
• google-api-services-androidpublisher
• v3-rev20240129-2.0.0
• source code
• AndroidPublisher.Monetization.Subscriptions.BasePlans.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.androidpublisher.AndroidPublisher.Monetization.Subscriptions.BasePlans.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.androidpublisher
Class AndroidPublisher.Monetization.Subscriptions.BasePlans



java.lang.Object


com.google.api.services.androidpublisher.AndroidPublisher.Monetization.Subscriptions.BasePlans







Enclosing class:
AndroidPublisher.Monetization.Subscriptions




public class AndroidPublisher.Monetization.Subscriptions.BasePlans
extends Object
The "basePlans" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
AndroidPublisher.Monetization.Subscriptions.BasePlans.Activate 


class 
AndroidPublisher.Monetization.Subscriptions.BasePlans.BatchMigratePrices 


class 
AndroidPublisher.Monetization.Subscriptions.BasePlans.BatchUpdateStates 


class 
AndroidPublisher.Monetization.Subscriptions.BasePlans.Deactivate 


class 
AndroidPublisher.Monetization.Subscriptions.BasePlans.Delete 


class 
AndroidPublisher.Monetization.Subscriptions.BasePlans.MigratePrices 


class 
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers
The "offers" collection of methods.










Constructor Summary

Constructors 

Constructor and Description


BasePlans() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AndroidPublisher.Monetization.Subscriptions.BasePlans.Activate
activate(String packageName,
        String productId,
        String basePlanId,
        ActivateBasePlanRequest content)
Activates a base plan.



AndroidPublisher.Monetization.Subscriptions.BasePlans.BatchMigratePrices
batchMigratePrices(String packageName,
                  String productId,
                  BatchMigrateBasePlanPricesRequest content)
Batch variant of the MigrateBasePlanPrices endpoint.



AndroidPublisher.Monetization.Subscriptions.BasePlans.BatchUpdateStates
batchUpdateStates(String packageName,
                 String productId,
                 BatchUpdateBasePlanStatesRequest content)
Activates or deactivates base plans across one or multiple subscriptions.



AndroidPublisher.Monetization.Subscriptions.BasePlans.Deactivate
deactivate(String packageName,
          String productId,
          String basePlanId,
          DeactivateBasePlanRequest content)
Deactivates a base plan.



AndroidPublisher.Monetization.Subscriptions.BasePlans.Delete
delete(String packageName,
      String productId,
      String basePlanId)
Deletes a base plan.



AndroidPublisher.Monetization.Subscriptions.BasePlans.MigratePrices
migratePrices(String packageName,
             String productId,
             String basePlanId,
             MigrateBasePlanPricesRequest content)
Migrates subscribers who are receiving an historical subscription price to the currently-offered
 price for the specified region.



AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers
offers()
An accessor for creating requests from the Offers collection.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





BasePlans
public BasePlans()









Method Detail





activate
public AndroidPublisher.Monetization.Subscriptions.BasePlans.Activate activate(String packageName,
                                                                               String productId,
                                                                               String basePlanId,
                                                                               ActivateBasePlanRequest content)
                                                                        throws IOException
Activates a base plan. Once activated, base plans will be available to new subscribers.

 Create a request for the method "basePlans.activate".

 This request holds the parameters needed by the androidpublisher server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
packageName - Required. The parent app (package name) of the base plan to activate.
productId - Required. The parent subscription (ID) of the base plan to activate.
basePlanId - Required. The unique base plan ID of the base plan to activate.
content - the ActivateBasePlanRequest
Returns:
the request
Throws:
IOException








batchMigratePrices
public AndroidPublisher.Monetization.Subscriptions.BasePlans.BatchMigratePrices batchMigratePrices(String packageName,
                                                                                                   String productId,
                                                                                                   BatchMigrateBasePlanPricesRequest content)
                                                                                            throws IOException
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.

 Create a request for the method "basePlans.batchMigratePrices".

 This request holds the parameters needed by the androidpublisher server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
packageName - 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.
productId - 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.
content - the BatchMigrateBasePlanPricesRequest
Returns:
the request
Throws:
IOException








batchUpdateStates
public AndroidPublisher.Monetization.Subscriptions.BasePlans.BatchUpdateStates batchUpdateStates(String packageName,
                                                                                                 String productId,
                                                                                                 BatchUpdateBasePlanStatesRequest content)
                                                                                          throws IOException
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.

 Create a request for the method "basePlans.batchUpdateStates".

 This request holds the parameters needed by the androidpublisher server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
packageName - Required. The parent app (package name) of the updated base plans.
productId - 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.
content - the BatchUpdateBasePlanStatesRequest
Returns:
the request
Throws:
IOException








deactivate
public AndroidPublisher.Monetization.Subscriptions.BasePlans.Deactivate deactivate(String packageName,
                                                                                   String productId,
                                                                                   String basePlanId,
                                                                                   DeactivateBasePlanRequest content)
                                                                            throws IOException
Deactivates a base plan. Once deactivated, the base plan will become unavailable to new
 subscribers, but existing subscribers will maintain their subscription

 Create a request for the method "basePlans.deactivate".

 This request holds the parameters needed by the androidpublisher server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
packageName - Required. The parent app (package name) of the base plan to deactivate.
productId - Required. The parent subscription (ID) of the base plan to deactivate.
basePlanId - Required. The unique base plan ID of the base plan to deactivate.
content - the DeactivateBasePlanRequest
Returns:
the request
Throws:
IOException








delete
public AndroidPublisher.Monetization.Subscriptions.BasePlans.Delete delete(String packageName,
                                                                           String productId,
                                                                           String basePlanId)
                                                                    throws IOException
Deletes a base plan. Can only be done for draft base plans. This action is irreversible.

 Create a request for the method "basePlans.delete".

 This request holds the parameters needed by the androidpublisher server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
packageName - Required. The parent app (package name) of the base plan to delete.
productId - Required. The parent subscription (ID) of the base plan to delete.
basePlanId - Required. The unique offer ID of the base plan to delete.
Returns:
the request
Throws:
IOException








migratePrices
public AndroidPublisher.Monetization.Subscriptions.BasePlans.MigratePrices migratePrices(String packageName,
                                                                                         String productId,
                                                                                         String basePlanId,
                                                                                         MigrateBasePlanPricesRequest content)
                                                                                  throws IOException
Migrates subscribers who are receiving an historical subscription price to the currently-offered
 price for the specified region. Requests will cause price change notifications to be sent to
 users who are currently receiving an historical price older than the supplied timestamp.
 Subscribers who do not agree to the new price will have their subscription ended at the next
 renewal.

 Create a request for the method "basePlans.migratePrices".

 This request holds the parameters needed by the androidpublisher server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
packageName - Required. Package name of the parent app. Must be equal to the package_name field on the
        Subscription resource.
productId - Required. The ID of the subscription to update. Must be equal to the product_id field on the
        Subscription resource.
basePlanId - Required. The unique base plan ID of the base plan to update prices on.
content - the MigrateBasePlanPricesRequest
Returns:
the request
Throws:
IOException








offers
public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers offers()
An accessor for creating requests from the Offers collection.

 
The typical use is:
 
    AndroidPublisher androidpublisher = new AndroidPublisher(...);
    AndroidPublisher.Offers.List request = androidpublisher.offers().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.