PHP Client 操作 Google APIs (1) 開啟與測試 API

應該很多人不知不覺中身邊就充滿了 Google 服務吧!舉凡是 Gmail、Google Maps、Google 雲端硬碟、Google 表單、Google 試算表、Google 文件 … 等,這些服務除了透過對應的軟體或網頁使用外,Google 其實也提供了很多 API 服務,通稱 Google APIs ,讓使用者可以透過這些 API 來打造自己的 Google 服務。

可能有很多人不懂 Google 提供的 APIs 能做什麼,以及有哪些 Google APIs,只要到 Google Cloud Platform 就可以看到 Google 提供的所有 API,所有你想得到的 Google 服務,幾乎都有對應開放的 API,差別在於每個 API 使用的次數跟頻率有所限制,還有另一個是 Google 開放的 API 裡面「並不會」接露所有功能。

舉個 Google Maps 的例子,使用 Google Maps 時除了地圖、店家資訊及使用者評論等等,中間還有一個熱門時段,讓使用者可以清楚知道哪個時段會比較多人,就可以避開熱門時段,挑個比較少人的時間去,好友當時就是因為 Google Maps API 沒有提供這個功能,因此小蛙才幫忙用爬蟲的方式解決這個問題。

Google Maps 熱門時段

連上 Google Cloud Platform 可以看到很多各式各樣你想得到或想不到的服務

Google Cloud Platform APIs

開啟 Google APIs

小蛙這系列都會用 Google Search Console 來當作範例,其他 API 原理基本上都差不多,只是呼叫的方式跟屬性設定有所不同,開始吧!

首先連到 Google Cloud Platform 從上方(1)選取一個要使用 API 的專案(2),如果沒有專案的話可以建一個新的(3)

Google Cloud Platform Select a project

搜尋要開啟的 API (1),點進去 (2)

Google Cloud Platform Keyword Search

點上面的 Enable 就可以開啟該 API 了,下面有一些 API 說明可以看看

Google Cloud Platform Enable Google Search Console API

API 成功開啟後,左邊的 Credentials 可以設定 API 認證的部份,不過這裡小蛙到第三篇文章的時候才會提到

Google Cloud Platform Side Menu

測試 API 說明

回到剛剛啟動 Google Search Console API 的頁面,這次點選右邊 TRY THIS API

Google Cloud Platform TRY THIS API

開出來的頁面是 Search Console URL Testing Tools API,不過小蛙這邊要用的不是這個 API,而是能取得 Google Search Console 裡面資料的 API,因此點選左上角 (1)

Google Search Console APIs > URL Testing Tools API (Beta)

回到 Google Search Console APIs 首頁後進入 Search Console API

Google Search Console APIs

找到下面的 Try it in your browser

Try out the Google Search Console API

接著隨便點一個 api 功能

Google Search Console APIs > query

右邊會開啟一個側欄,這邊就是 Google API 的測試工具了,點選右上角的方框 (1) 可將螢幕放大顯示更多資訊

Google Search Console API > Try this API 1

Google Search Console 原本就是以「網站」為目標,因此必填欄位是在 Search Console 裡面的網址 (1),Request body 的部份填入查詢的參數 (2),輸入完成後點選 EXECUTE 執行 (3),下圖 (4) 的地方是真正發送出的 request

Google Search Console API > Try this API 2

使用測試 API

小蛙用記下來 https://noter.tw/ 測試一下 (1),填入一些必要的參數 (2) 取得 2021-05-01 ~ 2021-07-01 區間的資料,只要回傳前 10 筆就好,點選 (3) 的驚嘆號會顯示有哪些屬性可以設定,確定沒問題後 EXECUTE 送出吧!注意:這邊的 siteUrl 一定要是自己的 Search Console 原本就有的資源才可以,也就是說不能去查別人的,不然就太恐怖了!

Google Search Console API > Try this API 3

點了 EXECUTE 後瀏覽器跳出登入畫面,有些可以透過 API Key 來使用,有些則是必須透過 OAuth 2.0 才可以使用,選擇一個帳戶來使用吧~

SSO Login

執行成功後,右上角會產生實際送出的 API

Google Search Console API > Try this API curl

右下角則是顯示回傳結果,可以看見在這區間被點擊的次數為 46,812 次,搜尋曝光有 838,324 次 … 等

Google Search Console API > Try this API results 1

這看起來好像只能取到很基本的資料?不~來把參數做個調整,加上 aggregationTypedimensions 的設定回傳各個頁面的資訊~

Google Search Console API > Request body

查詢結果會根據區間內的點擊數排列,看看剛剛我們加的 dimensions 都在 keys 陣列裡面,包含搜尋字串、頁面、來源國家及日期

Google Search Console API > Try this API results 2

Google Search Console API 啟用跟測試就到這邊,下一篇將繼續介紹環境設定部份。

Google 系列文章:

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。