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
}
שדות
formId

string

פלט בלבד. מזהה הטופס.
info

object (Info)

חובה. הכותרת והתיאור של הטופס.
settings

object (FormSettings)

הגדרות הטופס. חובה לעדכן זאת באמצעות UpdateSettingsRequest. המערכת מתעלמת ממנה במהלך forms.create ו-UpdateFormInfoRequest.
items[]

object (Item)

חובה. רשימה של פריטי הטופס, הכוללת כותרות של קטעים, שאלות, מדיה מוטמעת וכו'.
revisionId

string

פלט בלבד. מזהה הגרסה הקודמת של הטופס. משמש בWriteControl בבקשות עדכון כדי לזהות את הגרסה שעליה השינויים מבוססים.

הפורמט של מזהה הגרסה עשוי להשתנות עם הזמן, לכן יש להתייחס אליו בצורה אטומה. מובטח שמזהה גרסה קודמת יהיה תקף רק למשך 24 שעות אחרי שהוא הוחזר, ולא ניתן לשתף אותו עם משתמשים אחרים. אם מזהה הגרסה הקודמת לא משתנה בין קריאות, אז הטופס לא השתנה. לעומת זאת, המשמעות של מזהה ששונה (עבור אותו טופס ואותו משתמש) היא בדרך כלל שהטופס עודכן. עם זאת, מזהה שהשתנה יכול לנבוע גם מגורמים פנימיים כמו שינויים בפורמט המזהה.
responderUri

string

פלט בלבד. ה-URI של הטופס לשיתוף עם משיבים. ייפתח דף שדרכו המשתמש יכול לשלוח תשובות אבל לא לערוך את השאלות.
linkedSheetId

string

פלט בלבד. המזהה של הגיליון האלקטרוני המקושר ב-Google Sheets, שצובר תשובות מהטופס הזה (אם קיים גיליון אלקטרוני כזה).

מידע

המידע הכללי לגבי טופס.

ייצוג JSON 
{
  "title": string,
  "documentTitle": string,
  "description": string
}
שדות
title

string

חובה. הכותרת של הטופס שגלויה למשיבים.
documentTitle

string

פלט בלבד. כותרת המסמך שגלויה ב-Drive. אם השדה Info.title ריק, ייתכן שהשדה documentTitle יופיע במקומו בממשק המשתמש של Google Forms ויהיה גלוי למשיבים. אפשר להגדיר את documentTitle בזמן היצירה, אבל לא ניתן לשנות אותו באמצעות בקשה ב-batchUpdate. כדי לעדכן את documentTitle באופן פרוגרמטי, צריך להשתמש ב-Google Drive API.
description

string

תיאור הטופס.

FormSettings

הגדרות טופס.

ייצוג JSON 
{
  "quizSettings": {
    object (QuizSettings)
  }
}
שדות
quizSettings

object (QuizSettings)

הגדרות שקשורות לטפסים ולמתן ציונים של בחנים.

QuizSettings

הגדרות שקשורות לטפסים ולמתן ציונים של בחנים. צריך לעדכן את ההגדרות האלה באמצעות האפליקציה UpdateSettingsRequest.

ייצוג JSON 
{
  "isQuiz": boolean
}
שדות
isQuiz

boolean

אם הטופס הזה הוא בוחן או לא. אם הערך הוא True, הציון לתשובות נקבע על סמך שאלה Grading. כשההגדרה מוגדרת כ-False, כל השאלות Grading נמחקות.

פריט

פריט אחד בטופס. 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 (TextQuestion)
  },
  "scaleQuestion": {
    object (ScaleQuestion)
  },
  "dateQuestion": {
    object (DateQuestion)
  },
  "timeQuestion": {
    object (TimeQuestion)
  },
  "fileUploadQuestion": {
    object (FileUploadQuestion)
  },
  "rowQuestion": {
    object (RowQuestion)
  }
  // End of list of possible types for union field kind.
}
שדות
questionId

