Looker API 4.0 正式發布

我們很高興宣布,Looker API 4.0 已在 Looker 22.4 中正式推出。正式推出的 API 4.0 (API 4.0 GA) 有多項破壞性變更和新增功能,並將多個端點從 Beta 版升級為穩定版。如需 API 4.0 的詳細規格,請參閱 API 參考資料。我們已更新 Looker 支援和社群支援的 SDK,以支援 Looker API 4.0 GA 端點。詳情請參閱 API 和 SDK 支援政策API 版本管理。本文其餘部分將說明破壞性變更、因應措施,以及遷移至 API 4.0 GA 後可望獲得的功能。

這份文件適合哪些人閱讀?

如果您透過 Looker 支援的 SDK、社群支援的 SDK 或 API 本身使用 Looker API,這份文件就適合您。請閱讀與您使用的 Looker API 版本對應的章節。

API 4.0 正式發布前版本使用者

如果您使用 API 4.0,請閱讀本節。本文說明遷移至 API 4.0 正式版時的破壞性變更,以及可用的解決方式。

API 4.0 正式版會將所有實體 ID 欄位從數字 integer 型別變更為 string 型別。舉例來說,GET /groups/{group_id} endpoint 會傳回 id 做為 string 類型,而不是 int64 類型。

請詳閱下表,瞭解使用 API 4.0 端點的影響和因應措施:

用量 潛在影響1 預防方法
Looker 行動應用程式 舊版 Looker 行動應用程式將停止運作 請使用者更新至最新版 Looker 行動應用程式
Looker 支援的 2 SDK
TypeScript SDK (4.0 API) 沒有影響 無須採取任何行動
Python SDK (4.0 API) 沒有影響 無須採取任何行動
Ruby SDK (4.0 API) 沒有影響 無須採取任何行動
社群支援2 SDK
Swift SDK 執行階段例外狀況 將 SDK 更新至 22.0 以上版本,然後解決產生的型別錯誤 (如有)
Kotlin SDK 沒有影響 無須採取任何行動
LookR SDK 沒有影響 無須採取任何行動
C# SDK 沒有影響 無須採取任何行動
Go SDK 執行階段例外狀況 將 SDK 更新至 22.0 以上版本,然後解決產生的型別錯誤 (如有)
其他
使用 4.0 API,但不使用 SDK (或使用外部提供的程式庫) 可能發生執行階段錯誤,視語言的型別敏感度而定 檢查程式碼中是否有任何 ID 欄位類型相依性,並新增對字串類型 ID 欄位的支援。另請參閱這份額外指南

1:假設常見的使用模式可能包含使用 Looker 的 ID 欄位,但不包含異常使用模式,例如對 ID 套用數值運算。

2:Looker API 和 SDK 支援。社群支援的程式庫並非 Looker 正式支援的程式庫。

API 3.1 使用者

如果您使用 API 3.1,請閱讀本節。本節將說明 API 4.0 提供的額外功能和變更。請注意,我們支援的 Looker SDK 和社群支援的 SDK 主要支援 API 4.0。詳情請參閱 SDK 和 API 支援政策

其他 API 4.0 正式發布版功能

為方便起見,我們列出 API 4.0 最顯著且實用的新增項目:

API 4.0 GA 淘汰異動

API 4.0 正式版會取代多個已淘汰的 API 3.1 端點,並提供改良功能。受影響的端點如下:

API 3.0 使用者

API 3.0 已淘汰,建議您遷移至 API 4.0。

  • 只有 API 4.0 支援所有 Looker 支援和社群支援的 SDK,方便您進行開發。請參閱我們的 SDK 存放區
  • API 4.0 推出多項新功能和強化項目,詳情請參閱本頁的「API 4.0 正式版新增功能」一節。

總結

我們將在 API 4.0 中加入新功能和增量異動,您隨時可以在 API 參考資料中查看最新異動。詳情請參閱 API 和 SDK 支援政策API 版本管理。我們瞭解破壞性變更並非理想做法,因此除非發生極端問題,否則不會對正式發布的 API 4.0 進行任何破壞性變更。我們希望正式發布的 Looker API 4.0 能協助您在 Looker 平台上更有效率地開發產品。