基本设置

如要继续操作，请确保您已完成前提条件中的步骤，且您的项目已获准使用 Business Profile API。

启用 API

您必须在 Google API 控制台中启用以下 8 个与商家资料相关联的 API：

  • Google My Business API
  • My Business Account Management API
  • My Business Lodging API
  • My Business Place Actions API
  • My Business Notifications API
  • My Business Verifications API
  • My Business Business Information API
  • My Business Q&A API

启用 API

如果您已满足所有前提条件且已获得相应 API 的访问权限，但仍无法使用提供的快捷方式，则可以按照以下步骤手动启用该 API。

要为您的项目启用 API，请执行以下操作：

  1. 在 Google API 控制台中打开 API 库。如果系统提示，请选择一个项目或创建一个新项目。API 库中列出了所有可用的 API（按产品系列和热门程度分组）。
  2. 如果列表中没有显示您要启用的 API，请使用搜索功能查找该 API。
  3. 选择您要启用的 API，然后点击启用按钮。
  4. 如果系统提示，请启用结算功能。
  5. 如果系统提示，请接受该 API 的服务条款。

如果您是 Google Workspace 用户，请确认在您的 Google Workspace 组织中已为您的账号启用 Google 商家资料。如果您所在的 Google Workspace 组织为您的账号停用了 Google 商家资料，那么您在使用 GBP API 时会收到“错误 403 - 权限遭拒”的消息。

请求 OAuth 2.0 客户端 ID

您的应用将访问受保护的非公开数据，因此，您需要使用 OAuth 2.0 客户端 ID。您的应用可通过该 ID 以应用用户的身份请求授权，以便访问贵组织的营业地点数据。

您的应用必须在要访问非公开用户数据的所有 Business Profile API 请求中发送 OAuth 2.0 令牌。

如果您尚未创建 OAuth 2.0 凭据，请前往 Google API 控制台的“凭据”部分，点击创建凭据 > OAuth 客户端 ID 进行创建。创建凭据后，您将在凭据页面上看到客户端 ID。点击客户端 ID 即可查看详细信息（例如客户端密钥、重定向 URI、JavaScript 源地址及电子邮件地址）。

了解 REST 基础知识

您可以通过以下两种方式调用这些 API：

  • 发送 HTTP 请求并解析响应。
  • 使用客户端库。

如果您决定不使用客户端库，则需要了解 REST 的基础知识。

REST 是一种软件架构方式，可提供方便且一致的方法来请求和修改数据。

术语 REST 是“Representational State Transfer”（具象状态传输）的简称。在 Google API 环境中，它指的是使用 HTTP 动词来检索和修改由 Google 存储的数据的表示形式。

RESTful 系统会将资源存储在数据存储区中。客户端向服务器发送执行特定操作（例如创建、检索、更新或删除某资源）的请求，服务器在执行相应操作后发回响应。此响应通常会是指定资源的某种表示形式。

在 Google 的 RESTful API 中，客户端会使用 HTTP 动词指定一个操作，例如 GET、POST、PUT 或 DELETE。客户端通过全局唯一的统一资源标识符 (URI) 指定资源，URI 格式如下：

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

由于所有 API 资源都具有 HTTP 可访问的唯一 URI，因此 REST 可实现数据缓存，而且适合与网络的分布式基础架构一起使用。

您可能会发现 HTTP 1.1 标准文档中的方法定义非常实用，其中包括 GET、POST、PUT 和 DELETE 的使用规范。

Business Profile API 中的 REST

Business Profile API 操作会直接映射到 REST HTTP 动词。

Business Profile API 的具体格式会显示在以下 URI 中：

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

Business Profile API 参考文档总结了这些 API 中支持的各项操作所用的全部 URI。

资源路径因端点而异。

例如，账号的资源路径如下所示：

accounts/accountId

营业地点的资源路径采用以下格式：

locations/locationId

了解 JSON 基础知识

Business Profile API 以 JSON 格式返回数据。

JavaScript 对象表示法 (JSON) 是一种与语言无关的常见数据格式，可提供任意数据结构的简单文本表示形式。如需了解详情，请参阅 json.org。

使用 Oauth Playground 发出简单的 HTTP 请求

您可以通过 OAuth 2.0 Playground 来试用商家资料 API。Business Profile API 不是公共 API，因此，您需要额外执行一些步骤才能在 Playground 中使用这些 API。您需要有 Web 应用的客户端 ID 才能继续操作。

  1. 前往 Google API 控制台，然后打开您的项目。如果您还没有 Web 应用的 OAuth 客户端 ID，请立即创建一个：
    1. 从创建凭据下拉列表中选择 OAuth 客户端 ID。
    2. 对于应用类型，请点击 Web 应用。

    3. 将以下内容添加为有效的重定向 URI：

       https://developers.google.com/oauthplayground
    4. 点击创建。
  2. 将客户端 ID 复制到剪贴板。
  3. 前往 OAuth 2.0 Playground。
  4. 点击齿轮图标以打开配置选项，然后进行以下更改：
    1. 将 OAuth flow（OAuth 流程）设置为 Client-side（客户端）。
    2. 选择 Use your own OAuth credentials（使用您自己的 OAuth 凭据）。
    3. 粘贴您的 OAuth 客户端 ID。
  5. 关闭配置选项。

  6. 在“Step 1 - Select & authorize APIs”（第 1 步 - 选择和授权 API）下，将 Business Profile API 的以下范围粘贴到 Input your own scopes（输入您自己的范围）字段：

    https://www.googleapis.com/auth/business.manage
  7. 点击 Authorize APIs（授权 API）。
  8. 出现提示时，点击 Accept（接受）。

  9. 在“Step 2 - Configure request to API”（第 2 步 - 配置对 API 的请求）下，将以下 URI 粘贴到 Request URI（请求 URI）字段中： 

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
  10. 点击 Send the request（发送请求）。响应应显示 200 OK 状态。

如需详细了解如何发出各类请求，请参阅 Business Profile API 参考文档。

客户端库

Business Profile API 客户端库支持 Business Profile API 的功能。它们提供所有 Google API 通用的功能，例如 HTTP 传输、错误处理、身份验证及 JSON 解析。

如需下载客户端库，请参阅库。