com.google.api.services.androidpublisher.model

Class BasePlan

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.androidpublisher.model.BasePlan

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BasePlan
extends com.google.api.client.json.GenericJson

A single base plan for a subscription.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Android Developer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BasePlan()

Method Summary

Modifier and Type	Method and Description
BasePlan	clone()
AutoRenewingBasePlanType	getAutoRenewingBasePlanType() Set when the base plan automatically renews at a regular interval.
String	getBasePlanId() Required.
InstallmentsBasePlanType	getInstallmentsBasePlanType() Set for installments base plans where a user is committed to a specified number of payments.
List<OfferTag>	getOfferTags() List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library.
OtherRegionsBasePlanConfig	getOtherRegionsConfig() Pricing information for any new locations Play may launch in the future.
PrepaidBasePlanType	getPrepaidBasePlanType() Set when the base plan does not automatically renew at the end of the billing period.
List<RegionalBasePlanConfig>	getRegionalConfigs() Region-specific information for this base plan.
String	getState() Output only.
BasePlan	set(String fieldName, Object value)
BasePlan	setAutoRenewingBasePlanType(AutoRenewingBasePlanType autoRenewingBasePlanType) Set when the base plan automatically renews at a regular interval.
BasePlan	setBasePlanId(String basePlanId) Required.
BasePlan	setInstallmentsBasePlanType(InstallmentsBasePlanType installmentsBasePlanType) Set for installments base plans where a user is committed to a specified number of payments.
BasePlan	setOfferTags(List<OfferTag> offerTags) List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library.
BasePlan	setOtherRegionsConfig(OtherRegionsBasePlanConfig otherRegionsConfig) Pricing information for any new locations Play may launch in the future.
BasePlan	setPrepaidBasePlanType(PrepaidBasePlanType prepaidBasePlanType) Set when the base plan does not automatically renew at the end of the billing period.
BasePlan	setRegionalConfigs(List<RegionalBasePlanConfig> regionalConfigs) Region-specific information for this base plan.
BasePlan	setState(String state) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BasePlan

public BasePlan()

Method Detail

getAutoRenewingBasePlanType

public AutoRenewingBasePlanType getAutoRenewingBasePlanType()

Set when the base plan automatically renews at a regular interval.

Returns:

value or null for none

setAutoRenewingBasePlanType

public BasePlan setAutoRenewingBasePlanType(AutoRenewingBasePlanType autoRenewingBasePlanType)

Set when the base plan automatically renews at a regular interval.

Parameters:

autoRenewingBasePlanType - autoRenewingBasePlanType or null for none

getBasePlanId

public String getBasePlanId()

Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.

Returns:

value or null for none

setBasePlanId

public BasePlan setBasePlanId(String basePlanId)

Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.

Parameters:

basePlanId - basePlanId or null for none

getInstallmentsBasePlanType

public InstallmentsBasePlanType getInstallmentsBasePlanType()

Set for installments base plans where a user is committed to a specified number of payments.

Returns:

value or null for none

setInstallmentsBasePlanType

public BasePlan setInstallmentsBasePlanType(InstallmentsBasePlanType installmentsBasePlanType)

Set for installments base plans where a user is committed to a specified number of payments.

Parameters:

installmentsBasePlanType - installmentsBasePlanType or null for none

getOfferTags

public List<OfferTag> getOfferTags()

List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.

Returns:

value or null for none

setOfferTags

public BasePlan setOfferTags(List<OfferTag> offerTags)

List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.

Parameters:

offerTags - offerTags or null for none

getOtherRegionsConfig

public OtherRegionsBasePlanConfig getOtherRegionsConfig()

Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.

Returns:

value or null for none

setOtherRegionsConfig

public BasePlan setOtherRegionsConfig(OtherRegionsBasePlanConfig otherRegionsConfig)

Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.

Parameters:

otherRegionsConfig - otherRegionsConfig or null for none

getPrepaidBasePlanType

public PrepaidBasePlanType getPrepaidBasePlanType()

Set when the base plan does not automatically renew at the end of the billing period.

Returns:

value or null for none

setPrepaidBasePlanType

public BasePlan setPrepaidBasePlanType(PrepaidBasePlanType prepaidBasePlanType)

Set when the base plan does not automatically renew at the end of the billing period.

Parameters:

prepaidBasePlanType - prepaidBasePlanType or null for none

getRegionalConfigs

public List<RegionalBasePlanConfig> getRegionalConfigs()

Region-specific information for this base plan.

Returns:

value or null for none

setRegionalConfigs

public BasePlan setRegionalConfigs(List<RegionalBasePlanConfig> regionalConfigs)

Region-specific information for this base plan.

Parameters:

regionalConfigs - regionalConfigs or null for none

getState

public String getState()

Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.

Returns:

value or null for none

setState

public BasePlan setState(String state)

Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.

Parameters:

state - state or null for none

set

public BasePlan set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public BasePlan clone()

Overrides:

clone in class com.google.api.client.json.GenericJson