顯示 APIs Explorer 並執行方法

在大多數說明文件頁面中,畫面右側會顯示精簡的 API Explorer。如果沒有看到 APIs Explorer,請按一下「試試看!」,即可顯示精簡版的 APIs Explorer。

如果參考文件頁面右側未顯示「試試看!」,表示 API Explorer 不支援該方法。舉例來說,API Explorer 與需要服務帳戶的 API 不相容,因此不會出現在這些 API 的說明文件頁面。

顯示展開的 API Explorer 版本

API Explorer 的展開版本包含 cURL、HTTP,以及其他程式碼範例 (可能)。如要顯示展開的 APIs Explorer,請按一下「全螢幕」圖示

執行方法

您可以在 APIs Explorer 中輸入 API 方法的必要參數、選用參數,以及要求主體 (如適用)。對於許多 REST 方法 (例如清單方法),您只需要填寫一或兩個欄位,即可執行方法。舉例來說,Books API 的 books.volumes.list 方法只需要查詢參數 (q) 即可列出書籍。如要試用 books.volumes.list 方法,請按照下列步驟操作:

  1. 前往 books.volumes.list
  2. 如果沒有顯示 API Explorer,請按一下「試試看!」
  3. q 欄位中,輸入「Hunger Games」 (不含任何引號或特殊字元)。
  4. 向下捲動並按一下「執行」
  5. (選用) Google 登入畫面會要求你選取 Google 帳戶。
  6. (選用) Google 授權對話方塊會詢問你是否允許「管理你的書籍」。點按「允許」,結果會顯示在「執行」按鈕下方。

如果 API Explorer 顯示結果為 200,表示方法成功。

排解 API Explorer 問題

收到 401 或 403 錯誤

如果使用 API 探索工具執行方法時收到 401 或 403 錯誤,可能是下列其中一個問題所致:

  • 您使用的授權類型有誤 (使用 API 金鑰而非 OAuth 2.0)。請嘗試切換授權類型。
  • 您使用 OAuth 2.0,但範圍過於狹窄。請嘗試使用範圍較廣的範圍。

未顯示授權對話方塊

API Explorer 會使用彈出式視窗授予私人資料的存取權。如果瀏覽器封鎖彈出式視窗,系統就不會顯示這個視窗,您也無法授予存取權。

如果在授權對話方塊中按一下「允許」,但沒有任何反應,請嘗試變更瀏覽器的彈出式視窗設定,啟用彈出式視窗。