基本設定

如要繼續操作，請確認您已完成必要條件中的步驟，且我們已核准您的專案可存取 Business Profile API。

啟用 API

有八個與商家檔案相關的 API，必須在 Google 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，請使用搜尋功能。
  3. 選取要啟用的 API，然後按一下「啟用」按鈕。
  4. 如果系統顯示提示，請啟用帳單功能。
  5. 如果系統顯示提示，請接受 API 的服務條款。

如果您是 Google Workspace 使用者，請確認 Google Workspace 組織中已為您的帳戶啟用 Google 商家檔案。如果 Google Workspace 組織中的帳戶已停用 Google 商家檔案，使用 GBP API 時就會收到「錯誤 403 - 權限遭拒」訊息。

要求 OAuth 2.0 用戶端 ID

由於您的應用程式會存取受保護的非公開資料，因此需要 OAuth 2.0 用戶端 ID。這樣一來，您的應用程式就能代表應用程式使用者，要求授權存取貴機構的位置資料。

您的應用程式必須透過任何存取私人使用者資料的商家檔案 API 要求，傳送 OAuth 2.0 憑證。

如果您尚未建立，請前往 Google API 控制台的「憑證」部分，然後依序點選「建立憑證」>「OAuth 用戶端 ID」，建立 OAuth 2.0 憑證。建立憑證後，您可以在「Credentials」(憑證) 頁面上看到用戶端 ID。按一下用戶端 ID 即可查看詳細資料，例如用戶端密鑰、重新導向 URI、JavaScript 來源地址和電子郵件地址。

瞭解 REST 的基本概念

叫用 API 的方法有兩種：

如果您決定不使用用戶端程式庫，就必須瞭解 REST 的基本概念。

REST 是一種軟體架構，可提供簡便且一致的資料要求及修改方法。

REST 這個詞是「Representational State Transfer (表現層狀態轉換)」的簡稱。在 Google API 中，這是指使用 HTTP 動詞來擷取及修改 Google 所儲存資料的表示法。

RESTful 系統會將資源儲存在資料儲存庫中。用戶端會傳送要求，要求伺服器執行特定動作，例如建立、擷取、更新或刪除資源，而伺服器會執行該動作並傳送回應。該回應通常會以指定資源的表示法形式呈現。

在 Google 的 RESTful API 中，用戶端會使用 HTTP 動詞指定動作，例如 GET、POST、PUT 或 DELETE。用戶端會透過下列格式的全域不重複統一資源識別碼 (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 動詞。

以下 URI 顯示 Business Profile API 的具體格式：

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

如需 API 中各支援作業使用的完整 URI 組合，請參閱商家檔案 API 參考資料說明文件。

資源路徑會因端點而異。

舉例來說，帳戶的資源路徑如下所示：

accounts/accountId

位置的資源路徑會以以下格式顯示：

locations/locationId

瞭解 JSON 的基本概念

Business Profile API 會以 JSON 格式傳回資料。

JavaScript Object Notation (JSON) 是一種常見的語言無關資料格式，可提供任意資料結構的簡單文字表示法。詳情請參閱 json.org。

使用 OAuth Playground 提出簡易的 HTTP 要求

您可以使用 OAuth 2.0 Playground 試用 Business Profile API。由於 Business Profile API 並非公開 API，因此您必須採取幾個額外步驟，才能在 Playground 中使用該 API。您需要網頁應用程式的用戶端 ID 才能繼續操作。

  1. 前往 Google API 控制台並開啟專案。如果您沒有網路應用程式的 OAuth 用戶端 ID，請立即建立：
    1. 在「Create credentials」下拉式清單中，選取「OAuth client ID」。
    2. 在「應用程式類型」部分，按一下「網頁應用程式」。

    3. 新增下列有效的重新導向 URI：

       https://developers.google.com/oauthplayground
    4. 按一下「建立」。
  2. 將用戶端 ID 複製到剪貼簿。
  3. 前往 OAuth 2.0 Playground。
  4. 按一下齒輪圖示開啟設定選項，然後進行下列變更：
    1. 將「OAuth 流程」設為「用戶端」。
    2. 選取「使用自己的 OAuth 憑證」。
    3. 貼上 OAuth 用戶端 ID。
  5. 關閉設定選項。

  6. 在「步驟 1 - 選取及授權 API」下方，將下列 Business Profile API 範圍貼到「輸入您自己的範圍」欄位：

    https://www.googleapis.com/auth/business.manage
  7. 按一下「授權使用 API」。
  8. 系統出現提示時，按一下「接受」。

  9. 在「步驟 2 - 設定對 API 的要求」下方，將下列 URI 貼到「要求 URI」欄位中：

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
  10. 按一下「傳送要求」。回應應顯示 200 OK 狀態。

如要進一步瞭解如何提出各種要求，請參閱 商家檔案 API 參考資料。

用戶端程式庫

Business Profile API 用戶端程式庫支援 Business Profile API 的功能。這些類別提供所有 Google API 的共同功能，例如 HTTP 傳輸、錯誤處理、驗證和 JSON 剖析。

如要下載用戶端程式庫，請參閱「程式庫」。