File

src/apis/androidpublisher/v1.1.ts

Index

Properties
Methods

Constructor

constructor(context: APIRequestContext)
Parameters :
Name Type Optional
context APIRequestContext No

Properties

context
Type : APIRequestContext

Methods

get
get(params: Params$Resource$Inapppurchases$Get, options: StreamMethodOptions)

androidpublisher.inapppurchases.get // Before running the sample: // - Enable the API at: // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com // - Login into gcloud by running: // $ gcloud auth application-default login // - Install the npm module by running: // $ npm install googleapis

const {google} = require('googleapis'); const androidpublisher = google.androidpublisher('v1.1');

async function main() { const auth = new google.auth.GoogleAuth({ // Scopes can be specified either as an array or as a single, space-delimited string. scopes: ['https://www.googleapis.com/auth/androidpublisher'], });

// Acquire an auth client, and bind it to all future calls const authClient = await auth.getClient(); google.options({auth: authClient});

// Do the magic const res = await androidpublisher.inapppurchases.get({ // The package name of the application the inapp product was sold in (for example, 'com.some.thing'). packageName: 'placeholder-value', // The inapp product SKU (for example, 'com.some.thing.inapp1'). productId: 'placeholder-value', // The token provided to the user's device when the inapp product was purchased. token: 'placeholder-value', }); console.log(res.data);

// Example response // { // "consumptionState": 0, // "developerPayload": "my_developerPayload", // "kind": "my_kind", // "orderId": "my_orderId", // "purchaseState": 0, // "purchaseTime": "my_purchaseTime", // "purchaseType": 0 // } }

main().catch(e => { console.error(e); throw e; });

Parameters :
Name Type Optional Description
params Params$Resource$Inapppurchases$Get No

Parameters for request

options StreamMethodOptions No

Optionally override request options, such as url, method, and encoding.

Example :
// Before running the sample:
// - Enable the API at:
//   <a href="https://console.developers.google.com/apis/api/androidpublisher.googleapis.com">https://console.developers.google.com/apis/api/androidpublisher.googleapis.com</a>
// - Login into gcloud by running:
//   <code>$ gcloud auth application-default login</code>
// - Install the npm module by running:
//   <code>$ npm install googleapis</code></p>
<p>const {google} = require(&#39;googleapis&#39;);
const androidpublisher = google.androidpublisher(&#39;v1.1&#39;);</p>
<p>async function main() {
  const auth = new google.auth.GoogleAuth({
    // Scopes can be specified either as an array or as a single, space-delimited string.
    scopes: [&#39;<a href="https://www.googleapis.com/auth/androidpublisher&#39;%5D">https://www.googleapis.com/auth/androidpublisher&#39;]</a>,
  });</p>
<p>  // Acquire an auth client, and bind it to all future calls
  const authClient = await auth.getClient();
  google.options({auth: authClient});</p>
<p>  // Do the magic
  const res = await androidpublisher.inapppurchases.get({
    // The package name of the application the inapp product was sold in (for example, &#39;com.some.thing&#39;).
    packageName: &#39;placeholder-value&#39;,
    // The inapp product SKU (for example, &#39;com.some.thing.inapp1&#39;).
    productId: &#39;placeholder-value&#39;,
    // The token provided to the user&#39;s device when the inapp product was purchased.
    token: &#39;placeholder-value&#39;,
  });
  console.log(res.data);</p>
<p>  // Example response
  // {
  //   &quot;consumptionState&quot;: 0,
  //   &quot;developerPayload&quot;: &quot;my_developerPayload&quot;,
  //   &quot;kind&quot;: &quot;my_kind&quot;,
  //   &quot;orderId&quot;: &quot;my_orderId&quot;,
  //   &quot;purchaseState&quot;: 0,
  //   &quot;purchaseTime&quot;: &quot;my_purchaseTime&quot;,
  //   &quot;purchaseType&quot;: 0
  // }
}</p>
<p>main().catch(e =&gt; {
  console.error(e);
  throw e;
});
Returns : GaxiosPromise<Readable>

Request object

get
get(params?: Params$Resource$Inapppurchases$Get, options?: MethodOptions)
Parameters :
Name Type Optional
params Params$Resource$Inapppurchases$Get Yes
options MethodOptions Yes
get
get(params: Params$Resource$Inapppurchases$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback)
Parameters :
Name Type Optional
params Params$Resource$Inapppurchases$Get No
options StreamMethodOptions | BodyResponseCallback<Readable> No
callback BodyResponseCallback<Readable> No
Returns : void
get
get(params: Params$Resource$Inapppurchases$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback<Schema$InappPurchase>)
Parameters :
Name Type Optional
params Params$Resource$Inapppurchases$Get No
options MethodOptions | BodyResponseCallback<Schema$InappPurchase> No
callback BodyResponseCallback<Schema$InappPurchase> No
Returns : void
get
get(params: Params$Resource$Inapppurchases$Get, callback: BodyResponseCallback<Schema$InappPurchase>)
Parameters :
Name Type Optional
params Params$Resource$Inapppurchases$Get No
callback BodyResponseCallback<Schema$InappPurchase> No
Returns : void
get
get(callback: BodyResponseCallback<Schema$InappPurchase>)
Parameters :
Name Type Optional
callback BodyResponseCallback<Schema$InappPurchase> No
Returns : void
get
get(paramsOrCallback?: Params$Resource$Inapppurchases$Get | BodyResponseCallback<Schema$InappPurchase> | BodyResponseCallback<Readable>, optionsOrCallback?: MethodOptions | StreamMethodOptions | BodyResponseCallback | BodyResponseCallback, callback?: BodyResponseCallback<Schema$InappPurchase> | BodyResponseCallback<Readable>)
Parameters :
Name Type Optional
paramsOrCallback Params$Resource$Inapppurchases$Get | BodyResponseCallback<Schema$InappPurchase> | BodyResponseCallback<Readable> Yes
optionsOrCallback MethodOptions | StreamMethodOptions | BodyResponseCallback<Schema$InappPurchase> | BodyResponseCallback<Readable> Yes
callback BodyResponseCallback<Schema$InappPurchase> | BodyResponseCallback<Readable> Yes
Returns : void | GaxiosPromise | GaxiosPromise
import {
  OAuth2Client,
  JWT,
  Compute,
  UserRefreshClient,
  GaxiosPromise,
  GoogleConfigurable,
  createAPIRequest,
  MethodOptions,
  StreamMethodOptions,
  GlobalOptions,
  GoogleAuth,
  BodyResponseCallback,
  APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';

export namespace androidpublisher_v1_1 {
  export interface Options extends GlobalOptions {
    version: 'v1.1';
  }

  interface StandardParameters {
    /**
     * Auth client or API Key for the request
     */
    auth?:
      | string
      | OAuth2Client
      | JWT
      | Compute
      | UserRefreshClient
      | GoogleAuth;

    /**
     * Data format for the response.
     */
    alt?: string;
    /**
     * Selector specifying which fields to include in a partial response.
     */
    fields?: 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.
     */
    key?: string;
    /**
     * OAuth 2.0 token for the current user.
     */
    oauth_token?: string;
    /**
     * Returns response with indentations and line breaks.
     */
    prettyPrint?: boolean;
    /**
     * An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
     */
    quotaUser?: string;
    /**
     * Deprecated. Please use quotaUser instead.
     */
    userIp?: string;
  }

  /**
   * Google Play Developer API
   *
   * Accesses Android application developers&#39; Google Play accounts.
   *
   * @example
   * const {google} = require('googleapis');
   * const androidpublisher = google.androidpublisher('v1.1');
   *
   * @namespace androidpublisher
   * @type {Function}
   * @version v1.1
   * @variation v1.1
   * @param {object=} options Options for Androidpublisher
   */
  export class Androidpublisher {
    context: APIRequestContext;
    inapppurchases: Resource$Inapppurchases;

    constructor(options: GlobalOptions, google?: GoogleConfigurable) {
      this.context = {
        _options: options || {},
        google,
      };

      this.inapppurchases = new Resource$Inapppurchases(this.context);
    }
  }

  /**
   * An InappPurchase resource indicates the status of a user&#39;s inapp product purchase.
   */
  export interface Schema$InappPurchase {
    /**
     * The consumption state of the inapp product. Possible values are:   - Yet to be consumed  - Consumed
     */
    consumptionState?: number | null;
    /**
     * A developer-specified string that contains supplemental information about an order.
     */
    developerPayload?: string | null;
    /**
     * This kind represents an inappPurchase object in the androidpublisher service.
     */
    kind?: string | null;
    /**
     * The order id associated with the purchase of the inapp product.
     */
    orderId?: string | null;
    /**
     * The purchase state of the order. Possible values are:   - Purchased  - Canceled  - Pending
     */
    purchaseState?: number | null;
    /**
     * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
     */
    purchaseTime?: string | null;
    /**
     * 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:   - Test (i.e. purchased from a license testing account)  - Promo (i.e. purchased using a promo code)  - Rewarded (i.e. from watching a video ad instead of paying)
     */
    purchaseType?: number | null;
  }

  export class Resource$Inapppurchases {
    context: APIRequestContext;
    constructor(context: APIRequestContext) {
      this.context = context;
    }

    /**
     * androidpublisher.inapppurchases.get
     * @desc Checks the purchase and consumption status of an inapp item.
     * @example
     * // Before running the sample:
     * // - Enable the API at:
     * //   https://console.developers.google.com/apis/api/androidpublisher.googleapis.com
     * // - Login into gcloud by running:
     * //   `$ gcloud auth application-default login`
     * // - Install the npm module by running:
     * //   `$ npm install googleapis`
     *
     * const {google} = require('googleapis');
     * const androidpublisher = google.androidpublisher('v1.1');
     *
     * async function main() {
     *   const auth = new google.auth.GoogleAuth({
     *     // Scopes can be specified either as an array or as a single, space-delimited string.
     *     scopes: ['https://www.googleapis.com/auth/androidpublisher'],
     *   });
     *
     *   // Acquire an auth client, and bind it to all future calls
     *   const authClient = await auth.getClient();
     *   google.options({auth: authClient});
     *
     *   // Do the magic
     *   const res = await androidpublisher.inapppurchases.get({
     *     // The package name of the application the inapp product was sold in (for example, 'com.some.thing').
     *     packageName: 'placeholder-value',
     *     // The inapp product SKU (for example, 'com.some.thing.inapp1').
     *     productId: 'placeholder-value',
     *     // The token provided to the user's device when the inapp product was purchased.
     *     token: 'placeholder-value',
     *   });
     *   console.log(res.data);
     *
     *   // Example response
     *   // {
     *   //   "consumptionState": 0,
     *   //   "developerPayload": "my_developerPayload",
     *   //   "kind": "my_kind",
     *   //   "orderId": "my_orderId",
     *   //   "purchaseState": 0,
     *   //   "purchaseTime": "my_purchaseTime",
     *   //   "purchaseType": 0
     *   // }
     * }
     *
     * main().catch(e => {
     *   console.error(e);
     *   throw e;
     * });
     *
     * @alias androidpublisher.inapppurchases.get
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing').
     * @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1').
     * @param {string} params.token The token provided to the user's device when the inapp product was purchased.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    get(
      params: Params$Resource$Inapppurchases$Get,
      options: StreamMethodOptions
    ): GaxiosPromise<Readable>;
    get(
      params?: Params$Resource$Inapppurchases$Get,
      options?: MethodOptions
    ): GaxiosPromise<Schema$InappPurchase>;
    get(
      params: Params$Resource$Inapppurchases$Get,
      options: StreamMethodOptions | BodyResponseCallback<Readable>,
      callback: BodyResponseCallback<Readable>
    ): void;
    get(
      params: Params$Resource$Inapppurchases$Get,
      options: MethodOptions | BodyResponseCallback<Schema$InappPurchase>,
      callback: BodyResponseCallback<Schema$InappPurchase>
    ): void;
    get(
      params: Params$Resource$Inapppurchases$Get,
      callback: BodyResponseCallback<Schema$InappPurchase>
    ): void;
    get(callback: BodyResponseCallback<Schema$InappPurchase>): void;
    get(
      paramsOrCallback?:
        | Params$Resource$Inapppurchases$Get
        | BodyResponseCallback<Schema$InappPurchase>
        | BodyResponseCallback<Readable>,
      optionsOrCallback?:
        | MethodOptions
        | StreamMethodOptions
        | BodyResponseCallback<Schema$InappPurchase>
        | BodyResponseCallback<Readable>,
      callback?:
        | BodyResponseCallback<Schema$InappPurchase>
        | BodyResponseCallback<Readable>
    ): void | GaxiosPromise<Schema$InappPurchase> | GaxiosPromise<Readable> {
      let params = (paramsOrCallback ||
        {}) as Params$Resource$Inapppurchases$Get;
      let options = (optionsOrCallback || {}) as MethodOptions;

      if (typeof paramsOrCallback === 'function') {
        callback = paramsOrCallback;
        params = {} as Params$Resource$Inapppurchases$Get;
        options = {};
      }

      if (typeof optionsOrCallback === 'function') {
        callback = optionsOrCallback;
        options = {};
      }

      const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
      const parameters = {
        options: Object.assign(
          {
            url: (
              rootUrl +
              '/androidpublisher/v1.1/applications/{packageName}/inapp/{productId}/purchases/{token}'
            ).replace(/([^:]\/)\/+/g, '$1'),
            method: 'GET',
          },
          options
        ),
        params,
        requiredParams: ['packageName', 'productId', 'token'],
        pathParams: ['packageName', 'productId', 'token'],
        context: this.context,
      };
      if (callback) {
        createAPIRequest<Schema$InappPurchase>(
          parameters,
          callback as BodyResponseCallback<{} | void>
        );
      } else {
        return createAPIRequest<Schema$InappPurchase>(parameters);
      }
    }
  }

  export interface Params$Resource$Inapppurchases$Get
    extends StandardParameters {
    /**
     * The package name of the application the inapp product was sold in (for example, 'com.some.thing').
     */
    packageName?: string;
    /**
     * The inapp product SKU (for example, 'com.some.thing.inapp1').
     */
    productId?: string;
    /**
     * The token provided to the user's device when the inapp product was purchased.
     */
    token?: string;
  }
}

result-matching ""

    No results matching ""