डेवलपर एपीआई

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

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

कुंजी पाएं

या क्रेडेंशियल पेज पर जाकर क्रेडेंशियल बनाएं.

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

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

ब्यौरा

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

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

  • प्रकार: ऑब्जेक्ट का प्रकार, वेबफ़ॉन्ट ऑब्जेक्ट
  • परिवार: परिवार का नाम
  • सबसेट: परिवार की सहायता से काम करने वाली स्क्रिप्ट की सूची
  • मेन्यू: फ़ैमिली ग्रुप का यूआरएल, जिसमें सिर्फ़ परिवार का नाम दिखता है.
  • वैरिएंट: फ़ैमिली के लिए उपलब्ध अलग-अलग स्टाइल
  • वर्शन: फ़ॉन्ट फ़ैमिली वर्शन.
  • ऐक्सिस: ऐक्सिस रेंज, वैरिएबल फ़ॉन्ट के लिए अनुरोध करने पर ही प्रज़ेंट की जाती है(नीचे देखें).
  • पिछली बार बदलाव करने की तारीख: फ़ॉन्ट फ़ैमिली में पिछली बार किए गए बदलाव की तारीख ("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

क्रम से लगाने के लिए, ये वैल्यू इस्तेमाल की जा सकती हैं:

  • वर्णमाला: सूची को वर्णमाला के क्रम में लगाएं
  • तारीख: सूची को जोड़े जाने की तारीख के मुताबिक क्रम से लगाएं (सबसे हाल में जोड़े गए या अपडेट किए गए फ़ॉन्ट)
  • लोकप्रियता: सूची को लोकप्रियता के हिसाब से क्रम में लगाएं (सबसे लोकप्रिय परिवार पहले)
  • शैली: सूची को उपलब्ध शैलियों की संख्या के अनुसार क्रम से लगाएं (सबसे ज़्यादा शैलियों वाला परिवार)
  • रुझान में है: इस्तेमाल में बढ़ोतरी को देखने वाले परिवारों के हिसाब से सूची में क्रम से लगाएं (परिवार को सबसे पहले सबसे ज़्यादा बढ़ोतरी हुई है)

फ़िल्टर करना

किसी खास फ़ैमिली की क्वेरी करें

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

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

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

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

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

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

capability: VF | WOFF2.

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