基本設定

如要繼續操作,請確認您已完成事前準備中的步驟,並已核准專案使用 Business Profile API。

啟用 API

您必須在 Google API 控制台中啟用八個與商家檔案相關聯的 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,然後按一下「Enable」按鈕。
  4. 如果系統顯示提示,請啟用帳單功能。
  5. 如果系統顯示提示,請接受 API 的《服務條款》。

如果您是 Google Workspace 使用者,請確認已在 Google Workspace 機構中為您的帳戶啟用 Google 商家檔案。如果 Google Workspace 機構組織的帳戶已停用 Google 商家檔案,使用 GBP API 時會出現「錯誤 403 - 權限拒絕」。

要求 OAuth 2.0 用戶端 ID

您的應用程式會存取受保護的非公開資料,因此您需要 OAuth 2.0 用戶端 ID。這麼做可讓應用程式代表應用程式使用者,要求存取貴機構的位置資料。

您的應用程式必須透過任何會存取使用者私人資料的 Business Profile API 要求傳送 OAuth 2.0 權杖。

如果您尚未執行此操作,請前往 Google API 控制台的「憑證」部分,然後依序點選「建立憑證」>「OAuth 用戶端 ID」建立 OAuth 2.0 憑證。建立憑證後,即可在「憑證」頁面看到您的用戶端 ID。按一下用戶端 ID 即可瞭解詳情,例如用戶端密鑰、重新導向 URI、JavaScript 來源位址和電子郵件地址。

瞭解 REST 的基本概念

叫用 API 的方式有兩種:

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

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

REST 是 Representational State Transfer (具象狀態傳輸) 的簡稱。就 Google API 而言,指的是使用 HTTP 動詞來擷取及修改 Google 儲存的資料表示法。

符合 REST 樣式的系統會將資源儲存在資料儲存庫中。用戶端會傳送要求,讓伺服器執行特定動作 (例如建立、擷取、更新或刪除資源),然後伺服器會執行該動作並傳送回應。該回應通常會以代表指定資源的形式表示。

在符合 REST 樣式的 API 中,用戶端會指定含有 HTTP 動詞的動作,例如 GETPOSTPUTDELETE。用戶端會透過全域不重複的統一資源識別碼 (URI) 指定資源,格式如下:

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

由於所有 API 資源都有專屬的 HTTP 可存取 URI,因此 REST 不僅能夠啟用資料快取,還能與網路的分散式基礎架構搭配運作。

您可以在 HTTP 1.1 標準說明文件中找到實用的方法定義。包括 GETPOSTPUTDELETE 的規格。

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 Object Notation (JSON) 是與語言無關的常見資料格式,可提供任意資料結構的簡單文字表示法。詳情請參閱 json.org

使用 Oauth Playground 發出簡易 HTTP 要求

您可以使用 OAuth 2.0 Playground 來測試 Business Profile API。由於 Business Profile API 不是公用 API,因此您需要採取幾個步驟,才能在 Playground 中使用。您需要有用戶端 ID 才能繼續操作。

  1. 前往 Google API 控制台,然後開啟您的專案。如果您沒有網頁應用程式的 OAuth 用戶端 ID,請立即建立:
    1. 在「建立憑證」下拉式清單中選取「OAuth 用戶端 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 貼到「Request URI」欄位中:

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

如要進一步瞭解如何發出各種要求,請參閱 Business Profile API 參考資料

用戶端程式庫

Business Profile API 用戶端程式庫支援 Business Profile API 的功能。這些 API 提供所有 Google API 通用的功能,例如 HTTP 傳輸、錯誤處理、驗證以及 JSON 剖析。

如要下載用戶端程式庫,請參閱程式庫