
google search console api(原webmasters api)的发现文档进行了强制性更新,要求所有使用旧版webmasters/v3服务的项目在2021年11月1日前完成迁移。未及时更新的项目将不再受支持,并可能停止工作。此次更新的核心在于将api服务名称从webmasters变更为searchconsole,并将版本从v3更新为v1。同时,用于发现api的url也发生了变化。
主要变更点:
以下将详细说明在不同客户端库中如何进行这些必要的更新。
对于使用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 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);
// });
});重要提示:
此次Google Search Console API的更新是强制性的,为确保您的应用程序持续稳定运行,请务必在截止日期前完成迁移。
通过遵循上述指南,您可以顺利完成Google Search Console API的迁移,确保您的应用程序能够无缝地与最新版本的API进行交互。
以上就是更新Google Search Console API发现文档指南的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号