Developer API 可讓您存取 Google Fonts 提供的所有家庭的中繼資料。可讓應用程式查詢 Google Fonts 以取得可用的字型系列。REST API 以 JSON 格式提供資料,其中包含每個系列中的樣式和指令碼 (在 Google Fonts 中稱為子集)。API 可依字母順序、新增日期、樣式、趨勢或熱門程度排序家庭清單。
目標對象
這份文件適用於網頁和應用程式開發人員。使用開發人員 API 需要瞭解 JavaScript。
簡短範例
若要擷取 Google Fonts 服務提供的字型清單,請傳送下列要求:
https://www.googleapis.com/webfonts/v1/webfonts?key=YOUR-API-KEY
結果示例如下:
{ "kind": "webfonts#webfontList", "items": [ [...] { "family": "Anonymous Pro", "variants": [ "regular", "italic", "700", "700italic" ], "subsets": [ "cyrillic", "greek", "latin", "latin-ext" ], "version": "v21", "lastModified": "2022-09-22", "files": { "regular": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2Bp2a15UIB7Un-bOeISG3pLlw89CH98Ko.ttf", "italic": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2fp2a15UIB7Un-bOeISG3pHl428AP44Kqr2Q.ttf", "700": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2cp2a15UIB7Un-bOeISG3pFuAT0CnW7KOywKo.ttf", "700italic": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2ap2a15UIB7Un-bOeISG3pHl4OTCzc6IG30KqB9Q.ttf" }, "category": "monospace", "kind": "webfonts#webfont", "menu": "http://fonts.gstatic.com/s/anonymouspro/v21/rP2Bp2a15UIB7Un-bOeISG3pHl028A.ttf" }, { "family": "Antic", "variants": [ "regular" ], "subsets": [ "latin" ], "version": "v19", "lastModified": "2022-09-22", "files": { "regular": "http://fonts.gstatic.com/s/antic/v19/TuGfUVB8XY5DRaZLodgzydtk.ttf" }, "category": "sans-serif", "kind": "webfonts#webfont", "menu": "http://fonts.gstatic.com/s/antic/v19/TuGfUVB8XY5DRZZKq9w.ttf" }, [...] ] }
向 Google 識別您的應用程式
每次傳送要求給 Google Fonts Developer API 時,應用程式都必須識別要求,並在每項要求中加入 API 金鑰。
取得及使用 API 金鑰
取得金鑰您也可以在「憑證」頁面中建立憑證。
取得 API 金鑰後,應用程式就能將查詢參數 key=yourAPIKey
附加至所有要求網址。
API 金鑰可以安全地嵌入網址中,不需任何編碼。
詳細說明
JSON 回應 (請見上方範例) 由名為「items」的陣列所組成,其中包含具有每個字型系列相關資訊的物件。
家庭物件由下列欄位組成:
- 種類:物件種類、webfont 物件
- 系列:系列名稱
- 子集:系列支援的指令碼清單
- 選單:家庭群組系列的網址,僅包含系列名稱。
- 子類:家庭可用的不同樣式
- 版本:字型系列版本。
- axes:焦距範圍,只在要求時顯示(請參閱下文),變數字型。
- lastModified:上次修改字型系列的日期 (格式為「yyyy-MM-dd」)。
- 檔案:每個可用變化版本的字型系列檔案 (含所有支援的指令碼)。
藉由結合各家庭的資訊,您可以輕鬆建立 Fonts API 要求。舉例來說,假設我們參照了匿名專家家庭物件:
[...] var apiUrl = []; apiUrl.push('https://fonts.googleapis.com/css?family='); apiUrl.push(anonymousPro.family.replace(/ /g, '+')); if (contains('italic', anonymousPro.variants)) { apiUrl.push(':'); apiUrl.push('italic'); } if (contains('greek', anonymousPro.subsets)) { apiUrl.push('&subset='); apiUrl.push('greek'); } // url: 'https://fonts.googleapis.com/css?family=Anonymous+Pro:italic&subset=greek' var url = apiUrl.join(''); [...]
排序
根據預設,家庭清單不會按特定順序傳回。不過,您可以使用排序參數來排序清單:
https://www.googleapis.com/webfonts/v1/webfonts?sort=popularity
可能的排序值包括:
- alpha:清單依字母順序排列
- 日期:將清單依新增日期排序 (最近新增或更新字型)
- 熱門程度:將熱門程度排序 (由熱門家庭排序)
- 樣式:根據可用的樣式數量排序清單 (先列出最多樣式的家庭)
- 熱門趨勢:依使用次數顯示全家人的排序清單 (家庭人數最多)
篩選
查詢特定係列
https://www.googleapis.com/webfonts/v1/webfonts?family=family_name
支援希臘子集的家庭
https://www.googleapis.com/webfonts/v1/webfonts?subset=subset_name
最佳化
用於擷取以 woff2 格式壓縮的字型檔案
https://www.googleapis.com/webfonts/v1/webfonts?capability=WOFF2
變數字型
變數字型提供連續樣式。根據預設,系統會針對靜態位置執行個體化的可變字型,傳回一組靜態字型檔案。如果設定 capaibility=VF
,系統會傳回變數字型檔案,而非靜態檔案和可用的 X 軸中繼資料中繼資料。範例:
https://www.googleapis.com/webfonts/v1/webfonts?capaibility=VF
回應範例:
{ "kind": "webfonts#webfontList", "items": [ [...] { "family": "Noto Sans Display", "variants": [ "regular", "italic" ], "subsets": [ "cyrillic", "cyrillic-ext", "greek", "greek-ext", "latin", "latin-ext", "vietnamese" ], "version": "v20", "lastModified": "2022-09-22", "files": { "regular": "http://fonts.gstatic.com/s/notosansdisplay/v20/RLplK4fy6r6tOBEJg0IAKzqdFZVZxokvfn_BDLxR.ttf", "italic": "http://fonts.gstatic.com/s/notosansdisplay/v20/RLpjK4fy6r6tOBEJg0IAKzqdFZVZxrktdHvjCaxRgew.ttf" }, "category": "sans-serif", "kind": "webfonts#webfont", "menu": "http://fonts.gstatic.com/s/notosansdisplay/v20/RLpbK4fy6r6tOBEJg0IAKzqdFZVZxpMkXJMhnB9XjO1o90LuV-PT4Doq_AKp_3cKZTCa3g.ttf", "axes": [ { "tag": "wdth", "start": 62.5, "end": 100 }, { "tag": "wght", "start": 100, "end": 900 } ] }, [...] ] }
API 網址規格
webfonts?key=<your_key>[&family=<family>][&subset=<subset>][&capability=<capability>...][&sort=<sort>]
your_key
:您的開發人員 API 金鑰。
family
:字型系列的名稱。
subset
:字型子集的名稱。
capability
:VF
| WOFF2
。
sort
:alpha
| date
| popularity
| style
| trending
。