193 lines
10 KiB
Ruby
193 lines
10 KiB
Ruby
# Copyright 2015 Google Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
require 'google/apis/core/base_service'
|
|
require 'google/apis/core/json_representation'
|
|
require 'google/apis/core/hashable'
|
|
require 'google/apis/errors'
|
|
|
|
module Google
|
|
module Apis
|
|
module AndroidpublisherV1_1
|
|
# Google Play Developer API
|
|
#
|
|
# Lets Android application developers access their Google Play accounts.
|
|
#
|
|
# @example
|
|
# require 'google/apis/androidpublisher_v1_1'
|
|
#
|
|
# Androidpublisher = Google::Apis::AndroidpublisherV1_1 # Alias the module
|
|
# service = Androidpublisher::AndroidPublisherService.new
|
|
#
|
|
# @see https://developers.google.com/android-publisher
|
|
class AndroidPublisherService < Google::Apis::Core::BaseService
|
|
# @return [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.
|
|
attr_accessor :key
|
|
|
|
# @return [String]
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
# Overrides userIp if both are provided.
|
|
attr_accessor :quota_user
|
|
|
|
# @return [String]
|
|
# IP address of the site where the request originates. Use this if you want to
|
|
# enforce per-user limits.
|
|
attr_accessor :user_ip
|
|
|
|
def initialize
|
|
super('https://www.googleapis.com/', 'androidpublisher/v1.1/applications/')
|
|
@batch_path = 'batch/androidpublisher/v1.1'
|
|
end
|
|
|
|
# Checks the purchase and consumption status of an inapp item.
|
|
# @param [String] package_name
|
|
# The package name of the application the inapp product was sold in (for example,
|
|
# 'com.some.thing').
|
|
# @param [String] product_id
|
|
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
|
# @param [String] token
|
|
# The token provided to the user's device when the inapp product was purchased.
|
|
# @param [String] fields
|
|
# Selector specifying which fields to include in a partial response.
|
|
# @param [String] quota_user
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
# Overrides userIp if both are provided.
|
|
# @param [String] user_ip
|
|
# IP address of the site where the request originates. Use this if you want to
|
|
# enforce per-user limits.
|
|
# @param [Google::Apis::RequestOptions] options
|
|
# Request-specific options
|
|
#
|
|
# @yield [result, err] Result & error if block supplied
|
|
# @yieldparam result [Google::Apis::AndroidpublisherV1_1::InappPurchase] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AndroidpublisherV1_1::InappPurchase]
|
|
#
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
def get_inapppurchase(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, '{packageName}/inapp/{productId}/purchases/{token}', options)
|
|
command.response_representation = Google::Apis::AndroidpublisherV1_1::InappPurchase::Representation
|
|
command.response_class = Google::Apis::AndroidpublisherV1_1::InappPurchase
|
|
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
|
|
|
|
# Cancels a user's subscription purchase. The subscription remains valid until
|
|
# its expiration time.
|
|
# @param [String] package_name
|
|
# The package name of the application for which this subscription was purchased (
|
|
# for example, 'com.some.thing').
|
|
# @param [String] subscription_id
|
|
# The purchased subscription ID (for example, 'monthly001').
|
|
# @param [String] token
|
|
# The token provided to the user's device when the subscription was purchased.
|
|
# @param [String] fields
|
|
# Selector specifying which fields to include in a partial response.
|
|
# @param [String] quota_user
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
# Overrides userIp if both are provided.
|
|
# @param [String] user_ip
|
|
# IP address of the site where the request originates. Use this if you want to
|
|
# enforce per-user limits.
|
|
# @param [Google::Apis::RequestOptions] options
|
|
# Request-specific options
|
|
#
|
|
# @yield [result, err] Result & error if block supplied
|
|
# @yieldparam result [NilClass] No result returned for this method
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [void]
|
|
#
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
def cancel_purchase(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:post, '{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel', options)
|
|
command.params['packageName'] = package_name unless package_name.nil?
|
|
command.params['subscriptionId'] = subscription_id unless subscription_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
|
|
|
|
# Checks whether a user's subscription purchase is valid and returns its expiry
|
|
# time.
|
|
# @param [String] package_name
|
|
# The package name of the application for which this subscription was purchased (
|
|
# for example, 'com.some.thing').
|
|
# @param [String] subscription_id
|
|
# The purchased subscription ID (for example, 'monthly001').
|
|
# @param [String] token
|
|
# The token provided to the user's device when the subscription was purchased.
|
|
# @param [String] fields
|
|
# Selector specifying which fields to include in a partial response.
|
|
# @param [String] quota_user
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
# Overrides userIp if both are provided.
|
|
# @param [String] user_ip
|
|
# IP address of the site where the request originates. Use this if you want to
|
|
# enforce per-user limits.
|
|
# @param [Google::Apis::RequestOptions] options
|
|
# Request-specific options
|
|
#
|
|
# @yield [result, err] Result & error if block supplied
|
|
# @yieldparam result [Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase]
|
|
#
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
def get_purchase(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, '{packageName}/subscriptions/{subscriptionId}/purchases/{token}', options)
|
|
command.response_representation = Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase::Representation
|
|
command.response_class = Google::Apis::AndroidpublisherV1_1::SubscriptionPurchase
|
|
command.params['packageName'] = package_name unless package_name.nil?
|
|
command.params['subscriptionId'] = subscription_id unless subscription_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
|
|
|
|
protected
|
|
|
|
def apply_command_defaults(command)
|
|
command.query['key'] = key unless key.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|