Class: Google::Apis::AndroidpublisherV3::ProductPurchase

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 ProductPurchase resource indicates the status of a user's inapp product purchase.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ProductPurchase

Returns a new instance of ProductPurchase.



4403
4404
4405
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4403

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

Instance Attribute Details

#acknowledgement_state ⇒ Fixnum

The acknowledgement state of the inapp product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged Corresponds to the JSON property acknowledgementState

Returns:

  • (Fixnum) 


4314
4315
4316
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4314

def acknowledgement_state
  @acknowledgement_state
end

#consumption_state ⇒ Fixnum

The consumption state of the inapp product. Possible values are: 0. Yet to be consumed 1. Consumed Corresponds to the JSON property consumptionState

Returns:

  • (Fixnum) 


4320
4321
4322
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4320

def consumption_state
  @consumption_state
end

#developer_payload ⇒ String

A developer-specified string that contains supplemental information about an order. Corresponds to the JSON property developerPayload

Returns:

  • (String) 


4326
4327
4328
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4326

def developer_payload
  @developer_payload
end

#kind ⇒ String

This kind represents an inappPurchase object in the androidpublisher service. Corresponds to the JSON property kind

Returns:

  • (String) 


4331
4332
4333
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4331

def kind
  @kind
end

#obfuscated_external_account_id ⇒ String

An obfuscated version of the id that is uniquely associated with the user's account in your app. Only present if specified using https://developer.android. com/reference/com/android/billingclient/api/BillingFlowParams.Builder# setobfuscatedaccountid when the purchase was made. Corresponds to the JSON property obfuscatedExternalAccountId

Returns:

  • (String) 


4339
4340
4341
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4339

def 
  @obfuscated_external_account_id
end

#obfuscated_external_profile_id ⇒ String

An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android. com/reference/com/android/billingclient/api/BillingFlowParams.Builder# setobfuscatedprofileid when the purchase was made. Corresponds to the JSON property obfuscatedExternalProfileId

Returns:

  • (String) 


4347
4348
4349
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4347

def obfuscated_external_profile_id
  @obfuscated_external_profile_id
end

#order_id ⇒ String

The order id associated with the purchase of the inapp product. Corresponds to the JSON property orderId

Returns:

  • (String) 


4352
4353
4354
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4352

def order_id
  @order_id
end

#product_id ⇒ String

The inapp product SKU. May not be present. Corresponds to the JSON property productId

Returns:

  • (String) 


4357
4358
4359
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4357

def product_id
  @product_id
end

#purchase_state ⇒ Fixnum

The purchase state of the order. Possible values are: 0. Purchased 1. Canceled

  1. Pending Corresponds to the JSON property purchaseState

Returns:

  • (Fixnum) 


4363
4364
4365
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4363

def purchase_state
  @purchase_state
end

#purchase_time_millis ⇒ Fixnum

The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). Corresponds to the JSON property purchaseTimeMillis

Returns:

  • (Fixnum) 


4369
4370
4371
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4369

def purchase_time_millis
  @purchase_time_millis
end

#purchase_token ⇒ String

The purchase token generated to identify this purchase. May not be present. Corresponds to the JSON property purchaseToken

Returns:

  • (String) 


4374
4375
4376
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4374

def purchase_token
  @purchase_token
end

#purchase_type ⇒ Fixnum

The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code). Does not include Play Points purchases. 2. Rewarded (i.e. from watching a video ad instead of paying) Corresponds to the JSON property purchaseType

Returns:

  • (Fixnum) 


4383
4384
4385
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4383

def purchase_type
  @purchase_type
end

#quantity ⇒ Fixnum

The quantity associated with the purchase of the inapp product. If not present, the quantity is 1. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


4389
4390
4391
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4389

def quantity
  @quantity
end

#refundable_quantity ⇒ Fixnum

The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds. Corresponds to the JSON property refundableQuantity

Returns:

  • (Fixnum) 


4395
4396
4397
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4395

def refundable_quantity
  @refundable_quantity
end

#region_code ⇒ String

ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted. Corresponds to the JSON property regionCode

Returns:

  • (String) 


4401
4402
4403
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4401

def region_code
  @region_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4408

def update!(**args)
  @acknowledgement_state = args[:acknowledgement_state] if args.key?(:acknowledgement_state)
  @consumption_state = args[:consumption_state] if args.key?(:consumption_state)
  @developer_payload = args[:developer_payload] if args.key?(:developer_payload)
  @kind = args[:kind] if args.key?(:kind)
  @obfuscated_external_account_id = args[:obfuscated_external_account_id] if args.key?(:obfuscated_external_account_id)
  @obfuscated_external_profile_id = args[:obfuscated_external_profile_id] if args.key?(:obfuscated_external_profile_id)
  @order_id = args[:order_id] if args.key?(:order_id)
  @product_id = args[:product_id] if args.key?(:product_id)
  @purchase_state = args[:purchase_state] if args.key?(:purchase_state)
  @purchase_time_millis = args[:purchase_time_millis] if args.key?(:purchase_time_millis)
  @purchase_token = args[:purchase_token] if args.key?(:purchase_token)
  @purchase_type = args[:purchase_type] if args.key?(:purchase_type)
  @quantity = args[:quantity] if args.key?(:quantity)
  @refundable_quantity = args[:refundable_quantity] if args.key?(:refundable_quantity)
  @region_code = args[:region_code] if args.key?(:region_code)
end