dist¶

Interfaces¶

GooglePlayReviewReplyInput¶

Properties¶

packageName?¶

optional packageName?: string;

replyText¶

replyText: string;

GooglePlayReviewsClient¶

Properties¶

handlers¶

handlers: GooglePlayReviewsOperationHandlers;

rawClient¶

rawClient: Pick<GooglePlayAndroidPublisherClient, "reviews">;

Methods¶

execute()¶

execute<K>(alias, input): Promise<GooglePlayReviewsOperationOutputMap[K]>;

Type Parameters¶

Type Parameter
`K` extends `GooglePlayReviewsOperationAlias`

Parameters¶

Parameter	Type
`alias`	`K`
`input`	`GooglePlayReviewsOperationInputMap`[`K`]

Returns¶

Promise\<GooglePlayReviewsOperationOutputMap[K]>

getReview()¶

getReview(reviewId, input?): Promise<Schema$Review>;

Parameters¶

Parameter	Type
`reviewId`	`string`
`input?`	`GooglePlayReviewsGetInput`

Returns¶

Promise\<Schema$Review>

listReviews()¶

listReviews(input?): Promise<Schema$ReviewsListResponse>;

Parameters¶

Parameter	Type
`input?`	`GooglePlayReviewsListInput`

Returns¶

Promise\<Schema$ReviewsListResponse>

replyToReview()¶

replyToReview(reviewId, input): Promise<Schema$ReviewsReplyResponse>;

Parameters¶

Parameter	Type
`reviewId`	`string`
`input`	`GooglePlayReviewReplyInput`

Returns¶

Promise\<Schema$ReviewsReplyResponse>

GooglePlayReviewsClientOptions¶

Extended by¶

GooglePlayReviewsLiveCheckOptions

Properties¶

accessToken?¶

optional accessToken?: string;

auth?¶

optional auth?: GooglePlaySdkAuth;

getAccessToken?¶

optional getAccessToken?: () => string | Promise<string>;

Returns¶

string | Promise\<string>

packageName¶

packageName: string;

rawClient?¶

optional rawClient?: Pick<GooglePlayAndroidPublisherClient, "reviews">;

scopes?¶

optional scopes?: string[];

serviceAccount?¶

optional serviceAccount?: GooglePlayServiceAccountCredentials;

GooglePlayReviewsCredentialStatusInput¶

Properties¶

accessTokenConfigured?¶

optional accessTokenConfigured?: boolean;

expiresAt?¶

optional expiresAt?: string;

packageName?¶

optional packageName?: string;

scopes?¶

optional scopes?: string[];

serviceAccountConfigured?¶

optional serviceAccountConfigured?: boolean;

tokenSupplierConfigured?¶

optional tokenSupplierConfigured?: boolean;

GooglePlayReviewsGetInput¶

Properties¶

packageName?¶

optional packageName?: string;

translationLanguage?¶

optional translationLanguage?: string;

GooglePlayReviewsListInput¶

Properties¶

maxResults?¶

optional maxResults?: number;

packageName?¶

optional packageName?: string;

startIndex?¶

optional startIndex?: number;

token?¶

optional token?: string;

translationLanguage?¶

optional translationLanguage?: string;

GooglePlayReviewsLiveCheckOptions¶

Extends¶

GooglePlayReviewsClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

GooglePlayReviewsClientOptions.accessToken

auth?¶

optional auth?: GooglePlaySdkAuth;

Inherited from¶

GooglePlayReviewsClientOptions.auth

client?¶

optional client?: Pick<GooglePlayReviewsClient, "listReviews">;

getAccessToken?¶

optional getAccessToken?: () => string | Promise<string>;

Returns¶

string | Promise\<string>

Inherited from¶

GooglePlayReviewsClientOptions.getAccessToken

packageName¶

packageName: string;

Inherited from¶

GooglePlayReviewsClientOptions.packageName

rawClient?¶

optional rawClient?: Pick<GooglePlayAndroidPublisherClient, "reviews">;

Inherited from¶

GooglePlayReviewsClientOptions.rawClient

scopes?¶

optional scopes?: string[];

Inherited from¶

GooglePlayReviewsClientOptions.scopes

serviceAccount?¶

optional serviceAccount?: GooglePlayServiceAccountCredentials;

Inherited from¶

GooglePlayReviewsClientOptions.serviceAccount

GooglePlayReviewsOperationInputMap¶

Properties¶

googleplay.reviews.get¶

googleplay.reviews.get: {
  reviewId: string;
} & GooglePlayReviewsGetInput;

Type Declaration¶

reviewId¶

reviewId: string;

googleplay.reviews.list¶

googleplay.reviews.list: GooglePlayReviewsListInput;

googleplay.reviews.reply¶

googleplay.reviews.reply: {
  reviewId: string;
} & GooglePlayReviewReplyInput;

Type Declaration¶

reviewId¶

reviewId: string;

GooglePlayReviewsOperationOutputMap¶

Properties¶

googleplay.reviews.get¶

googleplay.reviews.get: Schema$Review;

googleplay.reviews.list¶

googleplay.reviews.list: Schema$ReviewsListResponse;

googleplay.reviews.reply¶

googleplay.reviews.reply: Schema$ReviewsReplyResponse;

