Class MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource

The "offers" collection of methods.

Inheritance

object

MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.AndroidPublisher.v3

Assembly: Google.Apis.AndroidPublisher.v3.dll

Syntax

public class MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource

Constructors

OffersResource(IClientService)

Constructs a new resource.

Declaration

public OffersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Activate(ActivateSubscriptionOfferRequest, string, string, string, string)

Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.ActivateRequest Activate(ActivateSubscriptionOfferRequest body, string packageName, string productId, string basePlanId, string offerId)

Parameters

Type	Name	Description
ActivateSubscriptionOfferRequest	body	The body of the request.
string	packageName	Required. The parent app (package name) of the offer to activate.
string	productId	Required. The parent subscription (ID) of the offer to activate.
string	basePlanId	Required. The parent base plan (ID) of the offer to activate.
string	offerId	Required. The unique offer ID of the offer to activate.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.ActivateRequest

BatchGet(BatchGetSubscriptionOffersRequest, string, string, string)

Reads one or more subscription offers.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.BatchGetRequest BatchGet(BatchGetSubscriptionOffersRequest body, string packageName, string productId, string basePlanId)

Parameters

Type	Name	Description
BatchGetSubscriptionOffersRequest	body	The body of the request.
string	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.
string	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.
string	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.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.BatchGetRequest

BatchUpdate(BatchUpdateSubscriptionOffersRequest, string, string, string)

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.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.BatchUpdateRequest BatchUpdate(BatchUpdateSubscriptionOffersRequest body, string packageName, string productId, string basePlanId)

Parameters

Type	Name	Description
BatchUpdateSubscriptionOffersRequest	body	The body of the request.
string	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.
string	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.
string	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.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.BatchUpdateRequest

BatchUpdateStates(BatchUpdateSubscriptionOfferStatesRequest, string, string, string)

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.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.BatchUpdateStatesRequest BatchUpdateStates(BatchUpdateSubscriptionOfferStatesRequest body, string packageName, string productId, string basePlanId)

Parameters

Type	Name	Description
BatchUpdateSubscriptionOfferStatesRequest	body	The body of the request.
string	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.
string	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.
string	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.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.BatchUpdateStatesRequest

Create(SubscriptionOffer, string, string, string)

Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.CreateRequest Create(SubscriptionOffer body, string packageName, string productId, string basePlanId)

Parameters

Type	Name	Description
SubscriptionOffer	body	The body of the request.
string	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.
string	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.
string	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.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.CreateRequest

Deactivate(DeactivateSubscriptionOfferRequest, string, string, string, string)

Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.DeactivateRequest Deactivate(DeactivateSubscriptionOfferRequest body, string packageName, string productId, string basePlanId, string offerId)

Parameters

Type	Name	Description
DeactivateSubscriptionOfferRequest	body	The body of the request.
string	packageName	Required. The parent app (package name) of the offer to deactivate.
string	productId	Required. The parent subscription (ID) of the offer to deactivate.
string	basePlanId	Required. The parent base plan (ID) of the offer to deactivate.
string	offerId	Required. The unique offer ID of the offer to deactivate.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.DeactivateRequest

Delete(string, string, string, string)

Deletes a subscription offer. Can only be done for draft offers. This action is irreversible.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.DeleteRequest Delete(string packageName, string productId, string basePlanId, string offerId)

Parameters

Type	Name	Description
string	packageName	Required. The parent app (package name) of the offer to delete.
string	productId	Required. The parent subscription (ID) of the offer to delete.
string	basePlanId	Required. The parent base plan (ID) of the offer to delete.
string	offerId	Required. The unique offer ID of the offer to delete.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.DeleteRequest

Get(string, string, string, string)

Reads a single offer

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.GetRequest Get(string packageName, string productId, string basePlanId, string offerId)

Parameters

Type	Name	Description
string	packageName	Required. The parent app (package name) of the offer to get.
string	productId	Required. The parent subscription (ID) of the offer to get.
string	basePlanId	Required. The parent base plan (ID) of the offer to get.
string	offerId	Required. The unique offer ID of the offer to get.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.GetRequest

List(string, string, string)

Lists all offers under a given subscription.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.ListRequest List(string packageName, string productId, string basePlanId)

Parameters

Type	Name	Description
string	packageName	Required. The parent app (package name) for which the subscriptions should be read.
string	productId	Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.
string	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

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.ListRequest

Patch(SubscriptionOffer, string, string, string, string)

Updates an existing subscription offer.

Declaration

public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.PatchRequest Patch(SubscriptionOffer body, string packageName, string productId, string basePlanId, string offerId)

Parameters

Type	Name	Description
SubscriptionOffer	body	The body of the request.
string	packageName	Required. Immutable. The package name of the app the parent subscription belongs to.
string	productId	Required. Immutable. The ID of the parent subscription this offer belongs to.
string	basePlanId	Required. Immutable. The ID of the base plan to which this offer is an extension.
string	offerId	Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.

Returns

Type	Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.PatchRequest