解决 Google My Business API 更新主要类别时出现的错误

本文旨在帮助开发者解决在使用 Google My Business API 更新商家主要类别时遇到的 "Request contains an invalid argument" 错误。我们将深入分析错误原因，并提供正确的更新方法，确保您能成功修改商家信息中的类别设置。本文将通过示例代码和注意事项，帮助您避免常见的坑，顺利完成API调用。

在使用 Google My Business API 更新商家信息时，尤其是尝试单独更新主要类别时，可能会遇到 INVALID_ARGUMENT 错误，错误信息提示 "primary or additional categories cannot be updated independently."。 这意味着 API 不允许你单独更新主要类别或附加类别，而必须一次性提供所有类别信息。

错误原因分析

错误信息表明，Google My Business API 在更新类别信息时，要求你提供完整的类别列表，而不是单独更新某个类别。 update_mask 字段需要包含 categories，并且请求体中必须包含完整的 categories 数据，包括主要类别和所有附加类别。

解决方法

要解决这个问题，你需要修改你的请求，确保在 updateMask 中包含 categories，并在请求体中提供完整的类别信息。以下是一个修正后的 PHP 示例代码：

百度虚拟主播

百度智能云平台的一站式、灵活化的虚拟主播直播解决方案

36

查看详情

<?php

$locationData = array();
$locationData['title'] = $data['title'];
$locationData['categories'] = array(
    'primaryCategory' => array('name' => 'gcid:website_designer'),
    // 添加其他附加类别 (如果适用)
    //'additionalCategories' => array(
    //    array('name' => 'gcid:some_other_category')
    //)
);

$updateMask = array(
    'title',
    'categories'
);

$queryParams = array(
    'updateMask' => implode(',', $updateMask)
);

// Prepare new cURL resource
$curl = curl_init('https://mybusinessbusinessinformation.googleapis.com/v1/locations/'.$locationId.'/?'.http_build_query($queryParams));
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($locationData)); // Important: Encode the data as JSON
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Authorization: Bearer ' . $accessToken,
));

// Submit the PATCH request
$response = curl_exec($curl);

// Close cURL session handle
curl_close($curl);

$location = json_decode($response);

echo "";
print_r($location);
echo "";

?>

代码解释:

1. $locationData['categories']: 现在包含了一个完整的 categories 数组，包括 primaryCategory 和可能的 additionalCategories。 确保你提供所有已存在的和需要更新的类别。
2. $updateMask = array('title', 'categories');: updateMask 现在包含了 categories，表明我们要更新整个类别列表。
3. json_encode($locationData): 使用 json_encode 将 $locationData 数组编码为 JSON 字符串，这是 API 要求的格式。
4. Content-Type: application/json: 确保请求头中设置了正确的 Content-Type。

注意事项:

• 必须提供完整的类别信息: 即使你只想更新主要类别，也需要在请求中包含所有附加类别。 如果你的商家没有附加类别，可以省略 additionalCategories 字段。
• GCID: gcid 是 Google Category ID 的缩写，你需要使用正确的 GCID 来指定类别。 你可以通过 Google 的 API 文档或工具找到对应的 GCID。
• JSON 编码: 确保将请求体数据编码为 JSON 格式。
• 权限: 确保你的 API 密钥具有足够的权限来更新商家信息。
• 错误处理: 在实际应用中，应该添加错误处理机制，以便在 API 调用失败时能够及时发现并处理。

总结

解决 Google My Business API 更新类别错误的关键在于理解 API 的要求：必须一次性提供完整的类别信息。通过修改 updateMask 和请求体，确保包含所有必要的类别数据，并按照 API 的要求进行格式化，你就可以成功更新商家信息中的类别设置。 记住，仔细阅读 API 文档，理解每个参数的含义和要求，是避免错误的最佳方法。

以上就是解决 Google My Business API 更新主要类别时出现的错误的详细内容，更多请关注php中文网其它相关文章！