string

קריאה בלבד. מזהה השאלה.

כשיוצרים אותו, אפשר לציין אותו, אבל לא כדאי להשתמש בו כבר בטופס. אם לא תספקו מזהה חדש, יוקצה לו מזהה חדש.
required

boolean

אם יש לענות על השאלה כדי שהמשיב ישלח את התגובה.
grading

object (Grading)

ההגדרה של מתן הציון לשאלה.
שדה איחוד kind. חובה. סוג השאלה שמוצעת למשיב. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
choiceQuestion

object (ChoiceQuestion)

המשיבים יכולים לבחור מתוך קבוצה מוגדרת מראש של אפשרויות.
textQuestion

object (TextQuestion)

המשיבים יכולים להזין תשובה בטקסט חופשי.
scaleQuestion

object (ScaleQuestion)

המשיב יכול לבחור מספר מתוך טווח.
dateQuestion

object (DateQuestion)

המשיבים יכולים להזין תאריך.
timeQuestion

object (TimeQuestion)

המשיבים יכולים להזין שעה.
fileUploadQuestion

object (FileUploadQuestion)

המשיבים יכולים להעלות קובץ אחד או יותר.
rowQuestion

object (RowQuestion)

שורה של QuestionGroupItem.

ChoiceQuestion

שאלת רדיו/תיבת סימון/תפריט נפתח.

