डेवलपर एपीआई

Developer API, Google Fonts की सभी फ़ैमिली के मेटाडेटा का ऐक्सेस देता है. इसकी मदद से, ऐप्लिकेशन उपलब्ध फ़ॉन्ट फ़ैमिली के लिए, Google Fonts से क्वेरी कर सकते हैं. REST API, डेटा को JSON फ़ॉर्मैट में उपलब्ध कराता है. इसमें हर फ़ैमिली की स्टाइल और स्क्रिप्ट (Google Fonts में इन्हें सबसेट कहा जाता है) शामिल होती हैं. एपीआई, फ़ैमिली की सूची को वर्णमाला के क्रम में, जोड़े जाने की तारीख के हिसाब से, स्टाइल की संख्या के हिसाब से, रुझान के हिसाब से या लोकप्रियता के हिसाब से क्रम में लगा सकता है.

ऑडियंस

यह दस्तावेज़, वेब और ऐप्लिकेशन डेवलपर के लिए है. 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 को हर अनुरोध भेजने पर, आपके ऐप्लिकेशन को अपनी पहचान बतानी होगी. इसके लिए, हर अनुरोध के साथ एपीआई पासकोड शामिल करना होगा.

एपीआई पासकोड हासिल करना और उसका इस्तेमाल करना

कुंजी पाना

इसके अलावा, क्रेडेंशियल पेज पर जाकर भी एक OAuth क्लाइंट आईडी बनाया जा सकता है.

एपीआई पासकोड मिलने के बाद, आपका ऐप्लिकेशन सभी अनुरोध यूआरएल में क्वेरी पैरामीटर key=yourAPIKey जोड़ सकता है.

एपीआई पासकोड को यूआरएल में जोड़ने के लिए सुरक्षित माना जाता है. इसे कोड में बदलने की ज़रूरत नहीं होती.

विवरण

JSON रिस्पॉन्स (ऊपर दिए गए सैंपल को देखें), "items" नाम के कलेक्शन से बना होता है. इसमें हर फ़ॉन्ट फ़ैमिली के बारे में जानकारी देने वाले ऑब्जेक्ट होते हैं.

फ़ैमिली ऑब्जेक्ट में ये फ़ील्ड होते हैं:

• kind: ऑब्जेक्ट का टाइप, वेबफ़ॉन्ट ऑब्जेक्ट
• family: परिवार का नाम
• सबसेट: फ़ैमिली ग्रुप में शामिल सदस्यों के लिए काम करने वाली स्क्रिप्ट की सूची
• menu: फ़ैमिली ग्रुप के सबसेट का यूआरएल, जिसमें सिर्फ़ फ़ैमिली ग्रुप का नाम शामिल होता है.
• वैरिएंट: फ़ैमिली ग्रुप के लिए उपलब्ध अलग-अलग स्टाइल
• version: फ़ॉन्ट फ़ैमिली का वर्शन.
• axes: ऐक्सिस की रेंज, वैरिएबल फ़ॉन्ट के लिए सिर्फ़ अनुरोध करने पर दिखती है(यहां देखें).
• lastModified: फ़ॉन्ट फ़ैमिली में आखिरी बार बदलाव किए जाने की तारीख (फ़ॉर्मैट "yyyy-MM-dd").
• फ़ाइलें: उपलब्ध हर वैरिएंट के लिए, फ़ॉन्ट फ़ैमिली फ़ाइलें (सभी काम करने वाली स्क्रिप्ट के साथ).

हर फ़ैमिली की जानकारी को जोड़कर, Fonts API का अनुरोध आसानी से बनाया जा सकता है. उदाहरण के लिए, मान लें कि हमारे पास Anonymous 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

फ़ॉन्ट कैटगरी के हिसाब से फ़िल्टर करना

https://www.googleapis.com/webfonts/v1/webfonts?category=category_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
      }
    ]
  },
  [...]
 ]
}

एपीआई यूआरएल की खास बातें

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

your_key: आपका डेवलपर एपीआई पासकोड.

family: फ़ॉन्ट फ़ैमिली का नाम.

subset: फ़ॉन्ट के किसी सबसेट का नाम.

category: serif | sans-serif | monospace | display | handwriting

capability: VF | WOFF2.

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