開發人員 API

Developer API 可存取已提供所有家庭資產的中繼資料 由 Google Fonts 提供可讓應用程式查詢 可用字型系列的 Google Fonts。 REST API 以 JSON 格式提供資料,包括樣式和指令碼 (在 Google Fonts 中稱為子集)。API 可以排序 家族成員數量:按字母順序、新增日期、風格數量、趨勢或依據 人氣指數。

目標對象

本文件適用對象為網頁和應用程式開發人員,使用 Developer 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 金鑰

取得金鑰

或是在「憑證」頁面中建立。

取得 API 金鑰後,應用程式便可附加查詢參數 所有要求網址的 key=yourAPIKey

API 金鑰可以安全地嵌入網址中,不需任何編碼。

詳細資料

JSON 回應 (請參考上方的範例) 是由名為「items」的陣列所組成 其中包含含有每個字型系列相關資訊的物件。

系列物件由下列欄位組成:

  • kind:物件種類、網路字型物件
  • 家人名稱
  • 子集:系列支援的指令碼清單
  • 選單:一個只包含家族名稱的系列網址。
  • 子類:系列產品可用的不同樣式
  • version:字型系列版本。
  • 軸:軸範圍,只有在要求時才會呈現可變字型。
  • last 修改: 修改字型系列的日期 (格式為「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:依字母順序排序清單
  • date:按照新增日期排序清單 (優先新增或更新字型)
  • 熱門程度:依熱門程度排序清單 (優先顯示最受歡迎的產品系列)
  • style:依可用的樣式數量排序清單 (具有最多樣式的系列) 第一)
  • 熱門:按使用人數成長的家庭排序清單 (家庭觀察對象為 成長率最高)

篩選

查詢特定係列

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

可變字型

可變字型提供連續樣式範圍。根據預設,系統會結合 針對以標準方式例項化的可變字型傳回靜態字型檔案 位置。 如果設定了 capability=VF,則會傳回可變數字型檔案,而非靜態字型檔案 以及可用的軸範圍中繼資料 範例:

https://www.googleapis.com/webfonts/v1/webfonts?capability=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:字型子集的名稱。

capabilityVF |WOFF2

sortalpha |date |popularity |style |trending