Documentation

Google_Service_AndroidPublisher_Resource_PurchasesSubscriptions extends Google_Service_Resource
in package

Application

The "subscriptions" collection of methods.

Typical usage is: $androidpublisherService = new Google_Service_AndroidPublisher(...); $subscriptions = $androidpublisherService->subscriptions;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
acknowledge() : mixed: Acknowledges a subscription purchase. (subscriptions.acknowledge)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
cancel() : mixed: Cancels a user's subscription purchase. The subscription remains valid until its expiration time. (subscriptions.cancel)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
defer() : Google_Service_AndroidPublisher_SubscriptionPurchasesDeferResponse: Defers a user's subscription purchase until a specified future expiration time. (subscriptions.defer)
get() : Google_Service_AndroidPublisher_SubscriptionPurchase: Checks whether a user's subscription purchase is valid and returns its expiry time. (subscriptions.get)
refund() : mixed: Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.
revoke() : mixed: Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

acknowledge()

Acknowledges a subscription purchase. (subscriptions.acknowledge)


    public
                acknowledge(string $packageName, string $subscriptionId, string $token, Google_Service_AndroidPublisher_SubscriptionPurchasesAcknowledgeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$packageName : string: The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
$subscriptionId : string: The purchased subscription ID (for example, 'monthly001').
$token : string: The token provided to the user's device when the subscription was purchased.
$postBody : Google_Service_AndroidPublisher_SubscriptionPurchasesAcknowledgeRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

cancel()

Cancels a user's subscription purchase. The subscription remains valid until its expiration time. (subscriptions.cancel)


    public
                cancel(string $packageName, string $subscriptionId, string $token[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$packageName : string: The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
$subscriptionId : string: The purchased subscription ID (for example, 'monthly001').
$token : string: The token provided to the user's device when the subscription was purchased.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

defer()

Defers a user's subscription purchase until a specified future expiration time. (subscriptions.defer)


    public
                defer(string $packageName, string $subscriptionId, string $token, Google_Service_AndroidPublisher_SubscriptionPurchasesDeferRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidPublisher_SubscriptionPurchasesDeferResponse

Parameters

$packageName : string: The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
$subscriptionId : string: The purchased subscription ID (for example, 'monthly001').
$token : string: The token provided to the user's device when the subscription was purchased.
$postBody : Google_Service_AndroidPublisher_SubscriptionPurchasesDeferRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidPublisher_SubscriptionPurchasesDeferResponse —

get()

Checks whether a user's subscription purchase is valid and returns its expiry time. (subscriptions.get)


    public
                get(string $packageName, string $subscriptionId, string $token[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidPublisher_SubscriptionPurchase

Parameters

$packageName : string: The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
$subscriptionId : string: The purchased subscription ID (for example, 'monthly001').
$token : string: The token provided to the user's device when the subscription was purchased.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidPublisher_SubscriptionPurchase —

refund()

Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.


    public
                refund(string $packageName, string $subscriptionId, string $token[, array<string|int, mixed> $optParams = array() ]) : mixed

(subscriptions.refund)

Parameters

$packageName : string: The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
$subscriptionId : string: "The purchased subscription ID (for example, 'monthly001').
$token : string: The token provided to the user's device when the subscription was purchased.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

revoke()

Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.


    public
                revoke(string $packageName, string $subscriptionId, string $token[, array<string|int, mixed> $optParams = array() ]) : mixed

(subscriptions.revoke)

Parameters

$packageName : string: The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
$subscriptionId : string: The purchased subscription ID (for example, 'monthly001').
$token : string: The token provided to the user's device when the subscription was purchased.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —