Class: Google::Apis::AndroidpublisherV2::AndroidPublisherService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/androidpublisher_v2/service.rb

Overview

Google Play Developer API

Accesses Android application developers' Google Play accounts.

Examples:

require 'google/apis/androidpublisher_v2'

Androidpublisher = Google::Apis::AndroidpublisherV2 # Alias the module
service = Androidpublisher::AndroidPublisherService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeAndroidPublisherService

Returns a new instance of AndroidPublisherService.



49
50
51
52
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'androidpublisher/v2/applications/')
  @batch_path = 'batch/androidpublisher/v2'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.



47
48
49
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#get_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ProductPurchase

Checks the purchase and consumption status of an inapp item.

Parameters:

  • package_name (String)

    The package name of the application the inapp product was sold in (for example, 'com.some.thing').

  • product_id (String)

    The inapp product SKU (for example, 'com.some.thing.inapp1').

  • token (String)

    The token provided to the user's device when the inapp product was purchased.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



81
82
83
84
85
86
87
88
89
90
91
92
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 81

def get_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{packageName}/purchases/products/{productId}/tokens/{token}', options)
  command.response_representation = Google::Apis::AndroidpublisherV2::ProductPurchase::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ProductPurchase
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['token'] = token unless token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_purchase_voidedpurchases(package_name, end_time: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse

Lists the purchases that were canceled, refunded or charged-back.

Parameters:

  • package_name (String)

    The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').

  • end_time (Fixnum) (defaults to: nil)

    The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

  • max_results (Fixnum) (defaults to: nil)
  • start_index (Fixnum) (defaults to: nil)
  • start_time (Fixnum) (defaults to: nil)

    The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

  • token (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 134

def list_purchase_voidedpurchases(package_name, end_time: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{packageName}/purchases/voidedpurchases', options)
  command.response_representation = Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['startTime'] = start_time unless start_time.nil?
  command.query['token'] = token unless token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end