Google Search Console API 项目教程

Google Search Console API 项目教程

google-searchconsole A wrapper for the Google Search Console API. 项目地址: https://gitcode.com/gh_mirrors/go/google-searchconsole

1. 项目的目录结构及介绍

google-searchconsole/
├── auth/
│   └── tar.enc
├── tests/
│   └── tests.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── searchconsole/
    ├── __init__.py
    └── searchconsole.py

目录结构介绍

• auth/: 包含用于身份验证的加密文件。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。
• searchconsole/: 项目的主要代码目录，包含 __init__.py 和 searchconsole.py 文件。

2. 项目的启动文件介绍

项目的启动文件是 searchconsole/searchconsole.py。这个文件包含了与 Google Search Console API 交互的主要逻辑。

主要功能

• 身份验证: 提供了多种身份验证方式，包括 OAuth2 流和存储的凭据文件。
• 查询: 提供了便捷的接口来查询搜索分析数据，支持按日期范围和维度过滤。
• 导出: 支持将查询结果导出为 JSON 或 pandas DataFrame 格式。

使用示例

import searchconsole

# 使用客户端配置文件进行身份验证
account = searchconsole.authenticate(client_config='client_secrets.json')

# 选择一个网站属性
webproperty = account['https://www.example.com/']

# 查询过去7天的搜索分析数据
report = webproperty.query.range('today', days=-7).dimension('query').get()

# 打印查询结果
print(report.rows)

3. 项目的配置文件介绍

1. client_secrets.json

这个文件包含了用于 OAuth2 身份验证的客户端配置信息。通常需要在 Google Developers Console 中创建一个项目，并生成这个文件。

2. requirements.txt

这个文件列出了项目依赖的 Python 包。使用以下命令安装依赖：

pip install -r requirements.txt

3. setup.py

这个文件用于项目的安装和分发。可以通过以下命令安装项目：

pip install .

4. .gitignore

这个文件指定了哪些文件或目录不需要被 Git 管理，例如生成的凭据文件和虚拟环境目录。

5. LICENSE

这个文件包含了项目的开源许可证信息，通常是 MIT 许可证。

6. README.md

这个文件包含了项目的介绍和使用说明，帮助用户快速上手项目。

通过以上介绍，您应该能够了解 google-searchconsole 项目的基本结构和使用方法。希望这个教程对您有所帮助！

google-searchconsole A wrapper for the Google Search Console API. 项目地址: https://gitcode.com/gh_mirrors/go/google-searchconsole