当前位置:首页 > 文章列表 > 文章 > php教程 > GoogleAPIlocations.list读取错误解决方法

GoogleAPIlocations.list读取错误解决方法

2025-07-10 19:42:29 0浏览 收藏

偷偷努力,悄无声息地变强,然后惊艳所有人!哈哈,小伙伴们又来学习啦~今天我将给大家介绍《Google API解决locations.list读取错误》,这篇文章主要会讲到等等知识点,不知道大家对其都有多少了解,下面我们就一起来看一吧!当然,非常希望大家能多多评论,给出合理的建议,我们一起学习,一起进步!

优化Google My Business API:解决accounts.locations.list中readMask参数的INVALID_ARGUMENT错误

本教程详细探讨了在使用Google My Business Business Information API的accounts.locations.list方法时,因readMask参数格式不正确导致的INVALID_ARGUMENT错误。文章将阐明readMask应如何正确指定Location资源的有效字段,提供正确的PHP代码示例,并指导开发者如何根据官方文档构建有效的请求,确保成功获取商家位置信息。

理解Google My Business Business Information API与readMask参数

Google My Business Business Information API (v1) 是Google提供的一套用于管理商家在Google上展示信息的接口,它取代了旧版的My Business API (v4)。通过此API,开发者可以程序化地获取、更新和管理商家列表信息,例如商家名称、地址、电话、营业时间等。

在调用API获取资源列表时,readMask参数是一个非常重要的机制。它的作用是允许开发者明确指定需要从API响应中返回哪些字段。这不仅可以减少网络传输的数据量,提高性能,还能确保只获取所需信息,避免不必要的数据处理。然而,如果readMask中指定的字段不正确,API将返回INVALID_ARGUMENT错误。

INVALID_ARGUMENT错误分析:readMask的常见误区

在使用PHP客户端库调用Google_Service_MyBusinessBusinessInformation的accounts.locations.list方法时,一个常见的错误是提供了无效的readMask字段。例如,以下代码片段展示了导致错误的问题:

<?php
// ... 假设 $client 已正确初始化并认证 ...

$my_business_account = new Google_Service_MyBusinessAccountManagement($client);
$list_accounts_response = $my_business_account->accounts->listAccounts();
$account = $list_accounts_response[0]; // 获取第一个账户

$mybusinessService = new Google_Service_MyBusinessBusinessInformation($client);
$locations = $mybusinessService->accounts_locations;

$queryParams = [
    "pageSize" => 10,
    // 错误的 readMask 示例
    'readMask' => "user.display_name,photo" 
];

try {
    $locationsList = $locations->listAccountsLocations($account->name, $queryParams);
    // ... 处理响应 ...
} catch (Google\Service\Exception $e) {
    echo "Google Service Error: " . $e->getMessage() . PHP_EOL;
    // 捕获到的错误响应示例:
    /*
    Google\Service\Exception #400
    {
      "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"
              }
            ]
          }
        ]
      }
    }
    */
}

上述代码中,readMask被设置为"user.display_name,photo"。API返回INVALID_ARGUMENT错误,并明确指出"Invalid field mask provided"。其根本原因在于,readMask中指定的字段必须是所请求资源(在本例中是Location资源)的有效属性。user.display_name和photo并非Location资源自身的直接属性。虽然商家可能与用户关联,并且有照片,但这些信息通常通过不同的API端点或Location资源内部的特定嵌套字段来访问,而不是作为顶层字段直接通过readMask获取。

正确使用readMask:指定Location资源的有效字段

