com.google.api.services.androidpublisher

Class AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers

java.lang.Object

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

Enclosing class:

AndroidPublisher.Monetization.Subscriptions.BasePlans

public class AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers
extends Object

The "offers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Activate
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchGet
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchUpdate
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchUpdateStates
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Create
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Deactivate
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Delete
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Get
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List
class	AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Patch

Constructor Summary

Constructors

Constructor and Description
Offers()

Method Summary

Modifier and Type	Method and Description
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Activate	activate(String packageName, String productId, String basePlanId, String offerId, ActivateSubscriptionOfferRequest content) Activates a subscription offer.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchGet	batchGet(String packageName, String productId, String basePlanId, BatchGetSubscriptionOffersRequest content) Reads one or more subscription offers.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchUpdate	batchUpdate(String packageName, String productId, String basePlanId, BatchUpdateSubscriptionOffersRequest content) Updates a batch of subscription offers.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchUpdateStates	batchUpdateStates(String packageName, String productId, String basePlanId, BatchUpdateSubscriptionOfferStatesRequest content) Updates a batch of subscription offer states.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Create	create(String packageName, String productId, String basePlanId, SubscriptionOffer content) Creates a new subscription offer.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Deactivate	deactivate(String packageName, String productId, String basePlanId, String offerId, DeactivateSubscriptionOfferRequest content) Deactivates a subscription offer.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Delete	delete(String packageName, String productId, String basePlanId, String offerId) Deletes a subscription offer.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Get	get(String packageName, String productId, String basePlanId, String offerId) Reads a single offer Create a request for the method "offers.get".
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	list(String packageName, String productId, String basePlanId) Lists all offers under a given subscription.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Patch	patch(String packageName, String productId, String basePlanId, String offerId, SubscriptionOffer content) Updates an existing subscription offer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Offers

public Offers()

Method Detail

activate

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Activate activate(String packageName,
                                                                                      String productId,
                                                                                      String basePlanId,
                                                                                      String offerId,
                                                                                      ActivateSubscriptionOfferRequest content)
                                                                               throws IOException

Activates a subscription offer. Once activated, subscription offers will be available to new subscribers. Create a request for the method "offers.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 offer to activate.

productId - Required. The parent subscription (ID) of the offer to activate.

basePlanId - Required. The parent base plan (ID) of the offer to activate.

offerId - Required. The unique offer ID of the offer to activate.

content - the ActivateSubscriptionOfferRequest

Returns:

the request

Throws:

IOException

batchGet

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchGet batchGet(String packageName,
                                                                                      String productId,
                                                                                      String basePlanId,
                                                                                      BatchGetSubscriptionOffersRequest content)
                                                                               throws IOException

Reads one or more subscription offers. Create a request for the method "offers.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 created or updated. Must be equal to the package_name field on all the requests.

productId - 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.

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

content - the BatchGetSubscriptionOffersRequest

Returns:

the request

Throws:

IOException

batchUpdate

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchUpdate batchUpdate(String packageName,
                                                                                            String productId,
                                                                                            String basePlanId,
                                                                                            BatchUpdateSubscriptionOffersRequest content)
                                                                                     throws IOException

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. Create a request for the method "offers.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) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.

productId - 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.

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

content - the BatchUpdateSubscriptionOffersRequest

Returns:

the request

Throws:

IOException

batchUpdateStates

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.BatchUpdateStates batchUpdateStates(String packageName,
                                                                                                        String productId,
                                                                                                        String basePlanId,
                                                                                                        BatchUpdateSubscriptionOfferStatesRequest content)
                                                                                                 throws IOException

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. Create a request for the method "offers.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 subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.

productId - 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.

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

content - the BatchUpdateSubscriptionOfferStatesRequest

Returns:

the request

Throws:

IOException

create

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Create create(String packageName,
                                                                                  String productId,
                                                                                  String basePlanId,
                                                                                  SubscriptionOffer content)
                                                                           throws IOException

Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated. Create a request for the method "offers.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 offer should be created. Must be equal to the package_name field on the Subscription resource.

productId - Required. The parent subscription (ID) for which the offer should be created. Must be equal to the product_id field on the SubscriptionOffer resource.

basePlanId - Required. The parent base plan (ID) for which the offer should be created. Must be equal to the base_plan_id field on the SubscriptionOffer resource.

content - the SubscriptionOffer

Returns:

the request

Throws:

IOException

deactivate

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Deactivate deactivate(String packageName,
                                                                                          String productId,
                                                                                          String basePlanId,
                                                                                          String offerId,
                                                                                          DeactivateSubscriptionOfferRequest content)
                                                                                   throws IOException

Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers. Create a request for the method "offers.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 offer to deactivate.

productId - Required. The parent subscription (ID) of the offer to deactivate.

basePlanId - Required. The parent base plan (ID) of the offer to deactivate.

offerId - Required. The unique offer ID of the offer to deactivate.

content - the DeactivateSubscriptionOfferRequest

Returns:

the request

Throws:

IOException

delete

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Delete delete(String packageName,
                                                                                  String productId,
                                                                                  String basePlanId,
                                                                                  String offerId)
                                                                           throws IOException

Deletes a subscription offer. Can only be done for draft offers. This action is irreversible. Create a request for the method "offers.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 offer to delete.

productId - Required. The parent subscription (ID) of the offer to delete.

basePlanId - Required. The parent base plan (ID) of the offer to delete.

offerId - Required. The unique offer ID of the offer to delete.

Returns:

the request

Throws:

IOException

get

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Get get(String packageName,
                                                                            String productId,
                                                                            String basePlanId,
                                                                            String offerId)
                                                                     throws IOException

Reads a single offer Create a request for the method "offers.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 offer to get.

productId - Required. The parent subscription (ID) of the offer to get.

basePlanId - Required. The parent base plan (ID) of the offer to get.

offerId - Required. The unique offer ID of the offer to get.

Returns:

the request

Throws:

IOException

list

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List list(String packageName,
                                                                              String productId,
                                                                              String basePlanId)
                                                                       throws IOException

Lists all offers under a given subscription. Create a request for the method "offers.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.

productId - Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.

basePlanId - Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'.

Returns:

the request

Throws:

IOException

patch

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.Patch patch(String packageName,
                                                                                String productId,
                                                                                String basePlanId,
                                                                                String offerId,
                                                                                SubscriptionOffer content)
                                                                         throws IOException

Updates an existing subscription offer. Create a request for the method "offers.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 - Required. Immutable. The package name of the app the parent subscription belongs to.

productId - Required. Immutable. The ID of the parent subscription this offer belongs to.

basePlanId - Required. Immutable. The ID of the base plan to which this offer is an extension.

offerId - Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.

content - the SubscriptionOffer

Returns:

the request

Throws:

IOException