Google Forms API एक RESTful इंटरफ़ेस है, जिससे आपको फ़ॉर्म और क्विज़ बनाने और उनमें बदलाव करने की सुविधा मिलती है. साथ ही, आपको फ़ॉर्म के जवाब और क्विज़ के ग्रेड पाने, क्विज़ के लिए जवाब वाली कुंजियां सेट अप करने, और पुश नोटिफ़िकेशन पाने की सुविधा भी मिलती है. इस एपीआई के सबसे आम इस्तेमाल में ये टास्क शामिल हैं:
- फ़ॉर्म या क्विज़ बनाना
- फ़ॉर्म या क्विज़ अपडेट करना
- किसी फ़ॉर्म या क्विज़ से जवाब पाना
- फ़ॉर्म का कॉन्टेंट और मेटाडेटा पढ़ें
- पुश नोटिफ़िकेशन सेट अप करना और पाना
नीचे Forms API में इस्तेमाल किए जाने वाले सामान्य शब्दों की सूची दी गई है:
- फ़ॉर्म
Google Forms का एक दस्तावेज़, जिसे Drive में बनाया और सेव किया गया है. हर फ़ॉर्म को
Form
संसाधन से दिखाया जाता है और इसकीformId
वैल्यू यूनीक होती है. इसमें अक्षर, अंक, हाइफ़न या अंडरस्कोर शामिल होते हैं. फ़ॉर्म आईडी, Google Forms के यूआरएल में देखा जा सकता है:https://docs.google.com/forms/d/FORM_ID/edit
- क्विज़
एक खास तरह का Google Forms दस्तावेज़, जिसकी मदद से किसी जवाब वाली कुंजी पर फ़ॉर्म के जवाबों को ग्रेड दिया जा सकता है. मौजूदा फ़ॉर्म की
isQuiz
सेटिंग कोtrue
पर अपडेट करने के लिए,batchUpdate()
तरीके का इस्तेमाल करके ही क्विज़ बनाया जा सकता है.- Item
फ़ॉर्म में मौजूद एक एलिमेंट, जिसे आइटम संसाधन के तौर पर दिखाया जाता है.
Item
बार-बार होने वाला एक एलिमेंट है जिसमें एक सेक्शन, सवालों का ग्रुप, सवाल, टेक्स्ट, इमेज या वीडियो हो सकता है.- सवाल
फ़ॉर्म में मौजूद एक सवाल, जिसे
Question
संसाधन से दिखाया जाता है.- सवालों का ग्रुप
सवालों का एक ऐसा ग्रुप जिसके सभी जवाबों के लिए एक जैसे सेट दिए गए हों. उदाहरण के लिए, 1 से 5 तक की रेटिंग का ग्रिड.
QuestionGroupItem
संसाधन से दिखाया गया है.- Section
सेक्शन, किसी फ़ॉर्म को कई पेजों में बांटने और शर्त के हिसाब से लॉजिक को जोड़ने का तरीका है. जैसे, उपयोगकर्ता के जवाब के आधार पर कुछ सवाल दिखाना. सेक्शन,
PageBreakItem
संसाधन के हिसाब से होते हैं.- जवाब दें
सवाल के लिए, असली उपयोगकर्ता के जवाब को
Answer
संसाधन से दिखाया जाता है. इसमें ग्रेड की जानकारी (अगर मौजूद हो), मेटाडेटा, और जवाब का कॉन्टेंट, दोनों शामिल होते हैं.- जवाब
असली उपयोगकर्ता का सबमिट किया गया फ़ॉर्म, जिसे
FormResponse
संसाधन से दिखाया जाता है.- देखें
यह एक ट्रिगर है, जो फ़ॉर्म स्कीमा में हुए बदलावों (जैसे कि सवालों में होने वाले बदलाव) या फ़ॉर्म रिस्पॉन्स सबमिशन में हुए बदलावों को ट्रैक करता है और कोई बदलाव होने पर पुश नोटिफ़िकेशन भेजता है. इसे
Watch
संसाधन से दिखाया जाता है.
फ़ॉर्म का स्ट्रक्चर
फ़ॉर्म और क्विज़ को मैनेज करते समय, अलग-अलग फ़ील्ड की जानकारी देने का तरीका समझना मुश्किल हो सकता है. ऐसा इसलिए है, क्योंकि कई फ़ॉर्म ऑब्जेक्ट को कई तरीकों से एक-दूसरे के अंदर नेस्ट किया जा सकता है. यह देखने के लिए कि फ़ॉर्म का विज़ुअल प्रज़ेंटेशन फ़ील्ड के साथ कैसे मैप होता है, हमारा सुझाव है कि आप यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके ऐसे फ़ॉर्म के कुछ उदाहरण बनाएं जिन्हें आपका ऐप्लिकेशन जनरेट कर सकता है. इसके बाद, forms.get()
तरीके का इस्तेमाल करके, उससे जुड़ा JSON
वापस पाएं, ताकि तुलना की जा सके. उदाहरण के लिए,
उदाहरण के तौर पर दी गई यह क्विज़, नीचे दिए गए JSON से जुड़ी है:
{
"formId": "FORM_ID",
"info": {
"title": "Famous Black Women",
"description": "Please complete this quiz based off of this week's readings for class.",
"documentTitle": "API Example Quiz"
},
"settings": {
"quizSettings": {
"isQuiz": true
}
},
"revisionId": "00000021",
"responderUri": "https://docs.google.com/forms/d/e/1FAIpQLSd0iBLPh4suZoGW938EU1WIxzObQv_jXto0nT2U8HH2KsI5dg/viewform",
"items": [
{
"itemId": "5d9f9786",
"imageItem": {
"image": {
"contentUri": "DIRECT_URL",
"properties": {
"alignment": "LEFT"
}
}
}
},
{
"itemId": "72b30353",
"title": "Which African American woman authored \"I Know Why the Caged Bird Sings\"?",
"questionItem": {
"question": {
"questionId": "25405d4e",
"required": true,
"grading": {
"pointValue": 2,
"correctAnswers": {
"answers": [
{
"value": "Maya Angelou"
}
]
}
},
"choiceQuestion": {
"type": "RADIO",
"options": [
{
"value": "Maya Angelou"
},
{
"value": "bell hooks"
},
{
"value": "Alice Walker"
},
{
"value": "Roxane Gay"
}
]
}
}
}
},
{
"itemId": "0a4859c8",
"title": "Who was the first Dominican-American woman elected to state office?",
"questionItem": {
"question": {
"questionId": "37fff47a",
"grading": {
"pointValue": 2,
"correctAnswers": {
"answers": [
{
"value": "Grace Diaz"
}
]
}
},
"choiceQuestion": {
"type": "RADIO",
"options": [
{
"value": "Rosa Clemente"
},
{
"value": "Grace Diaz"
},
{
"value": "Juana Matias"
},
{
"value": "Sabrina Matos"
}
]
}
}
}
}
]
}
अगले चरण
- Google Workspace API के साथ डेवलप करने के बारे में जानने के लिए, Workspace डेवलपर के तौर पर इस्तेमाल शुरू करना देखें. इसमें, पुष्टि करने और अनुमति देने की प्रक्रिया को हैंडल करने के साथ-साथ अन्य नीतियां भी शामिल हैं.
- Forms API के आसान ऐप्लिकेशन को कॉन्फ़िगर करने और चलाने का तरीका जानने के लिए, Quickstarts की खास जानकारी पढ़ें.