Graph API 測試工具指南

有了 Graph API 測試工具,您便可以為您在當中擁有管理員、開發人員或測試人員角色的所有應用程式建構並執行 Graph API 查詢,並查看這些查詢的回應。

開啟 Graph API 測試工具

常見用途

  • 快速產生存取憑證
  • 為您的查詢取得程式碼範例
  • 產生除錯資訊,並將之包含在支援要求中
  • 使用正式版應用程式設定(包括權限、功能和您的使用案例設定)測試 API 查詢
  • 使用測試用戶或測試資料的權限和功能,以測試版或開發版應用程式測試 API 查詢

必要條件

元件

存取憑證

取得存取憑證後,憑證會顯示於工具的右上角。您需要將此憑證加入您的 Graph API 查詢中。您可複製此憑證,並在應用程式內使用此憑證以測試程式碼。

點擊資訊圖示以查看有關目前憑證的資訊,包括連繫至此憑證的應用程式,以及所有獲應用程式用戶(即是您)授權的權限。

如果憑證已過期或您加入了新權限,可產生新的存取憑證。

Meta 應用程式

右上角的 Meta 應用程式下拉式選單會顯示所有您在當中擁有管理員、開發人員或測試人員角色的應用程式。使用下拉式選單,選擇您想要測試的應用程式設定。

用戶或專頁

您可透過用戶或專頁下拉式選單取得並替換應用程式、用戶及目前所選應用程式的專頁存取憑證。您也可以使用此選單,從用戶節點解除安裝應用程式,但這會破壞目前的存取憑證。

權限

每當您要求取得用戶存取憑證時,系統都預設只提供一個權限,即 public_profile。「權限」下拉式選單讓您選擇「用戶資料權限」(如 emailuser_photos)、「事件、群組和專頁權限」(如 manage_pagesads_management),以及「其他」權限(如 instagram_basicpublish_video 權限)。這可讓當前應用程式用戶(即是您)向應用程式授予特定權限。請只授予應用程式真正需要的權限。

如果您的應用程式在開發中,您可向應用程式授予任何權限,而您的查詢會根據這些權限,取得在應用程式擁有角色的用戶所擁有的資料。不過,如果您的應用程式已發佈,而您向應用程式授予未經應用程式審查程序所批准的權限,則您提交的任何查詢都會失敗。

查詢字串欄位

在您首次進入工具時,畫面會顯示預設的查詢。如要編輯查詢,您可以輸入一個新的查詢,或在執行查詢後,在欄位檢視器中搜尋並選擇欄位。您也可以使用下拉式選單以切換操作方式,並指定不同版本的 Graph API。

如果您點擊查詢欄位尾端的星號圖示,則工具會將該查詢儲存為最愛。您可以點擊書籍圖示,以查看最愛查詢。

節點欄位檢視器

當您在節點上提交 GET 查詢時,位於視窗左側的欄位檢視器會顯示節點名稱,以及由 Graph API 傳回的欄位。如要修改查詢,您可以搜尋和選擇新的欄位、點擊加號圖示並選擇可用的欄位,或取消勾選不必要的欄位。完成這些動作後,系統會在查詢字串欄位中動態更新您的查詢。

回應視窗

位於查詢字串下方的回應會顯示您上一個已提交查詢所傳回的結果。

取得程式碼

如果您對查詢感到滿意,可點擊回應正下方的「取得程式碼」按鈕,以產生根據查詢所得的程式碼範例。一般而言,您無法直接將程式碼範例複製和貼到基底程式碼,但您可用它作為實用的參考。

複製除錯資訊

如果您的查詢一直失敗,而您無法找到原因,並決定聯絡開發人員支援團隊,請點擊正下方的此按鈕,以將您的查詢和回應詳情複製至您的剪貼簿。您可以將此資訊與和支援要求一同提交,以幫助我們了解問題所在之處。

儲存作業階段

點擊正下方的「儲存作業階段」按鈕,即可儲存查詢狀態,同時移除存取憑證。如果您決定聯絡開發人員支援團隊,請提供前往此作業階段的連結。

查詢範例

請嘗試執行您首次載入 Graph API 測試工具時所出現的預設查詢。如果您沒有執行過以上操作,請在新視窗中開啟 Graph API 測試工具,從應用程式下拉式選單中選擇要測試的應用程式,然後取得用戶存取憑證。

預設查詢應會出現在查詢字串欄位中:

GET https://developers.facebook.com/v21.0/me?fields=id,name

預設查詢正在 /me 節點上要求取得 idname 欄位;此節點為特殊節點,可對應至由憑證識別的 /User/Page 節點。由於您正在使用用戶存取憑證,這會配對至您的用戶節點。

idname 欄位均為公開可用,並可在用戶向您的應用程式授予 defaultpublic_profile 權限時傳回。這些權限都已經過預先批准,可供所有應用程式使用(如要確認,可點擊存取憑證欄位中的資訊圖示),因此您無需向應用程式授予任何額外權限,查詢即可運作。只需點擊取得存取憑證,然後確認您想授權應用程式存取您公開可用的用戶資訊。

提交查詢後,您將會在回應視窗中看到您的應用程式範圍用戶編號和名稱。