Interfejs API dla programistów

Developer API zapewnia dostęp do metadanych wszystkich rodzin obsługiwanych przez Google Fonts. Pozwala to aplikacjom wysyłać zapytania o dostępne rodziny czcionek. Interfejs API REST dostarcza dane w formacie JSON, który obejmuje style i skrypty (nazywane podzbiorami w Google Fonts) w każdej rodzinie. Interfejs API może sortować listę rodzin alfabetycznie, według daty dodania, liczby stylów, trendu lub popularności.

Odbiorcy

Ten dokument jest przeznaczony dla programistów stron internetowych i aplikacji. Używanie interfejsu Developer API wymaga znajomości języka JavaScript.

Krótki przykład

Aby pobrać dynamiczną listę czcionek oferowanych w usłudze Google Fonts, wyślij to żądanie:

https://www.googleapis.com/webfonts/v1/webfonts?key=YOUR-API-KEY

Przykładowy wynik będzie wyglądał tak: 

{
 "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"
  },
  [...]
 ]
}

Identyfikowanie aplikacji do Google

Aplikacja musi identyfikować się za każdym razem, gdy wysyła żądanie do interfejsu Google Fonts Developer API, umieszczając w każdym żądaniu klucz interfejsu API.

Uzyskiwanie i używanie klucza interfejsu API

Kup klucz

Możesz też utworzyć je na stronie Dane logowania.

Gdy uzyskasz klucz interfejsu API, Twoja aplikacja może dołączać parametr zapytania key=yourAPIKey do adresów URL wszystkich żądań.

Klucz interfejsu API można bezpiecznie umieszczać w adresach URL, więc nie trzeba go kodować.

Szczegóły

Odpowiedź JSON (patrz przykład powyżej) składa się z tablicy o nazwie „items”, która zawiera obiekty z informacjami o każdej rodzinie czcionek.

Obiekt rodziny składa się z następujących pól:

  • rodzaje: rodzaj obiektu,
  • family: imię i nazwisko rodziny.
  • podzbiory: lista skryptów obsługiwanych przez rodzinę,
  • menu: adres URL podzbioru rodziny obejmującego tylko nazwę rodziny.
  • wersje: różne style dostępne dla rodziny.
  • wersja: wersja rodziny czcionek.
  • osie: zakres osi, występuje tylko na żądanie(patrz poniżej) w przypadku czcionek zmiennych.
  • lastModified: data (format „rrrr-MM-dd”), data ostatniej modyfikacji rodziny czcionek.
  • files: pliki rodziny czcionek (ze wszystkimi obsługiwanymi skryptami) w przypadku każdego z dostępnych wariantów.

Łącząc informacje z każdej rodziny, można łatwo utworzyć żądanie do interfejsu Fonts API. Załóżmy np., że mamy odwołanie do obiektu rodzinnego anonimowego 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('');

[...]

Sortowanie

Domyślnie lista rodzin nie jest zwracana w określonej kolejności. Listę można jednak sortować za pomocą parametru sortowania:

https://www.googleapis.com/webfonts/v1/webfonts?sort=popularity

Możliwe wartości sortowania:

  • alfa: sortowanie listy alfabetycznie
  • date: sortowanie listy według daty dodania (najpierw dodaj lub zaktualizuje najnowsze czcionki);
  • popularność: sortowanie listy według popularności (malejąco)
  • style: Sortuj listę według liczby dostępnych stylów (najpierw większość stylów)
  • zyskujące popularność: sortowanie listy według rodzin, w których korzystanie z aplikacji jest w ciągu wzrostu (rodzina odnotowuje największy wzrost)

Filtrowanie

Zapytanie dotyczące konkretnej rodziny

https://www.googleapis.com/webfonts/v1/webfonts?family=family_name

Wszystkie rodziny wspierające podzbiór grecki

https://www.googleapis.com/webfonts/v1/webfonts?subset=subset_name

Optymalizacja

Do pobierania plików czcionek skompresowanych w formacie woff2

https://www.googleapis.com/webfonts/v1/webfonts?capability=WOFF2

Zmienne czcionki

Zmienne czcionki zapewniają stały zakres stylów. Domyślnie w przypadku czcionek zmiennych utworzonych w pozycjach standardowych zwracana jest kombinacja statycznych plików czcionek. Jeśli ustawiona jest wartość capability=VF, zamiast statycznych wartości zwracany jest plik ze zmiennymi czcionek wraz z dostępnymi metadanymi zakresów osi. Przykładowy przykład:

https://www.googleapis.com/webfonts/v1/webfonts?capability=VF

Przykładowa odpowiedź: 

{
 "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
      }
    ]
  },
  [...]
 ]
}

Specyfikacja adresu URL interfejsu API

webfonts?key=<your_key>[&family=<family>][&subset=<subset>][&capability=<capability>...][&sort=<sort>]

your_key: Twój klucz interfejsu API dla programistów.

family: nazwa rodziny czcionek.

subset: nazwa podzbioru czcionek.

capability: VF | WOFF2.

sort: alpha | date | popularity | style | trending.