Show / Hide Table of Contents

Class MonetizationResource.SubscriptionsResource.BasePlansResource

The "basePlans" collection of methods.

Inheritance
object
MonetizationResource.SubscriptionsResource.BasePlansResource
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

Constructors

BasePlansResource(IClientService)

Constructs a new resource.

Declaration
public BasePlansResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Offers

Gets the Offers resource.

Declaration
public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource Offers { get; }
Property Value
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.OffersResource

Methods

Activate(ActivateBasePlanRequest, string, string, string)

Activates a base plan. Once activated, base plans will be available to new subscribers.

Declaration
public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.ActivateRequest Activate(ActivateBasePlanRequest body, string packageName, string productId, string basePlanId)
Parameters
Type Name Description
ActivateBasePlanRequest body

The body of the request.

string packageName

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

string productId

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

string basePlanId

Required. The unique base plan ID of the base plan to activate.

Returns
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.ActivateRequest

BatchMigratePrices(BatchMigrateBasePlanPricesRequest, string, string)

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.

Declaration
public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.BatchMigratePricesRequest BatchMigratePrices(BatchMigrateBasePlanPricesRequest body, string packageName, string productId)
Parameters
Type Name Description
BatchMigrateBasePlanPricesRequest 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 Subscription resources.

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

Returns
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.BatchMigratePricesRequest

BatchUpdateStates(BatchUpdateBasePlanStatesRequest, string, string)

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.

Declaration
public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.BatchUpdateStatesRequest BatchUpdateStates(BatchUpdateBasePlanStatesRequest body, string packageName, string productId)
Parameters
Type Name Description
BatchUpdateBasePlanStatesRequest body

The body of the request.

string packageName

Required. The parent app (package name) of the updated base plans.

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

Returns
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.BatchUpdateStatesRequest

Deactivate(DeactivateBasePlanRequest, string, string, string)

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

Declaration
public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.DeactivateRequest Deactivate(DeactivateBasePlanRequest body, string packageName, string productId, string basePlanId)
Parameters
Type Name Description
DeactivateBasePlanRequest body

The body of the request.

string packageName

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

string productId

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

string basePlanId

Required. The unique base plan ID of the base plan to deactivate.

Returns
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.DeactivateRequest

Delete(string, string, string)

Deletes a base plan. Can only be done for draft base plans. This action is irreversible.

Declaration
public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.DeleteRequest Delete(string packageName, string productId, string basePlanId)
Parameters
Type Name Description
string packageName

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

string productId

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

string basePlanId

Required. The unique offer ID of the base plan to delete.

Returns
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.DeleteRequest

MigratePrices(MigrateBasePlanPricesRequest, string, string, string)

Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.

Declaration
public virtual MonetizationResource.SubscriptionsResource.BasePlansResource.MigratePricesRequest MigratePrices(MigrateBasePlanPricesRequest body, string packageName, string productId, string basePlanId)
Parameters
Type Name Description
MigrateBasePlanPricesRequest body

The body of the request.

string packageName

Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.

string productId

Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.

string basePlanId

Required. The unique base plan ID of the base plan to update prices on.

Returns
Type Description
MonetizationResource.SubscriptionsResource.BasePlansResource.MigratePricesRequest
In this article
Back to top Generated by DocFX