Class: Google::Apis::AndroidpublisherV3::SubscriptionOffer

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/androidpublisher_v3/classes.rb,
lib/google/apis/androidpublisher_v3/representations.rb,
lib/google/apis/androidpublisher_v3/representations.rb

Overview

A single, temporary offer

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SubscriptionOffer

Returns a new instance of SubscriptionOffer.



10023
10024
10025
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10023

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#base_plan_id ⇒ String

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

Returns:

  • (String) 


9967
9968
9969
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9967

def base_plan_id
  @base_plan_id
end

#offer_id ⇒ String

Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan. Corresponds to the JSON property offerId

Returns:

  • (String) 


9973
9974
9975
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9973

def offer_id
  @offer_id
end

#offer_tags ⇒ Array<Google::Apis::AndroidpublisherV3::OfferTag>

List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. Corresponds to the JSON property offerTags

Returns:



9979
9980
9981
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9979

def offer_tags
  @offer_tags
end

#other_regions_config ⇒ Google::Apis::AndroidpublisherV3::OtherRegionsSubscriptionOfferConfig

Configuration for any new locations Play may launch in specified on a subscription offer. Corresponds to the JSON property otherRegionsConfig

Returns:



9985
9986
9987
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9985

def other_regions_config
  @other_regions_config
end

#package_name ⇒ String

Required. Immutable. The package name of the app the parent subscription belongs to. Corresponds to the JSON property packageName

Returns:

  • (String) 


9991
9992
9993
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9991

def package_name
  @package_name
end

#phases ⇒ Array<Google::Apis::AndroidpublisherV3::SubscriptionOfferPhase>

Required. The phases of this subscription offer. Must contain at least one and at most two entries. Users will always receive all these phases in the specified order. Corresponds to the JSON property phases

Returns:



9998
9999
10000
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9998

def phases
  @phases
end

#product_id ⇒ String

Required. Immutable. The ID of the parent subscription this offer belongs to. Corresponds to the JSON property productId

Returns:

  • (String) 


10003
10004
10005
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10003

def product_id
  @product_id
end

#regional_configs ⇒ Array<Google::Apis::AndroidpublisherV3::RegionalSubscriptionOfferConfig>

Required. The region-specific configuration of this offer. Must contain at least one entry. Corresponds to the JSON property regionalConfigs

Returns:



10009
10010
10011
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10009

def regional_configs
  @regional_configs
end

#state ⇒ String

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. Corresponds to the JSON property state

Returns:

  • (String) 


10016
10017
10018
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10016

def state
  @state
end

#targeting ⇒ Google::Apis::AndroidpublisherV3::SubscriptionOfferTargeting

Defines the rule a user needs to satisfy to receive this offer. Corresponds to the JSON property targeting

Returns:



10021
10022
10023
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10021

def targeting
  @targeting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10028

def update!(**args)
  @base_plan_id = args[:base_plan_id] if args.key?(:base_plan_id)
  @offer_id = args[:offer_id] if args.key?(:offer_id)
  @offer_tags = args[:offer_tags] if args.key?(:offer_tags)
  @other_regions_config = args[:other_regions_config] if args.key?(:other_regions_config)
  @package_name = args[:package_name] if args.key?(:package_name)
  @phases = args[:phases] if args.key?(:phases)
  @product_id = args[:product_id] if args.key?(:product_id)
  @regional_configs = args[:regional_configs] if args.key?(:regional_configs)
  @state = args[:state] if args.key?(:state)
  @targeting = args[:targeting] if args.key?(:targeting)
end