@maxim_mazurok/gapi.client.adsense-v2 0.0.20220811

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.adsense-v2",
+  "version": "0.0.20220811",
+  "description": "TypeScript typings for AdSense Management API v2",
+  "license": "MIT",
+  "author": {
+    "email": "maxim@mazurok.com",
+    "name": "Maxim Mazurok",
+    "url": "https://maxim.mazurok.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,86 @@
+# TypeScript typings for AdSense Management API v2
+
+The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.
+For detailed description please check [documentation](https://developers.google.com/adsense/management/).
+
+## Installing
+
+Install typings for AdSense Management API:
+
+```
+npm install @types/gapi.client.adsense-v2 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load('https://adsense.googleapis.com/$discovery/rest?version=v2', () => {
+  // now we can use:
+  // gapi.client.adsense
+});
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('adsense', 'v2', () => {
+  // now we can use:
+  // gapi.client.adsense
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+      // View and manage your AdSense data
+      'https://www.googleapis.com/auth/adsense',
+
+      // View your AdSense data
+      'https://www.googleapis.com/auth/adsense.readonly',
+    ],
+    immediate = true;
+// ...
+
+gapi.auth.authorize(
+  { client_id: client_id, scope: scope, immediate: immediate },
+  authResult => {
+    if (authResult && !authResult.error) {
+        /* handle successful authorization */
+    } else {
+        /* handle authorization error */
+    }
+});
+```
+
+After that you can use AdSense Management API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Gets information about the selected AdSense account.
+*/
+await gapi.client.adsense.accounts.get({ name: "name",  });
+
+/*
+Lists all accounts available to this user.
+*/
+await gapi.client.adsense.accounts.list({  });
+
+/*
+Lists all accounts directly managed by the given AdSense account.
+*/
+await gapi.client.adsense.accounts.listChildAccounts({ parent: "parent",  });
+```

package/tests.ts

@@ -0,0 +1,211 @@
+/* This is stub file for gapi.client.adsense-v2 definition tests */
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+
+// Revision: 20220811
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://adsense.googleapis.com/$discovery/rest?version=v2');
+    /** now we can use gapi.client.adsense */
+
+    /** don't forget to authenticate your client before sending any request to resources: */
+    /** declare client_id registered in Google Developers Console */
+    const client_id = '<<PUT YOUR CLIENT ID HERE>>';
+    const scope = [
+        /** View and manage your AdSense data */
+        'https://www.googleapis.com/auth/adsense',
+        /** View your AdSense data */
+        'https://www.googleapis.com/auth/adsense.readonly',
+    ];
+    const immediate = false;
+    gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
+        if (authResult && !authResult.error) {
+            /** handle successful authorization */
+            run();
+        } else {
+            /** handle authorization error */
+        }
+    });
+
+    async function run() {
+        /** Gets information about the selected AdSense account. */
+        await gapi.client.adsense.accounts.get({
+            name: "Test string",
+        });
+        /** Lists all accounts available to this user. */
+        await gapi.client.adsense.accounts.list({
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /** Lists all accounts directly managed by the given AdSense account. */
+        await gapi.client.adsense.accounts.listChildAccounts({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Gets the ad client from the given resource name. */
+        await gapi.client.adsense.accounts.adclients.get({
+            name: "Test string",
+        });
+        /**
+         * Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more
+         * information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
+         */
+        await gapi.client.adsense.accounts.adclients.getAdcode({
+            name: "Test string",
+        });
+        /** Lists all the ad clients available in an account. */
+        await gapi.client.adsense.accounts.adclients.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Gets an ad unit from a specified account and ad client. */
+        await gapi.client.adsense.accounts.adclients.adunits.get({
+            name: "Test string",
+        });
+        /**
+         * Gets the ad unit code for a given ad unit. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634) and [Where to place the ad code in your
+         * HTML](https://support.google.com/adsense/answer/9190028).
+         */
+        await gapi.client.adsense.accounts.adclients.adunits.getAdcode({
+            name: "Test string",
+        });
+        /** Lists all ad units under a specified account and ad client. */
+        await gapi.client.adsense.accounts.adclients.adunits.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Lists all the custom channels available for an ad unit. */
+        await gapi.client.adsense.accounts.adclients.adunits.listLinkedCustomChannels({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Gets information about the selected custom channel. */
+        await gapi.client.adsense.accounts.adclients.customchannels.get({
+            name: "Test string",
+        });
+        /** Lists all the custom channels available in an ad client. */
+        await gapi.client.adsense.accounts.adclients.customchannels.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Lists all the ad units available for a custom channel. */
+        await gapi.client.adsense.accounts.adclients.customchannels.listLinkedAdUnits({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Gets information about the selected url channel. */
+        await gapi.client.adsense.accounts.adclients.urlchannels.get({
+            name: "Test string",
+        });
+        /** Lists active url channels. */
+        await gapi.client.adsense.accounts.adclients.urlchannels.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Lists all the alerts available in an account. */
+        await gapi.client.adsense.accounts.alerts.list({
+            languageCode: "Test string",
+            parent: "Test string",
+        });
+        /** Lists all the payments available for an account. */
+        await gapi.client.adsense.accounts.payments.list({
+            parent: "Test string",
+        });
+        /** Generates an ad hoc report. */
+        await gapi.client.adsense.accounts.reports.generate({
+            account: "Test string",
+            currencyCode: "Test string",
+            dateRange: "Test string",
+            dimensions: "Test string",
+            "endDate.day": 42,
+            "endDate.month": 42,
+            "endDate.year": 42,
+            filters: "Test string",
+            languageCode: "Test string",
+            limit: 42,
+            metrics: "Test string",
+            orderBy: "Test string",
+            reportingTimeZone: "Test string",
+            "startDate.day": 42,
+            "startDate.month": 42,
+            "startDate.year": 42,
+        });
+        /** Generates a csv formatted ad hoc report. */
+        await gapi.client.adsense.accounts.reports.generateCsv({
+            account: "Test string",
+            currencyCode: "Test string",
+            dateRange: "Test string",
+            dimensions: "Test string",
+            "endDate.day": 42,
+            "endDate.month": 42,
+            "endDate.year": 42,
+            filters: "Test string",
+            languageCode: "Test string",
+            limit: 42,
+            metrics: "Test string",
+            orderBy: "Test string",
+            reportingTimeZone: "Test string",
+            "startDate.day": 42,
+            "startDate.month": 42,
+            "startDate.year": 42,
+        });
+        /** Gets the saved report from the given resource name. */
+        await gapi.client.adsense.accounts.reports.getSaved({
+            name: "Test string",
+        });
+        /** Generates a saved report. */
+        await gapi.client.adsense.accounts.reports.saved.generate({
+            currencyCode: "Test string",
+            dateRange: "Test string",
+            "endDate.day": 42,
+            "endDate.month": 42,
+            "endDate.year": 42,
+            languageCode: "Test string",
+            name: "Test string",
+            reportingTimeZone: "Test string",
+            "startDate.day": 42,
+            "startDate.month": 42,
+            "startDate.year": 42,
+        });
+        /** Generates a csv formatted saved report. */
+        await gapi.client.adsense.accounts.reports.saved.generateCsv({
+            currencyCode: "Test string",
+            dateRange: "Test string",
+            "endDate.day": 42,
+            "endDate.month": 42,
+            "endDate.year": 42,
+            languageCode: "Test string",
+            name: "Test string",
+            reportingTimeZone: "Test string",
+            "startDate.day": 42,
+            "startDate.month": 42,
+            "startDate.year": 42,
+        });
+        /** Lists saved reports. */
+        await gapi.client.adsense.accounts.reports.saved.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Gets information about the selected site. */
+        await gapi.client.adsense.accounts.sites.get({
+            name: "Test string",
+        });
+        /** Lists all the sites available in an account. */
+        await gapi.client.adsense.accounts.sites.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+    }
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictFunctionTypes": true
+    },
+    "files": ["index.d.ts", "tests.ts"]
+}

package/tslint.json

@@ -0,0 +1,6 @@
+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "no-redundant-jsdoc": false
+    }
+}