نمای کلی

API فرم‌های گوگل (Google Forms API) یک رابط RESTful است که به شما امکان می‌دهد فرم‌ها و آزمون‌ها را ایجاد و اصلاح کنید، پاسخ‌های فرم و نمرات آزمون را بازیابی کنید، کلیدهای پاسخ آزمون را با بازخورد خودکار تنظیم کنید و اعلان‌های فوری دریافت کنید. رایج‌ترین کاربردهای این API شامل موارد زیر است:

  • ایجاد فرم یا آزمون
  • انتشار و مدیریت پاسخ‌دهندگان
  • به‌روزرسانی فرم یا آزمون
  • بازیابی پاسخ‌ها از یک فرم یا آزمون
  • خواندن محتوای فرم و فراداده‌ها
  • اعلان‌های فوری را تنظیم و دریافت کنید
در زیر لیستی از اصطلاحات رایج مورد استفاده در Forms API آمده است:
فرم

یک سند Google Forms، ایجاد شده و ذخیره شده در Drive. هر فرم توسط یک منبع Form نمایش داده می‌شود و یک مقدار formId منحصر به فرد دارد که شامل حروف، اعداد، خط فاصله یا زیرخط است. می‌توانید شناسه فرم را در URL فرم‌های Google پیدا کنید:

https://docs.google.com/forms/d/FORM_ID/edit

آزمون

نوع خاصی از سند گوگل فرم که امکان نمره‌دهی به پاسخ‌های فرم را در برابر یک کلید پاسخ فراهم می‌کند. یک آزمون فقط با استفاده از متد batchUpdate() برای به‌روزرسانی تنظیمات isQuiz در یک فرم موجود به true قابل ایجاد است.

درجه بندی
یک مقدار امتیاز، کلید پاسخ و بازخورد برای یک سوال، که وقتی isQuiz true باشد اعمال می‌شود. توسط منبع Grading نمایش داده می‌شود.
بازخورد
پاسخی که هنگام پاسخ دادن به یک سوال در یک آزمون به کاربر نهایی داده می‌شود و توسط منبع Feedback نمایش داده می‌شود.
مورد

یک عنصر واحد در یک فرم، که توسط منبع Item نمایش داده می‌شود. Item یک عنصر تکرارشونده است که می‌تواند شامل یک بخش، گروه سوال، سوال، متن، تصویر یا ویدیو باشد.

سوال

یک سوال واحد در فرم، که با منبع Question نمایش داده می‌شود.

گروه سوالات

گروهی از سوالات که همگی مجموعه پاسخ‌های ممکن یکسانی دارند (برای مثال، شبکه‌ای از رتبه‌بندی‌ها از ۱ تا ۵). توسط منبع QuestionGroupItem نمایش داده می‌شود.

بخش

یک بخش (Section) راهی برای تقسیم یک فرم به چندین صفحه و اضافه کردن منطق شرطی است (مانند نمایش سوالات خاص فقط بر اساس نحوه پاسخ کاربر). بخش‌ها (Sections) با منبع PageBreakItem مطابقت دارند.

پاسخ

پاسخ کاربر نهایی به یک سوال، که توسط منبع Answer نمایش داده می‌شود. شامل اطلاعات نمره (در صورت وجود)، فراداده و محتوای پاسخ است.

پاسخ

ارسال فرم توسط کاربر نهایی، که توسط منبع FormResponse نمایش داده می‌شود.

تماشا کنید

تریگری که تغییرات مربوط به تغییرات طرحواره فرم (مانند ویرایش سوالات) یا ارسال پاسخ فرم را ردیابی می‌کند و هنگام وقوع تغییر، یک اعلان ارسال می‌کند. توسط منبع Watch نمایش داده می‌شود.

ساختار فرم

هنگام مدیریت فرم‌ها و آزمون‌ها، درک نحوه مشخص کردن فیلدهای مختلف می‌تواند پیچیده باشد، زیرا بسیاری از اشیاء فرم می‌توانند به روش‌های مختلف درون یکدیگر قرار گیرند. برای دیدن اینکه چگونه نمایش بصری یک فرم به فیلدها نگاشت می‌شود، توصیه می‌کنیم از رابط کاربری برای ایجاد چند نمونه از فرم‌هایی که برنامه شما ممکن است تولید کند، استفاده کنید. سپس JSON مربوطه را با استفاده از متد forms.get() بازیابی کنید تا بتوانید مقایسه کنید. به عنوان مثال، این آزمون نمونه با 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"
              }
            ]
          }
        }
      }
    }
  ],
  "publishSettings" : {
    "isPublished": true,
    "isAcceptingResponses": true
  }
}

مراحل بعدی