@7nohe/play-console-report-client

Node.js library for getting report data from Google Play Console

Install

1$ npm install @7nohe/play-console-report-client

Usage

1import { createClient } from "@7nohe/play-console-report-client";
2
3const client = createClient({
4  projectId: '<YOUR-PROJECT-ID>',
5  credentials: {
6    client_email: '<YOUR-CLIENT-EMAIL>',
7    private_key: '<YOUR-PRIVATE-KEY>',
8  },
9});
10
11const run = async () => {
12  const statisticsReports = await client.getStatisticsReports({
13    reportMonth: "202207",
14    bucketName: '<YOUR-BUCKET-NAME>',
15    packageName: '<YOUR-PACKAGE-NAME>',
16  });
17  console.log(statisticsReports); 
18}
19
20run();

credentials

You can get credential information (client_email and private_key) from a service account key.

Here is a guide to creating a service account key.

Also, you need to enable Google Play Developer API.

bucketName

You can find your bucket name in Play Console.

Click Download reports Reports, and select Reviews, Statistics, or Financial.

You can copy your Google Cloud Storage URI by clicking the Copy Cloud Storage URI button next to the corresponding section header on the Download reports pages.

Your Google Cloud Storage URI should look like this.

gs://<YOUR-BUCKET-NAME>/stats/installs/

Accessing to Google Cloud resources without using a service account key

If your environment supports OpenID Connect (OIDC), we recommend using Workload identity federation.

You will be able to access GCP resources without storing credentials in your environment.

1import { createClient } from "@7nohe/play-console-report-client";
2
3const client = createClient({
4  projectId: '<YOUR-PROJECT-ID>',
5  // No credentials required.
6});

API Documentation

Currently, only Statistics Reports API is available.

1declare const createClient: (clientOptions: ClientOptions) => {
2    getStatisticsReports: (options: GetStatisticsReportsOptions) => Promise<StatisticsReportData[]>;
3};