REST Resource: forms

संसाधन: फ़ॉर्म

Google Forms का कोई दस्तावेज़. फ़ॉर्म, Drive में बनाया जाता है. साथ ही, Drive API की मदद से, फ़ॉर्म को मिटाया जाता है या उसके ऐक्सेस की सुरक्षा सेटिंग में बदलाव किया जाता है.

JSON के काेड में दिखाना
{
  "formId": string,
  "info": {
    object (Info)
  },
  "settings": {
    object (FormSettings)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "revisionId": string,
  "responderUri": string,
  "linkedSheetId": string,
  "publishSettings": {
    object (PublishSettings)
  }
}
फ़ील्ड
formId

string

सिर्फ़ आउटपुट के लिए. फ़ॉर्म का आईडी.

info

object (Info)

ज़रूरी है. फ़ॉर्म का टाइटल और ब्यौरा.

settings

object (FormSettings)

फ़ॉर्म की सेटिंग. इसे UpdateSettingsRequest से अपडेट करना ज़रूरी है. forms.create और UpdateFormInfoRequest के दौरान इसे अनदेखा किया जाता है.

items[]

object (Item)

ज़रूरी है. फ़ॉर्म के आइटम की सूची. इसमें सेक्शन हेडर, सवाल, एम्बेड किया गया मीडिया वगैरह शामिल हो सकते हैं.

revisionId

string

सिर्फ़ आउटपुट के लिए. फ़ॉर्म में किए गए बदलाव का आईडी. अपडेट के अनुरोधों में WriteControl में इस्तेमाल किया जाता है, ताकि उस बदलाव की पहचान की जा सके जिस पर बदलाव आधारित हैं.

समय के साथ, बदलाव के आईडी का फ़ॉर्मैट बदल सकता है. इसलिए, इसे सार्वजनिक नहीं किया जाना चाहिए. रिव्यू आईडी वापस मिलने के बाद, यह सिर्फ़ 24 घंटे के लिए मान्य होता है. साथ ही, इसे सभी उपयोगकर्ताओं के साथ शेयर नहीं किया जा सकता. अगर कॉल के बीच बदलाव आईडी में कोई बदलाव नहीं होता है, तो इसका मतलब है कि फ़ॉर्म का कॉन्टेंट नहीं बदला है. इसके उलट, एक ही फ़ॉर्म और उपयोगकर्ता के लिए आईडी बदलने का मतलब है कि फ़ॉर्म का कॉन्टेंट अपडेट किया गया है. हालांकि, आईडी फ़ॉर्मैट में बदलाव जैसे अंदरूनी फ़ैक्टर की वजह से भी आईडी बदल सकता है.

फ़ॉर्म के कॉन्टेंट में, फ़ॉर्म का मेटाडेटा शामिल नहीं होता. जैसे:

  • शेयर करने की सेटिंग (फ़ॉर्म का ऐक्सेस किसके पास है)
  • publishSettings (अगर फ़ॉर्म को पब्लिश किया जा सकता है और उसे पब्लिश किया गया है)
responderUri

string

सिर्फ़ आउटपुट के लिए. जवाब देने वालों के साथ शेयर करने के लिए, फ़ॉर्म का यूआरआई. इससे एक पेज खुलता है, जहां उपयोगकर्ता जवाब सबमिट कर सकता है, लेकिन सवालों में बदलाव नहीं कर सकता. जिन फ़ॉर्म के लिए publishSettings वैल्यू सेट की गई है उनके लिए, यह पब्लिश किया गया फ़ॉर्म यूआरआई है.

linkedSheetId

string

सिर्फ़ आउटपुट के लिए. लिंक की गई उस Google शीट का आईडी जिसमें इस फ़ॉर्म के जवाब इकट्ठा किए जा रहे हैं (अगर ऐसी कोई शीट मौजूद है).

publishSettings

object (PublishSettings)

सिर्फ़ आउटपुट के लिए. किसी फ़ॉर्म के लिए पब्लिश करने की सेटिंग. यह फ़ील्ड, लेगसी फ़ॉर्म के लिए सेट नहीं होता, क्योंकि इनमें publishSettings फ़ील्ड नहीं होता. नए बनाए गए सभी फ़ॉर्म, पब्लिश करने की सेटिंग के साथ काम करते हैं.

publishSettings वैल्यू सेट वाले फ़ॉर्म, फ़ॉर्म को पब्लिश या अनपब्लिश करने के लिए forms.setPublishSettings एपीआई को कॉल कर सकते हैं.

जानकारी

किसी फ़ॉर्म के बारे में सामान्य जानकारी.

JSON के काेड में दिखाना
{
  "title": string,
  "documentTitle": string,
  "description": string
}
फ़ील्ड
title

string

ज़रूरी है. फ़ॉर्म का टाइटल, जो जवाब देने वाले लोगों को दिखता है.

documentTitle

string

सिर्फ़ आउटपुट के लिए. दस्तावेज़ का वह टाइटल जो Drive में दिखता है. अगर Info.title खाली है, तो Google Forms के यूज़र इंटरफ़ेस (यूआई) में उसकी जगह पर documentTitle दिख सकता है. साथ ही, यह जवाब देने वाले लोगों को भी दिख सकता है. documentTitle को बनाने के दौरान सेट किया जा सकता है, लेकिन एक साथ कई बदलाव करने के अनुरोध से इसमें बदलाव नहीं किया जा सकता. अगर आपको प्रोग्राम के हिसाब से documentTitle को अपडेट करना है, तो कृपया Google Drive API का इस्तेमाल करें.

description

string

फ़ॉर्म के बारे में जानकारी.

FormSettings

फ़ॉर्म की सेटिंग.

JSON के काेड में दिखाना
{
  "quizSettings": {
    object (QuizSettings)
  },
  "emailCollectionType": enum (EmailCollectionType)
}
फ़ील्ड
quizSettings

object (QuizSettings)

क्विज़ फ़ॉर्म और ग्रेड से जुड़ी सेटिंग.

emailCollectionType

enum (EmailCollectionType)

ज़रूरी नहीं. यह सेटिंग तय करती है कि फ़ॉर्म में जवाब देने वालों के ईमेल पते इकट्ठा किए जाएंगे या नहीं.

QuizSettings

क्विज़ फ़ॉर्म और ग्रेड से जुड़ी सेटिंग. इन्हें UpdateSettingsRequest की मदद से अपडेट करना होगा.

JSON के काेड में दिखाना
{
  "isQuiz": boolean
}
फ़ील्ड
isQuiz

boolean

यह फ़ॉर्म क्विज़ है या नहीं. अगर यह सही है, तो जवाबों को Grading सवाल के आधार पर ग्रेड दिया जाता है. 'गलत है' पर सेट करने पर, Grading वाला पूरा सवाल मिट जाता है.

EmailCollectionType

ज़रूरी नहीं. यह सेटिंग यह तय करती है कि फ़ॉर्म में जवाब देने वाले लोगों के ईमेल पते इकट्ठा किए जाएंगे या नहीं. साथ ही, यह भी तय करती है कि ईमेल पते कैसे इकट्ठा किए जाएंगे. अगर फ़ॉर्म में ईमेल पते इकट्ठा किए जाते हैं, तो वैल्यू formResponse.respondentEmail फ़ील्ड में अपने-आप भर जाती हैं.

Enums
EMAIL_COLLECTION_TYPE_UNSPECIFIED नहीं बताया गया है इस वैल्यू का इस्तेमाल नहीं किया जाता.
DO_NOT_COLLECT फ़ॉर्म में ईमेल पते इकट्ठा नहीं किए जाते. अगर फ़ॉर्म का मालिक Google खाते का इस्तेमाल करता है, तो डिफ़ॉल्ट वैल्यू.
VERIFIED यह फ़ॉर्म, साइन इन किए हुए उपयोगकर्ता के खाते के आधार पर, ईमेल पते अपने-आप इकट्ठा करता है. अगर फ़ॉर्म का मालिक Google Workspace खाते का इस्तेमाल करता है, तो डिफ़ॉल्ट वैल्यू.
RESPONDER_INPUT फ़ॉर्म में एक फ़ील्ड होता है, जिसका इस्तेमाल करके फ़ॉर्म भरने वाला व्यक्ति ईमेल पते इकट्ठा करता है.

आइटम

फ़ॉर्म का एक आइटम. kind से पता चलता है कि यह किस तरह का आइटम है.

JSON के काेड में दिखाना
{
  "itemId": string,
  "title": string,
  "description": string,

  // Union field kind can be only one of the following:
  "questionItem": {
    object (QuestionItem)
  },
  "questionGroupItem": {
    object (QuestionGroupItem)
  },
  "pageBreakItem": {
    object (PageBreakItem)
  },
  "textItem": {
    object (TextItem)
  },
  "imageItem": {
    object (ImageItem)
  },
  "videoItem": {
    object (VideoItem)
  }
  // End of list of possible types for union field kind.
}
फ़ील्ड
itemId

string

आइटम आईडी.

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

title

string

आइटम का टाइटल.

description

string

आइटम की जानकारी.

यूनियन फ़ील्ड kind. ज़रूरी है. यह किस तरह का आइटम है. kind इनमें से कोई एक हो सकता है:
questionItem

object (QuestionItem)

उपयोगकर्ता से सवाल पूछता है.

questionGroupItem

object (QuestionGroupItem)

इसमें उपयोगकर्ता से एक या उससे ज़्यादा सवाल पूछे जाते हैं.

pageBreakItem

object (PageBreakItem)

टाइटल के साथ एक नया पेज शुरू करता है.

textItem

object (TextItem)

पेज पर टाइटल और ब्यौरा दिखाता है.

imageItem

object (ImageItem)

पेज पर इमेज दिखाता है.

videoItem

object (VideoItem)

पेज पर वीडियो दिखाता है.

QuestionItem

फ़ॉर्म का ऐसा आइटम जिसमें एक सवाल होता है.

JSON के काेड में दिखाना
{
  "question": {
    object (Question)
  },
  "image": {
    object (Image)
  }
}
फ़ील्ड
question

object (Question)

ज़रूरी है. दिखाया गया सवाल.

image

object (Image)

सवाल में दिखाई गई इमेज.

सवाल

कोई भी सवाल. किसी खास तरह के सवाल को उसके kind से जाना जाता है.

JSON के काेड में दिखाना
{
  "questionId": string,
  "required": boolean,
  "grading": {
    object (Grading)
  },

  // Union field kind can be only one of the following:
  "choiceQuestion": {
    object (ChoiceQuestion)
  },
  "textQuestion": {
    object (