@maxim_mazurok/gapi.client.adexperiencereport-v1 0.0.20220715

package/index.d.ts

@@ -0,0 +1,118 @@
+/* Type definitions for non-npm package Ad Experience Report API v1 0.0 */
+// Project: https://developers.google.com/ad-experience-report/
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.8
+
+// 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
+// Generated from: https://adexperiencereport.googleapis.com/$discovery/rest?version=v1
+// Revision: 20220715
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Ad Experience Report API v1 */
+    function load(urlOrObject: "https://adexperiencereport.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "adexperiencereport", version: "v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "adexperiencereport", version: "v1", callback: () => any): void;
+
+    namespace adexperiencereport {
+        interface PlatformSummary {
+            /** The site's Ad Experience Report status on this platform. */
+            betterAdsStatus?: string;
+            /** The time at which [enforcement](https://support.google.com/webtools/answer/7308033) against the site began or will begin on this platform. Not set when the filter_status is OFF. */
+            enforcementTime?: string;
+            /** The site's [enforcement status](https://support.google.com/webtools/answer/7308033) on this platform. */
+            filterStatus?: string;
+            /** The time at which the site's status last changed on this platform. */
+            lastChangeTime?: string;
+            /** The site's regions on this platform. No longer populated, because there is no longer any semantic difference between sites in different regions. */
+            region?: string[];
+            /**
+             * A link to the full Ad Experience Report for the site on this platform.. Not set in ViolatingSitesResponse. Note that you must complete the [Search Console verification
+             * process](https://support.google.com/webmasters/answer/9008080) for the site before you can access the full report.
+             */
+            reportUrl?: string;
+            /** Whether the site is currently under review on this platform. */
+            underReview?: boolean;
+        }
+        interface SiteSummaryResponse {
+            /** The site's Ad Experience Report summary on desktop. */
+            desktopSummary?: PlatformSummary;
+            /** The site's Ad Experience Report summary on mobile. */
+            mobileSummary?: PlatformSummary;
+            /** The name of the reviewed site, e.g. `google.com`. */
+            reviewedSite?: string;
+        }
+        interface ViolatingSitesResponse {
+            /** The list of violating sites. */
+            violatingSites?: SiteSummaryResponse[];
+        }
+        interface SitesResource {
+            /** Gets a site's Ad Experience Report summary. */
+            get(request?: {
+                /** 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;
+                /** Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F%2Fwww.google.com%2F`. Format: `sites/{site}` */
+                name: 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<SiteSummaryResponse>;
+        }
+        interface ViolatingSitesResource {
+            /** Lists sites that are failing in the Ad Experience Report on at least one platform. */
+            list(request?: {
+                /** 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<ViolatingSitesResponse>;
+        }
+
+        const sites: SitesResource;
+
+        const violatingSites: ViolatingSitesResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.adexperiencereport-v1",
+  "version": "0.0.20220715",
+  "description": "TypeScript typings for Ad Experience Report API v1",
+  "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,57 @@
+# TypeScript typings for Ad Experience Report API v1
+
+Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads.
+For detailed description please check [documentation](https://developers.google.com/ad-experience-report/).
+
+## Installing
+
+Install typings for Ad Experience Report API:
+
+```
+npm install @types/gapi.client.adexperiencereport-v1 --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://adexperiencereport.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.adexperiencereport
+});
+```
+
+```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('adexperiencereport', 'v1', () => {
+  // now we can use:
+  // gapi.client.adexperiencereport
+});
+```
+
+
+
+After that you can use Ad Experience Report API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Gets a site's Ad Experience Report summary.
+*/
+await gapi.client.adexperiencereport.sites.get({ name: "name",  });
+
+/*
+Lists sites that are failing in the Ad Experience Report on at least one platform.
+*/
+await gapi.client.adexperiencereport.violatingSites.list({  });
+```

package/tests.ts

@@ -0,0 +1,25 @@
+/* This is stub file for gapi.client.adexperiencereport-v1 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: 20220715
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://adexperiencereport.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.adexperiencereport */
+
+    run();
+
+    async function run() {
+        /** Gets a site's Ad Experience Report summary. */
+        await gapi.client.adexperiencereport.sites.get({
+            name: "Test string",
+        });
+        /** Lists sites that are failing in the Ad Experience Report on at least one platform. */
+        await gapi.client.adexperiencereport.violatingSites.list({
+        });
+    }
+});

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
+    }
+}