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.



8568
8569
8570
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8568

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) 


8512
8513
8514
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8512

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) 


8518
8519
8520
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8518

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:



8524
8525
8526
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8524

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:



8530
8531
8532
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8530

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) 


8536
8537
8538
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8536

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:



8543
8544
8545
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8543

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) 


8548
8549
8550
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8548

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:



8554
8555
8556
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8554

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) 


8561
8562
8563
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8561

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:



8566
8567
8568
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8566

def targeting
  @targeting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 8573

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