डेवलपर एपीआई

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

ऑडियंस

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

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

कुंजी पाएं

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

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

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

ब्यौरा

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

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

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

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

वैरिएबल फ़ॉन्ट

वैरिएबल फ़ॉन्ट में आपको कई तरह के स्टाइल मिलते हैं. डिफ़ॉल्ट रूप से, स्टैंडर्ड फ़ॉन्ट में इंस्टैंशिएट किए गए वैरिएबल फ़ॉन्ट के लिए, स्टैटिक फ़ॉन्ट फ़ाइलों का एक कॉम्बिनेशन दिखाया जाता है. अगर capaibility=VF सेट है, तो उपलब्ध ऐक्सिस रेंज मेटाडेटा के साथ स्टैटिक फ़ॉन्ट की जगह वैरिएबल की फ़ॉन्ट फ़ाइल मिलती है. उदाहरण के लिए:

https://www.googleapis.com/webfonts/v1/webfonts?capaibility=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.