跳到主要內容

Graph API是什麼東東?

Graph API是Facebook所推出的一種技術標準,它的核心概念是: 「物件與連結」。為什麼稱為「Graph API」呢? Facebbook將整個社群抽象為物件與物件之間連結的圖,來看看我畫的示意圖:

中間那個帥氣的騎士,就是在下,我與其它物件的連結就是透過彼此的關係。舉例來說,我與上方兩位猛男就是朋友(friends)的連結;左邊就是所謂的相本(albums)的連結;右邊的忐忑與火影忍者分別是音樂(music)與書籍(books)的連結;下面的就是所謂的讚(likes)的連結,魏小猴讚啦!猛男與我都是屬於User的物件,因此也有friends、albums、music、book等連結。這讓我可以透過這樣的連結關係去得知兩位猛男的朋友(freinds)名單。左邊的相本屬於Album的物件,也可以透過它的讚(likes)的連結去找到誰覺得這相本很讚,透過圖片(photos)連結可以找到相本內的圖片。整個Facebook就是透過這些物件與連結建立而成的Social Graph。Facebook所提供存取的介面,就稱為「Graph API」。

如何使用?

Facebook提供給外部程式存取的方式就是URL,如果以Javascript實作就是透過Ajax,Java可以用HttpConnection或直接用HttpClient的API,簡單而言就是「透過Http的Request」。發出請求的URL格式如下,「ID為物件id,CONNECTION_TYPE為物件連結的種類」:

https://graph.facebook.com/ID/CONNECTION_TYPE

舉例來說,我想存取某一個User的物件,可以透過它的id存取:

https://graph.facebook.com/100000274774093/

而Facebook會給你Json format的回傳內容,以User物件而言,在沒有授權的情況下,能夠存取到以下這些欄位:

{
   "id": "100000274774093",
   "name": "鄭發哥",
   "first_name": "發哥", 
"last_name": "鄭",
"link": "https://www.facebook.com/rusiasia", "username": "rusiasia", "gender": "male", "locale": "zh_TW" }

如果我想查詢User 100000274774093的朋友名單,可以加上friends的connection type,但它是需要使用者授權的喔!

https://graph.facebook.com/100000274774093/friends?access_token=xxxxxxxxx....

回傳的結果如下:

