
target.apidocs.com.google.api.services.androidpublisher.model.SubscriptionOffer.html Maven / Gradle / Ivy
SubscriptionOffer (Google Play Android Developer API v3-rev20240129-2.0.0)
com.google.api.services.androidpublisher.model
Class SubscriptionOffer
- 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.SubscriptionOffer
-
public final class SubscriptionOffer
extends com.google.api.client.json.GenericJson
A single, temporary offer
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>
-
Constructor Summary
Constructors
Constructor and Description
SubscriptionOffer()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
SubscriptionOffer
clone()
String
getBasePlanId()
Required.
String
getOfferId()
Required.
List<OfferTag>
getOfferTags()
List of up to 20 custom tags specified for this offer, and returned to the app through the
billing library.
OtherRegionsSubscriptionOfferConfig
getOtherRegionsConfig()
The configuration for any new locations Play may launch in the future.
String
getPackageName()
Required.
List<SubscriptionOfferPhase>
getPhases()
Required.
String
getProductId()
Required.
List<RegionalSubscriptionOfferConfig>
getRegionalConfigs()
Required.
String
getState()
Output only.
SubscriptionOfferTargeting
getTargeting()
The requirements that users need to fulfil to be eligible for this offer.
SubscriptionOffer
set(String fieldName,
Object value)
SubscriptionOffer
setBasePlanId(String basePlanId)
Required.
SubscriptionOffer
setOfferId(String offerId)
Required.
SubscriptionOffer
setOfferTags(List<OfferTag> offerTags)
List of up to 20 custom tags specified for this offer, and returned to the app through the
billing library.
SubscriptionOffer
setOtherRegionsConfig(OtherRegionsSubscriptionOfferConfig otherRegionsConfig)
The configuration for any new locations Play may launch in the future.
SubscriptionOffer
setPackageName(String packageName)
Required.
SubscriptionOffer
setPhases(List<SubscriptionOfferPhase> phases)
Required.
SubscriptionOffer
setProductId(String productId)
Required.
SubscriptionOffer
setRegionalConfigs(List<RegionalSubscriptionOfferConfig> regionalConfigs)
Required.
SubscriptionOffer
setState(String state)
Output only.
SubscriptionOffer
setTargeting(SubscriptionOfferTargeting targeting)
The requirements that users need to fulfil to be eligible for this offer.
-
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
-
-
Method Detail
-
getBasePlanId
public String getBasePlanId()
Required. Immutable. The ID of the base plan to which this offer is an extension.
- Returns:
- value or
null
for none
-
setBasePlanId
public SubscriptionOffer setBasePlanId(String basePlanId)
Required. Immutable. The ID of the base plan to which this offer is an extension.
- Parameters:
basePlanId
- basePlanId or null
for none
-
getOfferId
public String getOfferId()
Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
- Returns:
- value or
null
for none
-
setOfferId
public SubscriptionOffer setOfferId(String offerId)
Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
- Parameters:
offerId
- offerId or null
for none
-
getOfferTags
public List<OfferTag> getOfferTags()
List of up to 20 custom tags specified for this offer, and returned to the app through the
billing library.
- Returns:
- value or
null
for none
-
setOfferTags
public SubscriptionOffer setOfferTags(List<OfferTag> offerTags)
List of up to 20 custom tags specified for this offer, and returned to the app through the
billing library.
- Parameters:
offerTags
- offerTags or null
for none
-
getOtherRegionsConfig
public OtherRegionsSubscriptionOfferConfig getOtherRegionsConfig()
The configuration for any new locations Play may launch in the future.
- Returns:
- value or
null
for none
-
setOtherRegionsConfig
public SubscriptionOffer setOtherRegionsConfig(OtherRegionsSubscriptionOfferConfig otherRegionsConfig)
The configuration for any new locations Play may launch in the future.
- Parameters:
otherRegionsConfig
- otherRegionsConfig or null
for none
-
getPackageName
public String getPackageName()
Required. Immutable. The package name of the app the parent subscription belongs to.
- Returns:
- value or
null
for none
-
setPackageName
public SubscriptionOffer setPackageName(String packageName)
Required. Immutable. The package name of the app the parent subscription belongs to.
- Parameters:
packageName
- packageName or null
for none
-
getPhases
public List<SubscriptionOfferPhase> getPhases()
Required. The phases of this subscription offer. Must contain at least one entry, and may
contain at most five. Users will always receive all these phases in the specified order. Phases
may not be added, removed, or reordered after initial creation.
- Returns:
- value or
null
for none
-
setPhases
public SubscriptionOffer setPhases(List<SubscriptionOfferPhase> phases)
Required. The phases of this subscription offer. Must contain at least one entry, and may
contain at most five. Users will always receive all these phases in the specified order. Phases
may not be added, removed, or reordered after initial creation.
- Parameters:
phases
- phases or null
for none
-
getProductId
public String getProductId()
Required. Immutable. The ID of the parent subscription this offer belongs to.
- Returns:
- value or
null
for none
-
setProductId
public SubscriptionOffer setProductId(String productId)
Required. Immutable. The ID of the parent subscription this offer belongs to.
- Parameters:
productId
- productId or null
for none
-
getRegionalConfigs
public List<RegionalSubscriptionOfferConfig> getRegionalConfigs()
Required. The region-specific configuration of this offer. Must contain at least one entry.
- Returns:
- value or
null
for none
-
setRegionalConfigs
public SubscriptionOffer setRegionalConfigs(List<RegionalSubscriptionOfferConfig> regionalConfigs)
Required. The region-specific configuration of this offer. Must contain at least one entry.
- Parameters:
regionalConfigs
- regionalConfigs or null
for none
-
getState
public String getState()
Output only. The current state of this offer. Can be changed using Activate and Deactivate
actions. NB: the base plan state supersedes this state, so an active offer may not be available
if the base plan is not active.
- Returns:
- value or
null
for none
-
setState
public SubscriptionOffer setState(String state)
Output only. The current state of this offer. Can be changed using Activate and Deactivate
actions. NB: the base plan state supersedes this state, so an active offer may not be available
if the base plan is not active.
- Parameters:
state
- state or null
for none
-
getTargeting
public SubscriptionOfferTargeting getTargeting()
The requirements that users need to fulfil to be eligible for this offer. Represents the
requirements that Play will evaluate to decide whether an offer should be returned. Developers
may further filter these offers themselves.
- Returns:
- value or
null
for none
-
setTargeting
public SubscriptionOffer setTargeting(SubscriptionOfferTargeting targeting)
The requirements that users need to fulfil to be eligible for this offer. Represents the
requirements that Play will evaluate to decide whether an offer should be returned. Developers
may further filter these offers themselves.
- Parameters:
targeting
- targeting or null
for none
-
set
public SubscriptionOffer set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public SubscriptionOffer clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy