GoogleSearchConsoleAPI更新指南

本文档提供了一份详尽的Google Search Console API更新指南，旨在帮助开发者顺利完成从旧版webmasters/v3到新版searchconsole/v1的迁移。**Google Search Console API强制更新，2021年11月1日后旧版将停止支持！** 详细介绍了如何更新Google API PHP Client和JavaScript Client库，包括修改服务实例化方式、更新API调用参数以及调整发现文档URL。确保您的应用在截止日期前完成更新，避免服务中断。本文还提供了代码示例和注意事项，帮助开发者全面检查代码、充分测试，并持续关注Google官方公告，确保应用程序与最新API版本无缝对接。立即行动，保障您的网站数据分析服务！

Google Search Console API发现文档更新概览

Google Search Console API（原Webmasters API）的发现文档进行了强制性更新，要求所有使用旧版webmasters/v3服务的项目在2021年11月1日前完成迁移。未及时更新的项目将不再受支持，并可能停止工作。此次更新的核心在于将API服务名称从webmasters变更为searchconsole，并将版本从v3更新为v1。同时，用于发现API的URL也发生了变化。

主要变更点：

• 旧发现文档URL: https://www.googleapis.com/discovery/v1/apis/webmasters/v3/rest
• 新发现文档URL: https://searchconsole.googleapis.com/$discovery/rest
• 旧服务名称/版本: webmasters/v3
• 新服务名称/版本: searchconsole/v1

以下将详细说明在不同客户端库中如何进行这些必要的更新。

使用Google API PHP Client库的更新

对于使用googleapis/google-api-php-client库的PHP项目，核心的改动在于服务对象的实例化。尽管PHP客户端库通常会自动处理发现文档的获取，但您需要将代码中对旧Webmasters服务的引用更新为新的SearchConsole服务。

旧的API调用示例：

use Google\Client;
use Google\Service\Webmasters\SearchAnalyticsQueryRequest; // 注意这里的Webmasters

// ... 省略客户端初始化和认证代码 ...

$googlewebmasterssearchsnalyticsobject = new \Google_Service_Webmasters_SearchAnalyticsQueryRequest(); // 使用Webmasters服务类
$googlewebmasterssearchsnalyticsobject->setStartDate('1970-01-01');
$endDate = gmdate('Y-m-d');
$googlewebmasterssearchsnalyticsobject->setEndDate($endDate);
$googlewebmasterssearchsnalyticsobject->setDimensions(['page', 'date']);
$googlewebmasterssearchsnalyticsobject->setSearchType('web');
// ... 其他查询参数设置 ...

更新后的API调用示例：

您需要将代码中所有引用Google_Service_Webmasters或其子类的部分替换为Google_Service_SearchConsole。

use Google\Client;
use Google\Service\SearchConsole\SearchAnalyticsQueryRequest; // 注意这里的SearchConsole

// ... 省略客户端初始化和认证代码 ...

// 实例化新的Search Console服务对象
// 如果您的库版本较新，可能直接实例化Google_Service_SearchConsole即可
// 如果您直接使用了SearchAnalyticsQueryRequest，则需要修改其命名空间
$googleSearchConsoleService = new \Google_Service_SearchConsole($client); // 示例：实例化服务
// 然后使用该服务对象调用方法，例如：
$searchAnalyticsQueryRequest = new SearchAnalyticsQueryRequest(); // 使用新的SearchConsole命名空间下的请求类
$searchAnalyticsQueryRequest->setStartDate('1970-01-01');
$endDate = gmdate('Y-m-d');
$searchAnalyticsQueryRequest->setEndDate($endDate);
$searchAnalyticsQueryRequest->setDimensions(['page', 'date']);
$searchAnalyticsQueryRequest->setSearchType('web');

// 假设您正在调用Search Analytics API的query方法
// $response = $googleSearchConsoleService->searchanalytics->query($siteUrl, $searchAnalyticsQueryRequest);

重要提示：

• 确保您的google-api-php-client库已更新到最新版本，以支持新的SearchConsole服务。您可以通过Composer运行composer update google/apiclient来更新。
• 检查代码中所有直接或间接引用Webmasters服务的地方，并进行相应的替换。

使用Google API JavaScript Client库的更新

对于使用Google API JavaScript客户端库（gapi.client）的项目，更新主要集中在gapi.client.load函数的参数上。

旧的API加载方式：

gapi.client.load('webmasters', 'v3').then(function() {
    // ... API调用逻辑 ...
});

更新后的API加载方式：

您需要将服务名称从webmasters更改为searchconsole，并将版本从v3更改为v1。

gapi.client.load('searchconsole', 'v1').then(function() {
    // ... API调用逻辑 ...
    // 例如，调用searchanalytics.query方法：
    // gapi.client.searchconsole.searchanalytics.query({
    //     siteUrl: 'https://example.com/',
    //     resource: {
    //         startDate: '2023-01-01',
    //         endDate: '2023-01-31',
    //         dimensions: ['page', 'date']
    //     }
    // }).then(function(response) {
    //     console.log(response.result);
    // });
});

重要提示：

• 对于JavaScript客户端，如果之前没有明确指定discoveryDocs参数，客户端会自动从默认位置加载。更新后，gapi.client.load函数会根据新的服务名称和版本加载对应的发现文档。
• 验证您的JavaScript客户端库版本是否支持新的searchconsole/v1服务。

总结与注意事项

此次Google Search Console API的更新是强制性的，为确保您的应用程序持续稳定运行，请务必在截止日期前完成迁移。

1. 更新客户端库： 无论您使用PHP、JavaScript还是其他语言的Google API客户端库，强烈建议将其更新到最新版本。新版本通常会包含对最新API的支持和必要的内部调整。
2. 全面检查代码： 仔细审查您的整个项目代码库，查找所有引用旧webmasters/v3服务的地方，并将其替换为searchconsole/v1。这可能包括服务实例化、API调用方法以及任何硬编码的服务名称或版本字符串。
3. 充分测试： 在部署到生产环境之前，务必在新配置下对所有相关的API功能进行彻底的测试，以确保数据获取和操作的正确性。
4. 关注Google官方公告： 持续关注Google Webmasters或Search Console官方博客和文档，以获取未来API更新和最佳实践的最新信息。

通过遵循上述指南，您可以顺利完成Google Search Console API的迁移，确保您的应用程序能够无缝地与最新版本的API进行交互。

今天关于《GoogleSearchConsoleAPI更新指南》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！