Show / Hide Table of Contents

Class MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource

The "offers" collection of methods.

Inheritance
System.Object
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.AndroidPublisher.v3
Assembly: Google.Apis.AndroidPublisher.v3.dll
Syntax
public class 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.

System.String packageName

Required. The parent app (package name) of the offer to activate.

System.String productId

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

System.String basePlanId

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

System.String offerId

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

Returns
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource.ActivateRequest

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.

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

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

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

System.String packageName

Required. The parent app (package name) of the offer to deactivate.

System.String productId

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

System.String basePlanId

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

System.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
System.String packageName

Required. The parent app (package name) of the offer to delete.

System.String productId

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

System.String basePlanId

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

System.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
System.String packageName

Required. The parent app (package name) of the offer to get.

System.String productId

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

System.String basePlanId

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

System.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
System.String packageName

Required. The parent app (package name) for which the subscriptions should be read.

System.String productId

Required. The parent subscription (ID) for which the offers should be read.

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

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.

System.String packageName

Required. Immutable. The package name of the app the parent subscription belongs to.

System.String productId

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

System.String basePlanId

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

System.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
In This Article
Back to top Generated by DocFX