要正确使用readMask,开发者必须查阅Google My Business Business Information API的官方文档,特别是关于Location资源(https://developers.google.com/my-business/reference/businessinformation/rest/v1/locations)的定义。该文档详细列出了Location对象的所有可用字段及其数据类型。

例如,Location资源包含name(资源名称)、title(商家名称)、websiteUri(网站URI)、phoneNumbers(电话号码)、address(地址)等字段。当您需要获取这些信息时,应将它们添加到readMask中。

以下是修正后的PHP代码示例,展示了如何正确构建readMask:

<?php
require_once __DIR__ . '/vendor/autoload.php';

// 假设 $client 已经是一个经过认证的 Google_Client 实例。
// 确保 $client 已配置正确的认证凭据和作用域,例如:
// $client = new Google_Client();
// $client->setApplicationName("My Business API Client");
// $client->setScopes(['https://www.googleapis.com/auth/business.manage']);
// $client->setAuthConfig('path/to/your/credentials.json'); // 或其他认证方式

try {
    $my_business_account = new Google_Service_MyBusinessAccountManagement($client);
    $list_accounts_response = $my_business_account->accounts->listAccounts();

    if (empty($list_accounts_response->getAccounts())) {
        echo "No accounts found." . PHP_EOL;
        exit;
    }

    // 获取第一个账户。在实际应用中,您可能需要遍历所有账户或选择特定账户。
    $account = $list_accounts_response->getAccounts()[0]; 

    $mybusinessService = new Google_Service_MyBusinessBusinessInformation($client);
    $locations_service = $mybusinessService->accounts_locations;

    $queryParams = [
        "pageSize" => 10,
        // 正确的 readMask 应该包含 Location 资源的有效字段。
        // 示例:获取商家名称、网站URI和地址。
        'readMask' => "name,title,websiteUri,address" 
        // 您也可以根据需要添加其他字段,如 "phoneNumbers", "primaryCategory", "openInfo" 等。
        // 对于嵌套字段,如需要特定地址组件,可能需要 "address.locality", "address.postalCode" 等,
        // 但通常指定父字段(如 "address")会返回整个地址对象。
    ];

    echo "Fetching locations for account: " . $account->name . PHP_EOL;
    $locationsList = $locations_service->listAccountsLocations($account->name, $queryParams);

    if ($locationsList->getLocations()) {
        echo "Successfully retrieved locations:" . PHP_EOL;
        foreach ($locationsList->getLocations() as $location) {
            echo "  Location Name (Resource): " . $location->getName() . PHP_EOL;
            echo "  Location Title (Business Name): " . $location->getTitle() . PHP_EOL;
            echo "  Website URI: " . $location->getWebsiteUri() . PHP_EOL;

            // 访问地址信息
            $address = $location->getAddress();
            if ($address) {
                echo "  Address: " . $address->getPostalAddress()->getFormattedAddress() . PHP_EOL;
                // 您可以进一步访问地址的各个组成部分,如 getLocality(), getPostalCode() 等
            }
            echo "--------------------" . PHP_EOL;
        }
    } else {
        echo "No locations found for this account." . PHP_EOL;
    }

} catch (Google\Service\Exception $e) {
    echo "Google Service Error: " . $e->getMessage() . PHP_EOL;
    echo "Details: " . json_encode($e->getErrors(), JSON_PRETTY_PRINT) . PHP_EOL;
} catch (Exception $e) {
    echo "Error: " . $e->getMessage() . PHP_EOL;
}

注意事项与最佳实践

  1. 始终查阅官方文档: 这是避免readMask错误最关键的步骤。每当使用一个新的API或资源时,务必仔细阅读其文档,了解支持的字段和数据结构。
  2. 精确指定字段: readMask的目的是为了精确控制返回的数据。只请求您真正需要的字段,可以有效减少响应大小和处理时间。
  3. 处理嵌套字段: 对于像address或phoneNumbers这样的复杂对象,readMask通常可以直接指定父字段(例如address),这将返回整个嵌套对象。如果您只需要嵌套对象中的特定子字段(例如地址的城市address.locality),则可能需要指定完整的路径。API文档会明确说明哪些嵌套字段可以直接在readMask中使用。
  4. 错误处理: 实施健壮的错误处理机制。捕获Google\Service\Exception并解析其getErrors()方法返回的详细信息(特别是fieldViolations),这对于调试API请求中的参数问题至关重要。
  5. 认证与授权: 确保您的Google API客户端已使用正确的OAuth 2.0凭据和必要的作用域(例如https://www.googleapis.com/auth/business.manage)进行认证。没有正确的权限,即使readMask正确也会导致认证错误。

总结

readMask是Google API中一个强大的特性,用于优化数据传输和提高API调用的效率。在使用Google My Business Business Information API的accounts.locations.list等方法时,遇到INVALID_ARGUMENT错误并伴随"Invalid field mask provided"的提示,几乎总是意味着readMask中包含了不属于目标资源(如Location)的字段。通过仔细查阅官方API文档,并根据Location资源的有效属性来构建readMask,开发者可以避免此类错误,并成功获取所需的商家位置信息。

终于介绍完啦!小伙伴们,这篇关于《GoogleAPIlocations.list读取错误解决方法》的介绍应该让你收获多多了吧!欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识,快来关注吧!

Android集成MLKit,AI功能添加教程Android集成MLKit,AI功能添加教程
上一篇
Android集成MLKit,AI功能添加教程
Golang图片编码解析:PNG/JPEG接口设计详解
下一篇
Golang图片编码解析:PNG/JPEG接口设计详解
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    509次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    497次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • AI边界平台:智能对话、写作、画图,一站式解决方案
    边界AI平台
    探索AI边界平台,领先的智能AI对话、写作与画图生成工具。高效便捷,满足多样化需求。立即体验!
    388次使用
  • 讯飞AI大学堂免费AI认证证书:大模型工程师认证,提升您的职场竞争力
    免费AI认证证书
    科大讯飞AI大学堂推出免费大模型工程师认证,助力您掌握AI技能,提升职场竞争力。体系化学习,实战项目,权威认证,助您成为企业级大模型应用人才。
    404次使用
  • 茅茅虫AIGC检测:精准识别AI生成内容,保障学术诚信
    茅茅虫AIGC检测
    茅茅虫AIGC检测,湖南茅茅虫科技有限公司倾力打造,运用NLP技术精准识别AI生成文本,提供论文、专著等学术文本的AIGC检测服务。支持多种格式,生成可视化报告,保障您的学术诚信和内容质量。
    540次使用
  • 赛林匹克平台:科技赛事聚合,赋能AI、算力、量子计算创新
    赛林匹克平台(Challympics)
    探索赛林匹克平台Challympics,一个聚焦人工智能、算力算法、量子计算等前沿技术的赛事聚合平台。连接产学研用,助力科技创新与产业升级。
    635次使用
  • SEO  笔格AIPPT:AI智能PPT制作,免费生成,高效演示
    笔格AIPPT
    SEO 笔格AIPPT是135编辑器推出的AI智能PPT制作平台,依托DeepSeek大模型,实现智能大纲生成、一键PPT生成、AI文字优化、图像生成等功能。免费试用,提升PPT制作效率,适用于商务演示、教育培训等多种场景。
    545次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码