# @maxim\_mazurok/gapi\.client\.searchconsole-v1 中文文档

规范地址：https://npmcn.com/package/%40maxim_mazurok/gapi.client.searchconsole-v1/

版本：0\.3\.20261031
npm 元数据更新时间：2026-11-01T18:31:50.576Z
中文译文更新时间：2026-11-01T20:14:26.107Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40maxim_mazurok/gapi.client.searchconsole-v1
原文对照：https://npmcn.com/package/%40maxim_mazurok/gapi.client.searchconsole-v1/?lang=original
项目主页：https://github.com/Maxim-Mazurok/google-api-typings-generator#readme
源码仓库：https://github.com/Maxim-Mazurok/google-api-typings-generator

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：61.6 kB，3 个文件
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-08-14T02:24:43.581Z
- 最新版本发布：2026-11-01T18:31:50.263Z
- 已发布版本数：729（近 12 个月 161 个）

## 中文简介

谷歌搜索控制台API v1的TypeScript类型

## 安装

```sh
npm install @maxim_mazurok/gapi.client.searchconsole-v1
```

也可以使用：`pnpm add @maxim_mazurok/gapi.client.searchconsole-v1`、`yarn add @maxim_mazurok/gapi.client.searchconsole-v1`、`bun add @maxim_mazurok/gapi.client.searchconsole-v1`

## README

# 谷歌搜索控制台API v1的TypeScript类型

搜索控制台API提供对搜索控制台数据（仅限经过验证的用户）和基于URL的公共信息（任何人）的访问。 详细说明请查看 [文档](https://developers.google.com/webmaster-tools/about).

## 安装

安装谷歌搜索控制台API的类型：

```
npm install @types/gapi.client.searchconsole-v1 --save-dev
```

## 打印稿6.0 +

TypeScript 6.0更改 `types` 默认为 `[]`． 中显式列出类型包 `tsconfig.json`：

```json
{
  "compilerOptions": {
    "types": [
      "gapi",
      "gapi.auth2",
      "gapi.client",
      "gapi.client.searchconsole-v1"
    ]
  }
}
```

## 使用

你需要在你的代码中初始化谷歌API客户端：

```typescript
gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});
```

然后加载api客户端包装器：

```typescript
gapi.client.load(
  'https://searchconsole.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.searchconsole
    // gapi.client.webmasters
  },
);
```

```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('searchconsole', 'v1', () => {
  // now we can use:
  // gapi.client.searchconsole
  // gapi.client.webmasters
});
```

在向资源发送任何请求之前，不要忘记验证您的客户端：

```typescript
// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // View and manage Search Console data for your verified sites
    'https://www.googleapis.com/auth/webmasters',

    // View Search Console data for your verified sites
    'https://www.googleapis.com/auth/webmasters.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 */
    }
  },
);
```

之后，您可以使用谷歌搜索控制台API资源：

```typescript
/*
Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.
*/
await gapi.client.webmasters.searchanalytics.query({siteUrl: 'siteUrl'});

/*
Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.
*/
await gapi.client.webmasters.sitemaps.delete({
  feedpath: 'feedpath',
  siteUrl: 'siteUrl',
});

/*
Retrieves information about a specific sitemap.
*/
await gapi.client.webmasters.sitemaps.get({
  feedpath: 'feedpath',
  siteUrl: 'siteUrl',
});

/*
 Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).
*/
await gapi.client.webmasters.sitemaps.list({siteUrl: 'siteUrl'});

/*
Submits a sitemap for a site.
*/
await gapi.client.webmasters.sitemaps.submit({
  feedpath: 'feedpath',
  siteUrl: 'siteUrl',
});

/*
 Adds a site to the set of the user's sites in Search Console.
*/
await gapi.client.webmasters.sites.add({siteUrl: 'siteUrl'});

/*
 Removes a site from the set of the user's Search Console sites.
*/
await gapi.client.webmasters.sites.delete({siteUrl: 'siteUrl'});

/*
 Retrieves information about specific site.
*/
await gapi.client.webmasters.sites.get({siteUrl: 'siteUrl'});

/*
 Lists the user's Search Console sites.
*/
await gapi.client.webmasters.sites.list({});
```

有关来源信息，请参见 [NPM的出处部分](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.searchconsole-v1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)

## 常见问题

### @maxim\_mazurok/gapi\.client\.searchconsole-v1 是什么？

谷歌搜索控制台API v1的TypeScript类型

### 如何安装 @maxim\_mazurok/gapi\.client\.searchconsole-v1？

在项目目录运行 npm install @maxim\_mazurok/gapi\.client\.searchconsole-v1，或使用 pnpm add / yarn add / bun add。

### @maxim\_mazurok/gapi\.client\.searchconsole-v1 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @maxim\_mazurok/gapi\.client\.searchconsole-v1 可以商用吗？

@maxim\_mazurok/gapi\.client\.searchconsole-v1 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @maxim\_mazurok/gapi\.client\.searchconsole-v1 还在维护吗？

最新版本 0\.3\.20261031 发布于 2026/11/02（1 天前）；至今共发布 729 个版本，其中过去 12 个月发布了 161 个；首次发布于 2022/08/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。