ייצוג JSON 
{
  "type": enum (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}
שדות
type

enum (ChoiceType)

חובה. סוג שאלת הבחירה.
options[]

object (Option)

חובה. רשימת אפשרויות שהמשיבים צריכים לבחור מהן.
shuffle

boolean

אם צריך להציג את האפשרויות בסדר אקראי במופעים שונים של הבוחן. לרוב נעשה שימוש בשיטה הזו כדי למנוע רמאות מצד משיבים שעשויים להביט במסך של משיב אחר, או כדי לטפל בהטיה בסקר שנוצר על ידי הצבת האפשרויות האלה תמיד ראשונה או אחרונה.

ChoiceType

סוג הבחירה.

טיפוסים בני מנייה (enums)
CHOICE_TYPE_UNSPECIFIED ערך ברירת המחדל. לא בשימוש.
RADIO לחצני בחירה: כל האפשרויות מוצגות למשתמש, והוא יכול לבחור רק אחת מהן.
CHECKBOX תיבות סימון: כל האפשרויות מוצגות למשתמש, והוא יכול לבחור כל מספר שרוצים.
DROP_DOWN תפריט נפתח: האפשרויות מוצגות למשתמש רק על פי דרישה. אחרת, רק האפשרות הנוכחית מוצגת. ניתן לבחור אפשרות אחת בלבד.

אפשרות

אפשרות לשאלת בחירה.

ייצוג JSON 
{
  "value": string,
  "image": {
    object (Image)
  },
  "isOther": boolean,

  // Union field go_to_section can be only one of the following:
  "goToAction": enum (GoToAction),
  "goToSectionId": string
  // End of list of possible types for union field go_to_section.
}
שדות
value

string

חובה. הבחירה כפי שהיא מוצגת למשתמש.
image

object (Image)

הצגת תמונה כאפשרות.
isOther

boolean

האם האפשרות היא 'אחר'. רלוונטית כרגע רק לסוגי בחירה RADIO וCHECKBOX, אבל אינה מותרת ב-QuestionGroupItem.
שדה איחוד go_to_section. לאיזה קטע לעבור אם האפשרות הזו מסומנת. רלוונטית כרגע רק לסוג הבחירה RADIO ולסוג האפשרות SELECT, אבל לא ניתן להשתמש בה ב-QuestionGroupItem. הערך של go_to_section יכול להיות רק אחת מהאפשרויות הבאות:
goToAction

enum (GoToAction)

סוג הניווט בקטע.
goToSectionId

string

מזהה הפריט של כותרת הקטע שאליו צריך לעבור.

GoToAction

קבועים לניווט בקטעים.

טיפוסים בני מנייה (enums)
GO_TO_ACTION_UNSPECIFIED ערך ברירת המחדל. לא בשימוש.
NEXT_SECTION מעבר לקטע הבא.
RESTART_FORM חזרה לתחילת הטופס.
SUBMIT_FORM שלחו את הטופס מיד.

תמונה

נתונים שמייצגים תמונה.

ייצוג JSON 
{
  "contentUri": string,
  "altText": string,
  "properties": {
    object (MediaProperties)
  },

  // Union field image_source can be only one of the following:
  "sourceUri": string
  // End of list of possible types for union field image_source.
}
שדות
contentUri

string

פלט בלבד. URI שממנו ניתן להוריד את התמונה. אפשרות זו תקפה לזמן מוגבל בלבד.
altText

string

תיאור של התמונה שמוצגת כשמעבירים את העכבר מעליה ונקראת על ידי קוראי מסך.
properties

object (MediaProperties)

תכונות של תמונה.
שדה איחוד image_source. סוג מקור התמונה. כשיוצרים תמונות חדשות, צריך להגדיר שדה מקור אחד בלבד של תמונה. הערך של image_source יכול להיות רק אחת מהאפשרויות הבאות:
sourceUri

string

קלט בלבד. ה-URI המקורי הוא ה-URI המשמש להוספת התמונה. במהלך האחזור, ה-URI המקורי יכול להיות ריק.

MediaProperties

תכונות המדיה.

ייצוג JSON 
{
  "alignment": enum (Alignment),
  "width": integer
}
שדות
alignment

enum (Alignment)

המיקום של אמצעי המדיה.
width

integer

רוחב המדיה בפיקסלים. כאשר המדיה מוצגת, גודלה מוקטן לערך הקטן יותר מערך זה או לרוחב הטופס המוצג. יחס הגובה-רוחב המקורי של המדיה נשמר. אם לא מצוין רוחב בזמן הוספת המדיה לטופס, הוא יוגדר לרוחב של מקור המדיה. על הרוחב להיות בין 0 ל-740, כולל. ניתן להגדיר את הרוחב ל-0 או שלא צוין רק כשמעדכנים את מקור המדיה.

יישור

יישור לדף.

טיפוסים בני מנייה (enums)
ALIGNMENT_UNSPECIFIED ערך ברירת המחדל. לא בשימוש.
LEFT יישור לשמאל.
RIGHT יישור לימין.
CENTER מרכז.

TextQuestion

שאלה מבוססת טקסט.

ייצוג JSON 
{
  "paragraph": boolean
}
שדות
paragraph

boolean

אם השאלה היא שאלה בפסקה או לא. אם לא, השאלה היא שאלת טקסט קצרה.

ScaleQuestion

שאלה בנוגע לקנה המידה. למשתמש יש טווח של ערכים מספריים לבחירה.

ייצוג JSON 
{
  "low": integer,
  "high": integer,
  "lowLabel": string,
  "highLabel": string
}
שדות
low

integer

חובה. הערך הנמוך ביותר האפשרי עבור הסולם.
high

integer

חובה. הערך הגבוה ביותר האפשרי עבור הסולם.
lowLabel

string

התווית להצגה שמתארת את הנקודה הנמוכה ביותר בסולם.
highLabel

string

התווית להצגה שמתארת את הנקודה הגבוהה ביותר בסולם.

DateQuestion

שאלה על תאריכים. כברירת מחדל, שאלות תאריך צריכות להיות חודש + יום בלבד.

ייצוג JSON 
{
  "includeTime": boolean,
  "includeYear": boolean
}
שדות
includeTime

boolean

האם לכלול את הזמן כחלק מהשאלה.
includeYear

boolean

האם לכלול את השנה כחלק מהשאלה.

TimeQuestion

שאלה בנושא זמן.

ייצוג JSON 
{
  "duration": boolean
}
שדות
duration

boolean

true אם השאלה נוגעת לזמן שחלף. אחרת, מדובר בשעה מסוימת ביום.

FileUploadQuestion

שאלה לגבי העלאת קובץ. ה-API לא תומך כרגע ביצירת שאלות להעלאת קבצים.

ייצוג JSON 
{
  "folderId": string,
  "types": [
    enum (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}
שדות
folderId

string

חובה. המזהה של תיקיית Drive שבה מאוחסנים הקבצים שהועלו.
types[]

enum (FileType)

סוגי הקבצים המקובלים בשאלה זו.
maxFiles

integer

מספר הקבצים המקסימלי שאפשר להעלות לשאלה הזו בתשובה אחת.
maxFileSize

string (int64 format)

מספר הבייטים המקסימלי המותר לכל קובץ יחיד שיועלה לשאלה הזו.

FileType

סוגי קבצים שניתן להעלות למענה על שאלה בנושא העלאת קבצים.

טיפוסים בני מנייה (enums)
FILE_TYPE_UNSPECIFIED ערך ברירת המחדל. לא בשימוש.
ANY אין הגבלות על הסוג.
DOCUMENT מסמך ב-Google Docs.
PRESENTATION מצגת של Google Slides.
SPREADSHEET גיליון אלקטרוני ב-Google Sheets.
DRAWING שרטוט.
PDF קובץ PDF.
IMAGE תמונה.
VIDEO סרטון.
AUDIO קובץ אודיו.

RowQuestion

הגדרה של שאלה שכלולה בקבוצת שאלות.

ייצוג JSON 
{
  "title": string
}
שדות
title

string

חובה. הכותרת של השורה היחידה ב-QuestionGroupItem.

מתן ציון

מתן ציון לשאלה אחת

ייצוג JSON 
{
  "pointValue": integer,
  "correctAnswers": {
    object (CorrectAnswers)
  },
  "whenRight": {
    object (Feedback)
  },
  "whenWrong": {
    object (Feedback)
  },
  "generalFeedback": {
    object (Feedback)
  }
}
שדות
pointValue

integer

חובה. מספר הנקודות המקסימלי שמשיב יכול לקבל באופן אוטומטי על תשובה נכונה. הערך לא יכול להיות שלילי.
correctAnswers

object (CorrectAnswers)

חובה. מפתח התשובות לשאלה. התשובות מקבלות ציון באופן אוטומטי על סמך השדה הזה.
whenRight

object (Feedback)

המשוב שמוצג לגבי תשובות נכונות. אפשר להגדיר את המשוב הזה רק לשאלות אמריקאיות שיש להן תשובות נכונות.
whenWrong

object (Feedback)

המשוב שמוצג על תשובות שגויות. אפשר להגדיר את המשוב הזה רק לשאלות אמריקאיות שיש להן תשובות נכונות.
generalFeedback

object (Feedback)

המשוב שמוצג לכל התשובות. לרוב, משתמשים כאלה עונים על שאלות עם תשובות קצרות כשבעלי הבוחן רוצה לתת למשיבים לדעת אם ענו נכון על השאלה, לפני שיש להם הזדמנות לתת ציון רשמי לתשובה. אי אפשר להגדיר משוב כללי לשאלות אמריקאיות עם ציון אוטומטי.

CorrectAnswers

מפתח התשובות של שאלה.

ייצוג JSON 
{
  "answers": [
    {
      object (CorrectAnswer)
    }
  ]
}
שדות
answers[]

object (CorrectAnswer)

רשימה של תשובות נכונות. ניתן לתת ציון אוטומטי לתשובה על בוחן על סמך התשובות האלה. בשאלות עם ערך יחיד, תשובה מסומנת כנכונה אם היא תואמת לערך כלשהו ברשימה הזו (במילים אחרות, יכול להיות שיהיו כמה תשובות נכונות). בשאלות שיש להן כמה ערכים (CHECKBOX), התשובה תסומן כנכונה אם היא מכילה בדיוק את הערכים שברשימה הזו.

CorrectAnswer

תשובה נכונה אחת לכל שאלה. אם יש לך שאלות שיש להן כמה ערכים (CHECKBOX), יכול להיות שיהיה צורך בכמה סוגים של CorrectAnswer כדי שייצגו אפשרות תשובה נכונה אחת.

ייצוג JSON 
{
  "value": string
}
שדות
value

string

חובה. ערך התשובה הנכון. במסמכי התיעוד של TextAnswer.value מפורט מידע על הפורמט של סוגי הערכים השונים.

QuestionGroupItem

מגדיר שאלה שמורכבת ממספר שאלות שמקובצות יחד.

ייצוג JSON 
{
  "questions": [
    {
      object (Question)
    }
  ],
  "image": {
    object (Image)
  },

  // Union field kind can be only one of the following:
  "grid": {
    object (Grid)
  }
  // End of list of possible types for union field kind.
}
שדות
questions[]

object (Question)

חובה. רשימת שאלות ששייכות לקבוצת השאלות הזו. שאלה חייבת להשתייך רק לקבוצה אחת. kind של הקבוצה עשוי להשפיע על סוגי השאלות המותרים.
image

object (Image)

התמונה שמוצגת בקבוצת השאלות מעל השאלות הספציפיות.
שדה איחוד kind. חובה. הסוג של קבוצת השאלות, שקובע אילו סוגי שאלות מותר לפרסם ואיך הן מוצגות. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
grid

object (Grid)

קבוצת השאלות מורכבת מרשת עם שורות של שאלות אמריקאיות, שכל אחת מהן מכילה את אותן האפשרויות. אם המדיניות grid מוגדרת, כל השאלות בקבוצה צריכות להיות מסוג row.

תצוגת רשת

רשת של אפשרויות בחירה (רדיו או תיבות סימון) כשכל שורה משמשת כשאלה נפרדת. בכל שורה יש אותן אפשרויות, שמוצגות כעמודות.

ייצוג JSON 
{
  "columns": {
    object (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}
שדות
columns

object (ChoiceQuestion)

חובה. הבחירות ששיתפו כל שאלה ברשת. במילים אחרות, הערכים בעמודות. מותר להשתמש רק באפשרויות CHECK_BOX ו-RADIO.
shuffleQuestions

boolean

אם הערך הוא true, השאלות מסודרות באופן אקראי. במילים אחרות, השורות מופיעות בסדר שונה אצל כל משיב.

PageBreakItem

מעבר דף. הכותרת והתיאור של הפריט מוצגים בראש הדף החדש.

TextItem

פריט טקסט.

ImageItem

פריט שמכיל תמונה.

ייצוג JSON 
{
  "image": {
    object (Image)
  }
}
שדות
image

object (Image)

חובה. התמונה המוצגת בפריט.

VideoItem

פריט שמכיל סרטון.

ייצוג JSON 
{
  "video": {
    object (Video)
  },
  "caption": string
}
שדות
video

object (Video)

חובה. הסרטון שמוצג בפריט.
caption

string

הטקסט המוצג מתחת לסרטון.

וידאו

נתונים שמייצגים סרטון.

ייצוג JSON 
{
  "youtubeUri": string,
  "properties": {
    object (MediaProperties)
  }
}
שדות
youtubeUri

string

חובה. URI של YouTube.
properties

object (MediaProperties)

תכונות של סרטון.

שיטות

batchUpdate

 שינוי הטופס באמצעות חבילת עדכונים.

create

 יוצרים טופס חדש עם הכותרת שמופיעה בהודעת הטופס שצוינה בבקשה.

get

 קבלת טופס.