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.



5595
5596
5597
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5595

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) 


5538
5539
5540
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5538

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) 


5544
5545
5546
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5544

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:



5550
5551
5552
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5550

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:



5556
5557
5558
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5556

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) 


5562
5563
5564
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5562

def package_name
  @package_name
end

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

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

Returns:



5570
5571
5572
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5570

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) 


5575
5576
5577
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5575

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:



5581
5582
5583
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5581

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) 


5588
5589
5590
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5588

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:



5593
5594
5595
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5593

def targeting
  @targeting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 5600

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