{
  "data": [
    {
      "name": "Natalie Lee", 
      "id": "527104164"
    }, 
    {
      "name": "阿倫", 
      "id": "538008660"
    }, 
    {
      "name": "Tsung Ham Shen", 
      "id": "544172024"
    }, 
    ...

如果沒有授權,會出現這樣的回傳結果:

{
  "error": {
    "message": "(#604) Can't lookup all friends of 1000559192. Can only lookup 
         for the logged in user or the logged in user's friends that are users of your app.", 
    "type": "OAuthException", 
    "code": 604
  }
}

那我要怎麼知道Facebook到底有哪些物件,物件的哪些欄位需要授權,連結型態有哪些呢?

物件?連結型態?權限?

Facebook提供了多少物件的存取、各個物件所提供的欄位,都可以在Developers文件中查詢到。下圖就是目前Facebook所支援的物件種類,點擊進去各連結可以看到物件支援的欄位與連結型態。


如User物件所支援的欄位。在先前取得User 100000274774093的範例中,如果應用程式沒經過使用者授權,如下圖所示,我們僅能取得id、name、first_name等欄位。如果想要取得使用者設定的languages欄位,使用者必須授權user_likes這個權限並使用access_token去存取Graph API。我們的應用程式想要取得什麼欄位,只要根據這個表格的欄位與權限對應資訊,我們就可以和使用者要求怎麼樣的授權。(access_token即應用程式存取Facebook資源的一把鑰匙)

連結型態也是一樣。如果想取得User的相簿(albums),應用程式就需要使用者的user_photos授權。顧名思義,friends_photos就是為了要取得朋友相簿的授權。

讓我們來個練習!

假如我想取得朋友的生日,那我該怎麼做呢?有以下幾個步驟:

  • friends_birthday的授權: 要取得朋友的生日欄位,必須要使用者有提供friends_birthday的權限。
  • 取得朋友列表: 透過friends的連結型態去取得我的朋友列表,這只要有access_token就能夠使用了!
  • 使用朋友的id去呼叫Graph API: 就是Http的Request。

這個範例不需要寫任何程式碼,主要透過Facebook提供的Graph API測試工具:「Graph API瀏覽工具」,讓我們使用它來練習吧!(讀萬卷書不如行萬里路,動手做做看)

取得Access Token

首先在Graph API瀏覽工具的畫面中,點擊取得存取代碼,我們需要授權的是Friends Data Permissions中的friends_birthday。

點擊Get Access Token後,會出現授權的對話盒,我想這大家應該不陌生。授權後我們就有access_token可以使用了!

取得朋友列表

在URL的地方輸入me/friends去取得我的朋友列表,其中me代表目前登入的使用者,它是個User的物件。點擊確認後就可以在下方看到輸出結果。

取得朋友生日

為了避免讓人認為我是色胚,我們以阿倫為範例,id為538008660。我們直接在URL上輸入538008660,就會出現阿倫的個人資料了。


看到了嗎?是不是很簡單呢?

Summary

這篇文章的目的要讓你對Graph API有基本的認識,包含該怎麼去看Document去得知該怎麼去取得你要的資料。以下幾個項目可能是你還有疑問又或者是期望想看到的:

  • 授權項目中,也包含了授權存取朋友的資料。但需要注意的是,如果朋友不想讓你看到他的相簿,即使你授權給應用程式,也別想看到裡面的美女圖拉!所以別以為你可以透過這個管道看到某些正妹的「私藏」!
  • acess_token到底要怎麼獲得呢?這個問題其實有點複雜也可以說很簡單。簡單來說,就是透過Facebook提供的OAuth2.0認證機制,根據你需要的權限讓使用者授權並取得access_token。但實作上,又會根據不同種類的應用程式有所差別。在之後的文章中,我會再一一介紹。
  • 說好的實作呢? 一般Web應用程式透過Javascript SDK已經綽綽有餘了,藉由FB.login做認證並取得access_token,透過FB.api呼叫Graph API。其它如PHP、iOS、Android,Facebook都有提供SDK;Adobe也提供了Flash的SDK。雖說有那麼多的SDK,在之後的文章我的主力也是放在介紹Java的Grah API - RestFB。所以,其它的等我寫到再說吧!
  • 再簡單也只不過是URL? Graph API是很強大滴,除了上述的內容外,還提供了資料分頁、資料編碼設定、Query條件、發佈、刪除、Locale設定、批次執行等API支援。說那麼多我也不是全會啦,但我有著好學不倦的精神,以後有機會再一一分享給大家。

留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後,Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護,我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情,主要先把明確的runtime語法錯誤與deprecate item處理好,這部分內容可以參考: link 。 直到最近才發現,透過SeleniumLibrary執行Choose File去上傳檔案的動作,會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法,我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住,有些測試案例是可以執行的,但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作,因為我使用 Remote Selenium ,所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現,在3.2.2的最後一個TCP封包,比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容,還有HTTP Content-Length的計算,我都確認過沒有問題。 最後發現問題是出在socket API的使用上,就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料,但沒處理到尚未送完的資料內容,而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方,在他們出新的版本之前,我是將改完的_socket.py放在我們自己的Lib底下,好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後,安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數,以前試驗過是可以安裝完成的。因此在發生這個問題後,我檢查了它的debug console: 從console得知,eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認,有問題的是有接網路線的網卡,且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制,因此發現在Anaconda的說明文件中( link ),有提到dhcptimeout這個boot參數。看了一些人的使用範例,應該是可以直接串在isolinux.cfg中,如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串,問問Google大師,想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ,關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中;在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知,它讀取的檔案是answer file而不是boot command line。因此我接下來的測試,就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...

Robot Framework - Evaluate該怎麼用?

Evaluate該怎麼用? 前言 Builtin的RobotFramework Library提供了Evaluate Keyword。它所提供的功能是「執行Python描述句」。但實際上到底有什麼用途呢?原本我僅僅拿來將string轉為int的功用,經過一些查詢與試驗,我將心得整理給大家。 Builtin Builtin的function可以參考Library Doc for Evaluate。我以有使用過的function做說明。 數字轉換 Python提供了int、long、float與complex等function讓你可以將字串轉為數字,也可以透過它們做四則運算。首先以字串轉數字為例,我將8設於${num_str}中,再透過Evaluate+int轉為數字。這裡必須注意的是: 「int()中放變數必須以單引號'括起」。否則,假如你設定的數字為08,在轉換int時會出現Syntax Error。 ${num_str} | Set Variable | 8 ${num} | Evaluate | int('${num_str}') 其中int與long的第二個參數為base,這是根據你的input所決定: Comment | num = 9 ${num} | Evaluate | int('11', 8) Comment | num = 11 ${num} | Evaluate | int('11', 10) Comment | num = 17 ${num} | Evaluate | int('11', 16) 其它還有像bin、oct、hex,可以將整數轉為2、8、16進位。 運算 四則運算: 直接將運算子加上即可: ${num} | Evaluate | int('${hour}')*60 + int('${min}') 指數: 可以用pow。以下面兩個例子來說,第一個是2的3次方為8,第二個是2的3次方再mod 7為1。需注意的是: 「傳入值必須是數字不可為字串」。 ${num} | Evaluate | pow(2,3) ${num} | Evaluate | pow(2,3,7) 取最大最小值: 使用max/min,可以選擇丟一個array的方式...