
google my business business information api 是 google 提供的用于管理 google 商家资料的最新接口。它允许开发者以编程方式访问和更新商家信息,包括地点详情、营业时间、照片、评论等。相较于旧版的 google my business api (v4),新版 api 提供了更细粒度的控制和更清晰的资源结构。
在使用 PHP 客户端库与此 API 交互时,通常会涉及以下几个核心步骤:
在调用 API 获取资源列表或详情时,readMask 是一个非常重要的参数。它允许您指定 API 响应中应包含的资源字段,从而实现“部分响应”(Partial Response)。这是一种优化策略,可以显著减少传输的数据量,提高 API 调用的效率。
然而,readMask 的使用不当是导致 INVALID_ARGUMENT 错误的一个常见原因。当您尝试使用 Google_Service_MyBusinessBusinessInformation 服务的 accounts_locations->listAccountsLocations() 方法获取地点列表时,如果 readMask 参数中包含了不属于 Location 资源本身的字段,API 将返回 HTTP 400 Bad Request 错误,并附带 INVALID_ARGUMENT 状态码及 Invalid field mask provided 的详细信息。
错误示例分析: 例如,尝试使用 readMask 指定 user.display_name,photo:
{
"error": {
"code": 400,
"message": "Request contains an invalid argument.",
"status": "INVALID_ARGUMENT",
"details": [
{
"@type": "type.googleapis.com/google.rpc.BadRequest",
"fieldViolations": [
{
"field": "read_mask",
"description": "Invalid field mask provided"
}
]
}
]
}
}这个错误发生的原因是 user.display_name 和 photo 并非 Location 资源直接拥有的属性。readMask 必须指向 Location 资源(或其嵌套子资源)中定义的有效字段。例如,地点名称 (name)、标题 (title)、网站 URI (websiteUri)、地址 (address)、经纬度 (latlng) 等才是 Location 资源的合法属性。
立即学习“PHP免费学习笔记(深入)”;
要正确使用 readMask,您必须查阅 Google My Business Business Information API 的官方文档,特别是关于 Location 资源的定义。该文档会列出所有可用的字段及其类型。
正确的 readMask 应包含以下类型的字段:
示例: 如果您想获取地点的名称、标题、网站 URI 和地址信息,您的 readMask 可以是: name,title,websiteUri,address.regionCode,address.locality,address.postalCode,address.addressLines
以下是一个使用 PHP 客户端库正确获取 Google My Business 地点列表的示例代码,其中包含了 readMask 的正确用法和基本的错误处理:
<?php
require_once 'vendor/autoload.php'; // 确保你已通过Composer安装Google API Client库
/**
* 这是一个示例函数,用于初始化 Google 客户端。
* 在实际应用中,你需要根据你的认证方式(如服务账户、OAuth 2.0)来配置 $client。
*
* @return Google\Client 已认证的 Google 客户端实例
*/
function getGoogleClient() {
$client = new Google\Client();
$client->setApplicationName('My Business API Locations Example');
// 假设你使用服务账户认证
// 请替换为你的服务账户凭据文件路径
$client->setAuthConfig('path/to/your/service_account_credentials.json');
// 或者使用 OAuth 2.0 认证流程
// $client->setRedirectUri('YOUR_REDIRECT_URI');
// $client->setAccessToken('YOUR_ACCESS_TOKEN'); // 或使用刷新令牌获取新令牌
// 设置必要的 API 作用域
$client->setScopes([
'https://www.googleapis.com/auth/business.manage' // 管理商家资料的权限
]);
return $client;
}
try {
$client = getGoogleClient();
// 1. 获取账户管理服务实例
$my_business_account = new Google_Service_MyBusinessAccountManagement($client);
// 2. 列出账户
$list_accounts_response = $my_business_account->accounts->listAccounts();
// 检查是否有账户,并选择第一个账户进行操作
$accounts = $list_accounts_response->getAccounts();
if (empty($accounts)) {
echo "未找到任何Google My Business账户。\n";
exit;
}
$account = $accounts[0]; // 获取第一个账户
echo "正在处理账户: " . $account->getName() . " (显示名称: " . $account->getDisplayName() . ")\n";
// 3. 获取Business Information服务实例
$mybusinessService = new Google_Service_MyBusinessBusinessInformation($client);
// 4. 准备查询参数
$queryParams = [
"pageSize" => 10, // 每页获取10个地点
// 关键点:readMask 必须指定 Location 资源的有效属性。
// 这些属性可以在 Google My Business Business Information API 的 Location 资源文档中找到。
// 错误示例:'user.display_name,photo'
// 正确示例:
'readMask' => "name,title,websiteUri,address,latlng,primaryCategory.displayName"
// 更多可选字段:phoneNumbers, storefrontHours, regularHours, specialHours, serviceArea, labels, relations, moreHours, metadata, profile, serviceItems, attributes 等
];
// 5. 列出账户下的地点
// accounts_locations 是 Google_Service_MyBusinessBusinessInformation 服务下的 Locations 集合
$locationsList = $mybusinessService->accounts_locations->listAccountsLocations($account->name, $queryParams);
// 6. 处理返回的地点数据
$locations = $locationsList->getLocations();
if (!empty($locations)) {
echo "成功获取地点列表:\n";
foreach ($locations as $location) {
echo "--------------------\n";
echo " 地点名称: " . $location->getName() . "\n";
echo " 地点标题: " . $location->getTitle() . "\n";
if ($location->getWebsiteUri()) {
echo " 网站URI: " . $location->getWebsiteUri() . "\n";
}
if ($location->getAddress()) {
$address = $location->getAddress();
echo " 地址: " . implode(", ", $address->getAddressLines()) . ", "
. $address->getLocality() . ", " . $address->getRegionCode() . " " . $address->getPostalCode() . "\n";
}
if ($location->getLatlng()) {
$latlng = $location->getLatlng();
echo " 经纬度: " . $latlng->getLatitude() . ", " . $latlng->getLongitude() . "\n";
}
if ($location->getPrimaryCategory()) {
echo " 主类别: " . $location->getPrimaryCategory()->getDisplayName() . "\n";
}
// 访问其他通过 readMask 请求的字段
}
echo "--------------------\n";
// 如果有下一页,可以继续获取
if ($locationsList->getNextPageToken()) {
echo "存在更多地点,下一页令牌: " . $locationsList->getNextPageToken() . "\n";
// 您可以在此处添加逻辑以获取下一页数据
}
} else {
echo "该账户下未找到任何地点。\n";
}
} catch (Google\Service\Exception $e) {
// 捕获 Google API 服务的特定异常
echo "API调用失败: " . $e->getMessage() . "\n";
$errors = $e->getErrors();
if (!empty($errors)) {
foreach ($errors as $error) {
echo "错误详情: " . ($error['message'] ?? 'N/A') . "\n";
echo "错误状态: " . ($error['status'] ?? 'N/A') . "\n";
if (isset($error['details'][0]['fieldViolations'])) {
foreach ($error['details'][0]['fieldViolations'] as $violation) {
echo "字段违规: " . ($violation['field'] ?? 'N/A') . " - " . ($violation['description'] ?? 'N/A') . "\n";
}
}
}
}
} catch (Exception $e) {
// 捕获其他通用异常
echo "发生未知错误: " . $e->getMessage() . "\n";
}
?>正确理解和使用 readMask 参数是有效利用 Google My Business Business Information API 的关键。通过确保 readMask 中指定的字段与目标资源(如 Location)的实际属性相符,可以避免常见的 INVALID_ARGUMENT 错误,并实现高效、精准的数据获取。开发者在集成 API 时,务必仔细查阅官方文档,以确保参数的正确性。
以上就是Google My Business API:PHP客户端正确使用readMask获取地点列表的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号