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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-androidpublisher Show documentation

There is a newer version: v3-rev20241217-2.0.0

Show newest version







AndroidPublisher.Monetization.Subscriptions (Google Play Android Developer API v3-rev20240129-2.0.0)











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



java.lang.Object


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







Enclosing class:
AndroidPublisher.Monetization




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











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
AndroidPublisher.Monetization.Subscriptions.Archive 


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



class 
AndroidPublisher.Monetization.Subscriptions.BatchGet 


class 
AndroidPublisher.Monetization.Subscriptions.BatchUpdate 


class 
AndroidPublisher.Monetization.Subscriptions.Create 


class 
AndroidPublisher.Monetization.Subscriptions.Delete 


class 
AndroidPublisher.Monetization.Subscriptions.Get 


class 
AndroidPublisher.Monetization.Subscriptions.List 


class 
AndroidPublisher.Monetization.Subscriptions.Patch 









Constructor Summary

Constructors 

Constructor and Description


Subscriptions() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AndroidPublisher.Monetization.Subscriptions.Archive
archive(String packageName,
       String productId,
       ArchiveSubscriptionRequest content)
Archives a subscription.



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



AndroidPublisher.Monetization.Subscriptions.BatchGet
batchGet(String packageName)
Reads one or more subscriptions.



AndroidPublisher.Monetization.Subscriptions.BatchUpdate
batchUpdate(String packageName,
           BatchUpdateSubscriptionsRequest content)
Updates a batch of subscriptions.



AndroidPublisher.Monetization.Subscriptions.Create
create(String packageName,
      Subscription content)
Creates a new subscription.



AndroidPublisher.Monetization.Subscriptions.Delete
delete(String packageName,
      String productId)
Deletes a subscription.



AndroidPublisher.Monetization.Subscriptions.Get
get(String packageName,
   String productId)
Reads a single subscription.



AndroidPublisher.Monetization.Subscriptions.List
list(String packageName)
Lists all subscriptions under a given app.



AndroidPublisher.Monetization.Subscriptions.Patch
patch(String packageName,
     String productId,
     Subscription content)
Updates an existing subscription.







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














Constructor Detail





Subscriptions
public Subscriptions()









Method Detail





archive
public AndroidPublisher.Monetization.Subscriptions.Archive archive(String packageName,
                                                                   String productId,
                                                                   ArchiveSubscriptionRequest content)
                                                            throws IOException
Archives a subscription. Can only be done if at least one base plan was active in the past, and
 no base plan is available for new or existing subscribers currently. This action is irreversible,
 and the subscription ID will remain reserved.

 Create a request for the method "subscriptions.archive".

 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 app of the subscription to delete.
productId - Required. The unique product ID of the subscription to delete.
content - the ArchiveSubscriptionRequest
Returns:
the request
Throws:
IOException








batchGet
public AndroidPublisher.Monetization.Subscriptions.BatchGet batchGet(String packageName)
                                                              throws IOException
Reads one or more subscriptions.

 Create a request for the method "subscriptions.batchGet".

 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 retrieved. Must be
        equal to the package_name field on all the requests.
Returns:
the request
Throws:
IOException








batchUpdate
public AndroidPublisher.Monetization.Subscriptions.BatchUpdate batchUpdate(String packageName,
                                                                           BatchUpdateSubscriptionsRequest content)
                                                                    throws IOException
Updates a batch of 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 "subscriptions.batchUpdate".

 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 updated. Must be equal
        to the package_name field on all the Subscription resources.
content - the BatchUpdateSubscriptionsRequest
Returns:
the request
Throws:
IOException








create
public AndroidPublisher.Monetization.Subscriptions.Create create(String packageName,
                                                                 Subscription content)
                                                          throws IOException
Creates a new subscription. Newly added base plans will remain in draft state until activated.

 Create a request for the method "subscriptions.create".

 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 subscription should be created. Must be equal
        to the package_name field on the Subscription resource.
content - the Subscription
Returns:
the request
Throws:
IOException








delete
public AndroidPublisher.Monetization.Subscriptions.Delete delete(String packageName,
                                                                 String productId)
                                                          throws IOException
Deletes a subscription. A subscription can only be deleted if it has never had a base plan
 published.

 Create a request for the method "subscriptions.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 app of the subscription to delete.
productId - Required. The unique product ID of the subscription to delete.
Returns:
the request
Throws:
IOException








get
public AndroidPublisher.Monetization.Subscriptions.Get get(String packageName,
                                                           String productId)
                                                    throws IOException
Reads a single subscription.

 Create a request for the method "subscriptions.get".

 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 subscription to get.
productId - Required. The unique product ID of the subscription to get.
Returns:
the request
Throws:
IOException








list
public AndroidPublisher.Monetization.Subscriptions.List list(String packageName)
                                                      throws IOException
Lists all subscriptions under a given app.

 Create a request for the method "subscriptions.list".

 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 read.
Returns:
the request
Throws:
IOException








patch
public AndroidPublisher.Monetization.Subscriptions.Patch patch(String packageName,
                                                               String productId,
                                                               Subscription content)
                                                        throws IOException
Updates an existing subscription.

 Create a request for the method "subscriptions.patch".

 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 - Immutable. Package name of the parent app.
productId - Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be
        composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must
        start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters
        in length.
content - the Subscription
Returns:
the request
Throws:
IOException








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

 The typical use is:
     AndroidPublisher androidpublisher = new AndroidPublisher(...);
    AndroidPublisher.BasePlans.List request = androidpublisher.basePlans().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.

Modifier and Type	Class and Description
`class`	`AndroidPublisher.Monetization.Subscriptions.Archive`
`class`	`AndroidPublisher.Monetization.Subscriptions.BasePlans` The "basePlans" collection of methods.
`class`	`AndroidPublisher.Monetization.Subscriptions.BatchGet`
`class`	`AndroidPublisher.Monetization.Subscriptions.BatchUpdate`
`class`	`AndroidPublisher.Monetization.Subscriptions.Create`
`class`	`AndroidPublisher.Monetization.Subscriptions.Delete`
`class`	`AndroidPublisher.Monetization.Subscriptions.Get`
`class`	`AndroidPublisher.Monetization.Subscriptions.List`
`class`	`AndroidPublisher.Monetization.Subscriptions.Patch`

Modifier and Type	Method and Description
`AndroidPublisher.Monetization.Subscriptions.Archive`	`archive(String packageName, String productId, ArchiveSubscriptionRequest content)` Archives a subscription.
`AndroidPublisher.Monetization.Subscriptions.BasePlans`	`basePlans()` An accessor for creating requests from the BasePlans collection.
`AndroidPublisher.Monetization.Subscriptions.BatchGet`	`batchGet(String packageName)` Reads one or more subscriptions.
`AndroidPublisher.Monetization.Subscriptions.BatchUpdate`	`batchUpdate(String packageName, BatchUpdateSubscriptionsRequest content)` Updates a batch of subscriptions.
`AndroidPublisher.Monetization.Subscriptions.Create`	`create(String packageName, Subscription content)` Creates a new subscription.
`AndroidPublisher.Monetization.Subscriptions.Delete`	`delete(String packageName, String productId)` Deletes a subscription.
`AndroidPublisher.Monetization.Subscriptions.Get`	`get(String packageName, String productId)` Reads a single subscription.
`AndroidPublisher.Monetization.Subscriptions.List`	`list(String packageName)` Lists all subscriptions under a given app.
`AndroidPublisher.Monetization.Subscriptions.Patch`	`patch(String packageName, String productId, Subscription content)` Updates an existing subscription.