基本設定

如要繼續，請確認您已完成 事前準備，且我們已核准您的商家檔案專案 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，然後按一下「啟用」 按鈕。
  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 來源位址和電子郵件等詳細資料 讓我們看看 DNS 解析 進一步探索內部和外部位址

瞭解 REST 的基本概念

叫用 API 的方式有兩種：

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

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

REST 這個詞是簡稱 「表徵狀態轉移」。而在 Google API 中 使用 HTTP 動詞來擷取及修改 Google 儲存的資料表示法。

符合 REST 樣式的系統會將資源儲存在資料儲存庫中。用戶端會向 執行特定動作，例如建立、擷取、更新或刪除資源 伺服器就會執行動作並傳送回應這類回應通常會以 指定資源的表示法

在 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 動詞。

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」(要求 URI) 欄位： 

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

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

用戶端程式庫

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

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