googleapis
Version:
Google APIs Client Library for Node.js
312 lines (311 loc) • 12.2 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace playgrouping_v1alpha1 {
export interface Options extends GlobalOptions {
version: 'v1alpha1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: 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;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Play Grouping API
*
* playgrouping.googleapis.com API.
*
* @example
* ```js
* const {google} = require('googleapis');
* const playgrouping = google.playgrouping('v1alpha1');
* ```
*/
export class Playgrouping {
context: APIRequestContext;
apps: Resource$Apps;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request message for CreateOrUpdateTags. VerifyToken.
*/
export interface Schema$CreateOrUpdateTagsRequest {
/**
* Tags to be inserted or updated.
*/
tags?: Schema$Tag[];
}
/**
* Response message for CreateOrUpdateTags.
*/
export interface Schema$CreateOrUpdateTagsResponse {
/**
* All requested tags are returned, including pre-existing ones.
*/
tags?: Schema$Tag[];
}
/**
* A tag is associated with exactly one package name and user.
*/
export interface Schema$Tag {
/**
* A boolean value of the tag.
*/
booleanValue?: boolean | null;
/**
* A signed 64-bit integer value of the tag.
*/
int64Value?: string | null;
/**
* Required. Key for the tag.
*/
key?: string | null;
/**
* A string value of the tag.
*/
stringValue?: string | null;
/**
* A time value of the tag.
*/
timeValue?: string | null;
}
/**
* Request message for VerifyToken.
*/
export interface Schema$VerifyTokenRequest {
/**
* Required. Persona represented by the token. Format: personas/{persona\}
*/
persona?: string | null;
}
/**
* Response message for VerifyToken.
*/
export interface Schema$VerifyTokenResponse {
}
export class Resource$Apps {
context: APIRequestContext;
tokens: Resource$Apps$Tokens;
constructor(context: APIRequestContext);
}
export class Resource$Apps$Tokens {
context: APIRequestContext;
tags: Resource$Apps$Tokens$Tags;
constructor(context: APIRequestContext);
/**
* Verify an API token by asserting the app and persona it belongs to. The verification is a protection against client-side attacks and will fail if the contents of the token don't match the provided values. A token must be verified before it can be used to manipulate user tags.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/playgrouping.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const playgrouping = google.playgrouping('v1alpha1');
*
* 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: [],
* });
*
* // 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 playgrouping.apps.tokens.verify({
* // Required. App the token belongs to. Format: apps/{package_name\}
* appPackage: 'apps/my-app',
* // Required. The token to be verified. Format: tokens/{token\}
* token: 'tokens/my-token',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "persona": "my_persona"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
verify(params: Params$Resource$Apps$Tokens$Verify, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
verify(params?: Params$Resource$Apps$Tokens$Verify, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$VerifyTokenResponse>>;
verify(params: Params$Resource$Apps$Tokens$Verify, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
verify(params: Params$Resource$Apps$Tokens$Verify, options: MethodOptions | BodyResponseCallback<Schema$VerifyTokenResponse>, callback: BodyResponseCallback<Schema$VerifyTokenResponse>): void;
verify(params: Params$Resource$Apps$Tokens$Verify, callback: BodyResponseCallback<Schema$VerifyTokenResponse>): void;
verify(callback: BodyResponseCallback<Schema$VerifyTokenResponse>): void;
}
export interface Params$Resource$Apps$Tokens$Verify extends StandardParameters {
/**
* Required. App the token belongs to. Format: apps/{package_name\}
*/
appPackage?: string;
/**
* Required. The token to be verified. Format: tokens/{token\}
*/
token?: string;
/**
* Request body metadata
*/
requestBody?: Schema$VerifyTokenRequest;
}
export class Resource$Apps$Tokens$Tags {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Create or update tags for the user and app that are represented by the given token.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/playgrouping.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const playgrouping = google.playgrouping('v1alpha1');
*
* 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: [],
* });
*
* // 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 playgrouping.apps.tokens.tags.createOrUpdate({
* // Required. App whose tags are being manipulated. Format: apps/{package_name\}
* appPackage: 'apps/my-app',
* // Required. Token for which the tags are being inserted or updated. Format: tokens/{token\}
* token: 'tokens/my-token',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "tags": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "tags": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
createOrUpdate(params: Params$Resource$Apps$Tokens$Tags$Createorupdate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
createOrUpdate(params?: Params$Resource$Apps$Tokens$Tags$Createorupdate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$CreateOrUpdateTagsResponse>>;
createOrUpdate(params: Params$Resource$Apps$Tokens$Tags$Createorupdate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
createOrUpdate(params: Params$Resource$Apps$Tokens$Tags$Createorupdate, options: MethodOptions | BodyResponseCallback<Schema$CreateOrUpdateTagsResponse>, callback: BodyResponseCallback<Schema$CreateOrUpdateTagsResponse>): void;
createOrUpdate(params: Params$Resource$Apps$Tokens$Tags$Createorupdate, callback: BodyResponseCallback<Schema$CreateOrUpdateTagsResponse>): void;
createOrUpdate(callback: BodyResponseCallback<Schema$CreateOrUpdateTagsResponse>): void;
}
export interface Params$Resource$Apps$Tokens$Tags$Createorupdate extends StandardParameters {
/**
* Required. App whose tags are being manipulated. Format: apps/{package_name\}
*/
appPackage?: string;
/**
* Required. Token for which the tags are being inserted or updated. Format: tokens/{token\}
*/
token?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateOrUpdateTagsRequest;
}
export {};
}