如要繼續操作,請確認您已完成事前準備中的步驟,並已核准您的 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,請按照以下步驟操作:
- 在 Google API 控制台中開啟 API 程式庫。按照系統說明選取專案,或建立新專案。API 程式庫會列出所有可用的 API,並以產品系列和熱門程度分組。
- 如果清單裡找不到您想啟用的 API,請用搜尋功能尋找。
- 選取要啟用的 API,然後按一下「Enable」按鈕。
- 如果系統顯示提示,請啟用帳單。
- 如果系統顯示提示,請接受 API 的《服務條款》。
如果你是 Google Workspace 使用者,請確認 Google Workspace 機構中的帳戶已啟用 Google 商家檔案。如果您在 Google Workspace 機構中為帳戶停用 Google 商家檔案,在使用 GBP API 時,就會收到「錯誤 403 - 權限遭拒」的訊息。
要求 OAuth 2.0 用戶端 ID
由於您的應用程式會存取受保護的非公開資料,您需要使用 OAuth 2.0 用戶端 ID。這樣一來,應用程式就能代表應用程式使用者要求授權,存取貴機構的位置資料。
您的應用程式必須傳送 OAuth 2.0 權杖,以及要求存取私人使用者資料的任何 Business Profile API 要求。
如果您尚未建立 OAuth 2.0 憑證,請前往 Google API 控制台的「憑證」部分,然後依序點選「建立憑證」>「OAuth 用戶端 ID」。建立憑證後,即可在「憑證」頁面查看您的用戶端 ID。按一下用戶端 ID 即可查看詳細資料,例如用戶端密鑰、重新導向 URI、JavaScript 來源地址和電子郵件地址。
瞭解 REST 的基本概念
叫用 API 的方式有兩種:
- 傳送 HTTP 要求並剖析回應。
- 使用用戶端程式庫。
如果您決定不使用用戶端程式庫,則必須瞭解 REST 的基本概念。
REST 是一種軟體架構,提供簡便且一致的資料要求及修改方法。
REST 是「表徵狀態傳輸」的簡稱。就 Google API 來說,這是指使用 HTTP 動詞來擷取及修改 Google 儲存的資料表示法。
符合 REST 樣式的系統會將資源儲存在資料儲存庫中。用戶端傳送要求給伺服器以執行特定動作,例如建立、擷取、更新或刪除資源,然後伺服器會執行該動作並傳送回應。該回應通常會以指定資源表示法的形式呈現。
在 Google 的 REST 樣式 API 中,用戶端會指定使用 HTTP 動詞的動作,例如 GET
、POST
、PUT
或 DELETE
。用戶端會透過下列格式的全域不重複的統一資源 ID (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 網站。
發出簡單的 HTTP 要求
您可以使用 OAuth 2.0 Playground 對 Business Profile API 進行實驗。由於 Business Profile API 並非公用 API,您還需要採取一些額外步驟,才能在 Playground 中使用。您需要有用戶端 ID 才能繼續操作。
- 前往 Google API 控制台,並開啟專案。如果您沒有網頁應用程式的 OAuth 用戶端 ID,請立即建立:
- 在「建立憑證」下拉式清單中,選取「OAuth 用戶端 ID」。
- 在「應用程式類型」部分,按一下「網頁應用程式」。
將下列內容新增為有效的重新導向 URI:
https://developers.google.com/oauthplayground
- 點選「建立」。
- 將用戶端 ID 複製到剪貼簿。
- 前往 OAuth 2.0 Playground。
- 按一下齒輪圖示,開啟設定選項,然後進行以下變更:
- 將「OAuth 流程」設為「用戶端」。
- 選取「使用自己的 OAuth 憑證」。
- 貼上您的 OAuth 用戶端 ID。
- 關閉設定選項。
在「步驟 1 - 選取及授權 API」下方,將 Business Profile API 的下列範圍貼到「自行輸入範圍」欄位:
https://www.googleapis.com/auth/business.manage
- 按一下「Authorize API」(授權 API)。
- 在系統顯示提示時,按一下「接受」。
-
在「步驟 2 - 設定 API 的要求」下方,將下列 URI 貼到「要求 URI」欄位中:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- 按一下「傳送要求」。回應應會顯示
200 OK
狀態。
如要進一步瞭解如何提出各種要求,請參閱 Business Profile API 參考資料。
用戶端程式庫
Business Profile API 用戶端程式庫支援 Business Profile API 的功能。API 提供所有 Google API 通用的功能,例如 HTTP 傳輸、錯誤處理、驗證和 JSON 剖析。
如要下載用戶端程式庫,請參閱程式庫一文。