GooglePlayServiceAccountCredentials¶

Properties¶

clientEmail¶

clientEmail: string;

privateKey¶

privateKey: string;

privateKeyId?¶

optional privateKeyId?: string;

scopes?¶

optional scopes?: string[];

subject?¶

optional subject?: string;

Type Aliases¶

GooglePlayAndroidPublisherClient¶

type GooglePlayAndroidPublisherClient = androidpublisher_v3.Androidpublisher;

GooglePlayReview¶

type GooglePlayReview = androidpublisher_v3.Schema$Review;

GooglePlayReviewReplyResponse¶

type GooglePlayReviewReplyResponse = androidpublisher_v3.Schema$ReviewsReplyResponse;

GooglePlayReviewsListResponse¶

type GooglePlayReviewsListResponse = androidpublisher_v3.Schema$ReviewsListResponse;

GooglePlayReviewsOperationAlias¶

type GooglePlayReviewsOperationAlias =
  | "googleplay.reviews.list"
  | "googleplay.reviews.get"
  | "googleplay.reviews.reply";

GooglePlayReviewsOperationHandler¶

type GooglePlayReviewsOperationHandler<K> = (input) => Promise<GooglePlayReviewsOperationOutputMap[K]>;

Type Parameters¶

Type Parameter
`K` extends `GooglePlayReviewsOperationAlias`

Parameters¶

Parameter	Type
`input`	`GooglePlayReviewsOperationInputMap`[`K`]

Returns¶

Promise\<GooglePlayReviewsOperationOutputMap[K]>

GooglePlayReviewsOperationHandlers¶

type GooglePlayReviewsOperationHandlers = { [K in GooglePlayReviewsOperationAlias]: GooglePlayReviewsOperationHandler<K> };

GooglePlaySdkAuth¶

type GooglePlaySdkAuth = Exclude<NonNullable<androidpublisher_v3.Params$Resource$Reviews$List["auth"]>, string>;

Variables¶

googlePlayReviewsIntegration¶

const googlePlayReviewsIntegration: DefinedIntegration<{
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences?: ("customer-facing" | "internal-support" | "mixed")[];
  coverage?: {
     evidence?: {
        label: string;
        url?: string;
     }[];
     notes?: string[];
     scope?:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements?: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required?: boolean;
     scopes?: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "bidirectional"
     | "inbound-only"
    | "outbound-only")[];
  id: string;
  limitations?: string[];
  maintainers?: {
     name: string;
     type?: "official" | "community" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations?: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes?: string[];
  provider: string;
  trustLevel?: "official" | "community" | "verified" | "experimental";
}, unknown, never>;

googlePlayReviewsOperationHandlers¶

const googlePlayReviewsOperationHandlers: typeof createGooglePlayReviewsOperationHandlers;

Functions¶

createGooglePlayReviewsClient()¶

function createGooglePlayReviewsClient(options): GooglePlayReviewsClient;

Parameters¶

Parameter	Type
`options`	`GooglePlayReviewsClientOptions`

Returns¶

GooglePlayReviewsClient

createGooglePlayReviewsIntegration()¶

function createGooglePlayReviewsIntegration(options): DefinedIntegration<{
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences?: ("customer-facing" | "internal-support" | "mixed")[];
  coverage?: {
     evidence?: {
        label: string;
        url?: string;
     }[];
     notes?: string[];
     scope?:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements?: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required?: boolean;
     scopes?: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations?: string[];
  maintainers?: {
     name: string;
     type?: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations?: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes?: string[];
  provider: string;
  trustLevel?: "community" | "official" | "verified" | "experimental";
}, unknown, IntegrationOperationHandlers>;

Parameters¶

Parameter	Type
`options`	`GooglePlayReviewsClientOptions`

Returns¶

DefinedIntegration\<{ capabilities: { audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[]; category: string; channelAudiences?: ("customer-facing" | "internal-support" | "mixed")[]; coverage?: { evidence?: { label: string; url?: string; }[]; notes?: string[]; scope?: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; }; credentialRequirements?: { description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required?: boolean; scopes?: string[]; }[]; directions: ( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[]; id: string; limitations?: string[]; maintainers?: { name: string; type?: "community" | "official" | "unknown" | "partner"; url?: string; }[]; metadata?: Record\<string, unknown>; name: string; operations?: { alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[]; packageName: string; privacyNotes?: string[]; provider: string; trustLevel?: "community" | "official" | "verified" | "experimental"; }, unknown, IntegrationOperationHandlers>

createGooglePlayReviewsLiveChecks()¶

function createGooglePlayReviewsLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        hasNextPage: boolean;
        reviewCount: number;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options`	`GooglePlayReviewsLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { hasNextPage: boolean; reviewCount: number; }; }>; }[]

createGooglePlayReviewsOperationHandlers()¶

function createGooglePlayReviewsOperationHandlers(options): GooglePlayReviewsOperationHandlers;

Parameters¶

Parameter	Type
`options`	`GooglePlayReviewsClientOptions`

Returns¶

GooglePlayReviewsOperationHandlers

googlePlayReviewsCredentialStatuses()¶

function googlePlayReviewsCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`GooglePlayReviewsCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]