利用 Developer API,您可以访问所投放的所有系列的元数据 由 Google Fonts 提供它允许应用查询 适用于可用字体系列的 Google Fonts。通过 REST API 以 JSON 格式提供数据,其中包括样式和脚本 (在 Google Fonts 中称为子集)。API 可以对 按字母顺序、添加日期、样式数量、趋势或 热门程度。
受众群体
本文档适用于 Web 和应用开发者。使用 开发者 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:对象的种类,即网页字体对象
- family:系列的名称
- subs:系列支持的脚本列表
- menu:指向家人群组子集的网址,仅包含家人群组名称。
- 变体:系列中可用的不同样式
- version:字体系列版本。
- axes:轴范围,仅在请求(见下文)可变字体时显示。
- lastModified:修改字体系列的日期(格式为“yyyy-MM-dd”) 。
- 文件:每个 可用的变体。
通过组合每个系列的信息,可以轻松创建 Fonts API 请求。例如,假设我们引用了 匿名 Pro:
[...] 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:按字母顺序对列表排序
- 日期:按添加日期对列表进行排序(最近添加或更新的字体最先)
- 热门程度:按热门程度对列表进行排序(热门家庭在前)
- 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
:字体子集的名称。
capability
:VF
|WOFF2
。
sort
:alpha
|date
|popularity
|style
|trending
。