- משאב: טופס
- מידע
- FormSettings
- QuizSettings
- EmailCollectionType
- פריט
- QuestionItem
- שאלה
- ChoiceQuestion
- ChoiceType
- אפשרות
- GoToAction
- תמונה
- MediaProperties
- יישור
- TextQuestion
- ScaleQuestion
- DateQuestion
- TimeQuestion
- FileUploadQuestion
- FileType
- RowQuestion
- RatingQuestion
- RatingIconType
- מתן ציונים
- CorrectAnswers
- CorrectAnswer
- QuestionGroupItem
- Grid
- PageBreakItem
- TextItem
- ImageItem
- VideoItem
- וידאו
- PublishSettings
- PublishState
- שיטות
משאב: טופס
מסמך ב-Google Forms. הטופס נוצר ב-Drive, ומחיקה של טופס או שינוי של אמצעי הגנה על הגישה שלו מתבצעים דרך Drive API.
ייצוג ב-JSON |
---|
{ "formId": string, "info": { object ( |
שדות | |
---|---|
formId |
פלט בלבד. מזהה הטופס. |
info |
חובה. הכותרת והתיאור של הטופס. |
settings |
הגדרות הטופס. צריך לעדכן את השדה הזה באמצעות |
items[] |
חובה. רשימה של הפריטים בטופס, שיכולים לכלול כותרות של קטעים, שאלות, מדיה מוטמעת וכו'. |
revisionId |
פלט בלבד. מזהה הגרסה הקודמת של הטופס. השדה הזה מופיע ב- הפורמט של מזהה הגרסה עשוי להשתנות עם הזמן, לכן צריך להתייחס אליו כאל ערך אטום. מזהה הגרסה המוחזרת תקף רק למשך 24 שעות לאחר ההחזרה, ואי אפשר לשתף אותו בין משתמשים. אם מזהה הגרסה לא השתנה בין הקריאות, סימן שהתוכן של הטופס לא השתנה. לעומת זאת, אם המזהה השתנה (באותו טופס ובאותו משתמש), בדרך כלל המשמעות היא שהתוכן של הטופס עודכן. עם זאת, שינוי במזהה יכול לנבוע גם מגורמים פנימיים, כמו שינויים בפורמט המזהה. תוכן הטופס לא כולל את המטא-נתונים של הטופס, כולל:
|
responderUri |
פלט בלבד. ה-URI של הטופס שרוצים לשתף עם המשיבים. ייפתח דף שבו המשתמש יוכל לשלוח תשובות, אבל לא לערוך את השאלות. בטופס שבו מוגדר הערך |
linkedSheetId |
פלט בלבד. המזהה של הגיליון האלקטרוני המקושר ב-Google Sheets שמצטברות בו תשובות מהטופס הזה (אם קיים גיליון כזה). |
publishSettings |
פלט בלבד. הגדרות הפרסום של טופס. השדה הזה לא מוגדר בטפסים מדור קודם כי אין בהם את השדה טפסים שהוגדר להם הערך |
מידע
המידע הכללי של טופס.
ייצוג ב-JSON |
---|
{ "title": string, "documentTitle": string, "description": string } |
שדות | |
---|---|
title |
חובה. כותרת הטופס שגלויה למשיבים. |
documentTitle |
פלט בלבד. כותרת המסמך שמוצגת ב-Drive. אם השדה |
description |
התיאור של הטופס. |
FormSettings
ההגדרות של טופס.
ייצוג ב-JSON |
---|
{ "quizSettings": { object ( |
שדות | |
---|---|
quizSettings |
הגדרות שקשורות לבחינות ולציונים. |
emailCollectionType |
אופציונלי. ההגדרה שקובעת אם הטופס יאסוף כתובות אימייל מהמשיבים. |
QuizSettings
הגדרות שקשורות לבחינות ולציונים. צריך לעדכן אותם באמצעות UpdateSettingsRequest.
ייצוג ב-JSON |
---|
{ "isQuiz": boolean } |
שדות | |
---|---|
isQuiz |
אם הטופס הוא בוחן או לא. כשהערך הוא true, התשובות ייבדקו על סמך השאלה |
EmailCollectionType
אופציונלי. ההגדרה קובעת אם הטופס אוסף כתובות אימייל מהמשיבים ואיך כתובות האימייל נאספות. אם הטופס אוסף כתובות אימייל, הערכים מאוכלסים בשדה formResponse.respondentEmail
.
טיפוסים בני מנייה (enum) | |
---|---|
EMAIL_COLLECTION_TYPE_UNSPECIFIED |
לא צוין. הערך הזה לא בשימוש. |
DO_NOT_COLLECT |
הטופס לא אוסף כתובות אימייל. ערך ברירת המחדל אם בעל הטופס משתמש בחשבון Google. |
VERIFIED |
הטופס אוסף כתובות אימייל באופן אוטומטי על סמך החשבון של המשתמש שמחובר. ערך ברירת המחדל אם הבעלים של הטופס משתמש בחשבון Google Workspace. |
RESPONDER_INPUT |
הטופס אוסף כתובות אימייל באמצעות שדה שהמשיב ממלא בטופס. |
פריט
פריט אחד בטופס. השדה kind
מגדיר את סוג הפריט.
ייצוג ב-JSON |
---|
{ "itemId": string, "title": string, "description": string, // Union field |
שדות | |
---|---|
itemId |
מזהה הפריט. אפשר לספק אותו בזמן היצירה, אבל אסור שהמזהה כבר ישמש בטופס. אם לא מציינים מזהה, המערכת מקצה מזהה חדש. |
title |
שם הפריט. |
description |
התיאור של הפריט. |
שדה האיחוד kind . חובה. סוג הפריט. הערך של kind יכול להיות רק אחד מהערכים הבאים: |
|
questionItem |
הצגת שאלה למשתמש. |
questionGroupItem |
הצגת שאלה אחת או יותר למשתמש באמצעות הנחיה ראשית אחת. |
pageBreakItem |
התחלת דף חדש עם כותרת. |
textItem |
הצגת כותרת ותיאור בדף. |
imageItem |
הצגת תמונה בדף. |
videoItem |
הצגת סרטון בדף. |
QuestionItem
פריט בטופס שמכיל שאלה אחת.
ייצוג ב-JSON |
---|
{ "question": { object ( |
שדות | |
---|---|
question |
חובה. השאלה המוצגת. |
image |
התמונה שמוצגת בשאלה. |
שאלה
יש לך שאלות? סוג השאלה הספציפי נקרא לפי kind
שלו.
ייצוג ב-JSON |
---|
{ "questionId": string, "required": boolean, "grading": { object ( |
שדות | |
---|---|
questionId |
קריאה בלבד. מזהה השאלה. אפשר לספק אותו בזמן היצירה, אבל אסור שהמזהה כבר יהיה בשימוש בטופס. אם לא מציינים מזהה, המערכת מקצה מזהה חדש. |
required |
האם יש צורך לענות על השאלה כדי שהנשאל יוכל לשלוח את התשובה שלו. |
grading |
הגדרת מתן ציונים לשאלה. |
שדה האיחוד kind . חובה. סוג השאלה שמוצגת למשתמש. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
choiceQuestion |
המשיבים יכולים לבחור מתוך קבוצה מוגדרת מראש של אפשרויות. |
textQuestion |
המשיבים יכולים להזין תשובה בטקסט חופשי. |
scaleQuestion |
המשיבים יכולים לבחור מספר מתוך טווח. |
dateQuestion |
המשיבים יכולים להזין תאריך. |
timeQuestion |
המשיבים יכולים להזין שעה. |
fileUploadQuestion |
המשיבים יכולים להעלות קובץ אחד או יותר. |
rowQuestion |
שורה ב- |
ratingQuestion |
המשיבים יכולים לבחור דירוג מתוך קבוצה מוגדרת מראש של סמלים. |
ChoiceQuestion
שאלה עם לחצן בחירה/תיבת סימון/תפריט נפתח.
ייצוג ב-JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
חובה. סוג שאלה הבחירה. |
options[] |
חובה. רשימת אפשרויות שהנשאלים צריכים לבחור מתוכה. |
shuffle |
האם האפשרויות יוצגו בסדר אקראי במופעים שונים של הבחינה. האפשרות הזו משמשת בדרך כלל למניעת הונאה על ידי נשאלים שיכולים להסתכל במסך של נשאל אחר, או כדי לטפל בבעיות של הטיה בסקר שעשויות להיגרם כתוצאה מהצגה קבועה של אותן אפשרויות בהתחלה או בסוף. |
ChoiceType
סוג הבחירה.
טיפוסים בני מנייה (enum) | |
---|---|
CHOICE_TYPE_UNSPECIFIED |
ערך ברירת המחדל. לא בשימוש. |
RADIO |
לחצני בחירה: כל האפשרויות מוצגות למשתמש, והוא יכול לבחור רק אחת מהן. |
CHECKBOX |
תיבות סימון: כל האפשרויות מוצגות למשתמש, והוא יכול לבחור כמה מהן שירצה. |
DROP_DOWN |
תפריט נפתח: האפשרויות מוצגות למשתמש רק על פי דרישה, אחרת מוצגת רק האפשרות הנוכחית. אפשר לבחור רק אפשרות אחת. |
אפשרות
אפשרות לשאלה מסוג 'בחירה'.
ייצוג ב-JSON |
---|
{ "value": string, "image": { object ( |
שדות | |
---|---|
value |
חובה. הבחירה כפי שהוצגה למשתמש. |
image |
הצגת התמונה כאפשרות. |
isOther |
אם האפשרות היא 'אחר'. בשלב הזה, האפשרות הזו רלוונטית רק לסוגי הבחירה |
שדה האיחוד go_to_section . הקטע שאליו עוברים אם בוחרים באפשרות הזו. בשלב זה, האפשרות הזו רלוונטית רק לסוג הבחירה RADIO ו-SELECT , אבל היא לא מותרת ב-QuestionGroupItem . הערך של go_to_section יכול להיות רק אחת מהאפשרויות הבאות: |
|
goToAction |
סוג הניווט בקטע. |
goToSectionId |
מזהה הפריט של הכותרת העליונה של הקטע שאליו רוצים לעבור. |
GoToAction
קבועים לניווט בין קטעים.
טיפוסים בני מנייה (enum) | |
---|---|
GO_TO_ACTION_UNSPECIFIED |
ערך ברירת המחדל. לא בשימוש. |
NEXT_SECTION |
עוברים לקטע הבא. |
RESTART_FORM |
חוזרים לתחילת הטופס. |
SUBMIT_FORM |
יש לשלוח את הטופס באופן מיידי. |
תמונה
נתונים שמייצגים תמונה.
ייצוג ב-JSON |
---|
{ "contentUri": string, "altText": string, "properties": { object ( |
שדות | |
---|---|
contentUri |
פלט בלבד. URI שממנו אפשר להוריד את התמונה. הוא תקף לזמן מוגבל בלבד. |
altText |
תיאור של התמונה שמוצגת כשמעבירים מעליה את העכבר, וקוראים אותה קוראי מסך. |
properties |
המאפיינים של תמונה. |
שדה האיחוד image_source . סוג מקור התמונה. צריך להגדיר שדה אחד בלבד של מקור תמונה כשיוצרים תמונות חדשות. הערך של image_source יכול להיות רק אחת מהאפשרויות הבאות: |
|
sourceUri |
קלט בלבד. ה-URI של המקור הוא ה-URI שמשמש להוספת התמונה. ה-URI של המקור יכול להיות ריק בזמן האחזור. |
MediaProperties
המאפיינים של המדיה.
ייצוג ב-JSON |
---|
{
"alignment": enum ( |
שדות | |
---|---|
alignment |
המיקום של המדיה. |
width |
רוחב המדיה בפיקסלים. כשהמדיה מוצגת, היא מותאמת לערך הקטן מבין הערך הזה או מרוחב הטופס המוצג. יחס הגובה-רוחב המקורי של המדיה נשמר. אם לא מציינים רוחב כשמוסיפים את המדיה לטופס, הוא מוגדר לרוחב של מקור המדיה. הרוחב חייב להיות בין 0 ל-740, כולל. מותר להגדיר את הרוחב לערך 0 או ללא ציון ערך רק כשמעדכנים את מקור המדיה. |
יישור
יישור קו בדף.
טיפוסים בני מנייה (enum) | |
---|---|
ALIGNMENT_UNSPECIFIED |
ערך ברירת המחדל. לא בשימוש. |
LEFT |
יישור לשמאל. |
RIGHT |
יישור לימין. |
CENTER |
מרכז. |
TextQuestion
שאלה שמבוססת על טקסט.
ייצוג ב-JSON |
---|
{ "paragraph": boolean } |
שדות | |
---|---|
paragraph |
האם השאלה היא שאלה של פסקה או לא. אם לא, זו שאלה עם טקסט קצר. |
ScaleQuestion
שאלה עם סולם דירוג. המשתמש יכול לבחור מתוך טווח של ערכים מספריים.
ייצוג ב-JSON |
---|
{ "low": integer, "high": integer, "lowLabel": string, "highLabel": string } |
שדות | |
---|---|
low |
חובה. הערך הנמוך ביותר האפשרי בסולם. |
high |
חובה. הערך הגבוה ביותר האפשרי בסולם. |
lowLabel |
התווית שמוצגת ומתאר את הנקודה הנמוכה ביותר בסולם. |
highLabel |
התווית שמוצגת ומתאר את הנקודה הגבוהה ביותר בסולם. |
DateQuestion
שאלה לגבי תאריך. כברירת מחדל, שאלות לגבי תאריכים כוללות רק את החודש והיום.
ייצוג ב-JSON |
---|
{ "includeTime": boolean, "includeYear": boolean } |
שדות | |
---|---|
includeTime |
אם לכלול את השעה כחלק מהשאלה. |
includeYear |
האם לכלול את השנה כחלק מהשאלה. |
TimeQuestion
שאלה לגבי זמן.
ייצוג ב-JSON |
---|
{ "duration": boolean } |
שדות | |
---|---|
duration |
|
FileUploadQuestion
שאלה עם העלאת קובץ. בשלב הזה, ה-API לא תומך ביצירת שאלות לגבי העלאת קבצים.
ייצוג ב-JSON |
---|
{
"folderId": string,
"types": [
enum ( |
שדות | |
---|---|
folderId |
חובה. המזהה של התיקייה ב-Drive שבה מאוחסנים הקבצים שמעלים. |
types[] |
סוגי הקבצים שמותר לצרף לשאלה הזו. |
maxFiles |
המספר המקסימלי של קבצים שאפשר להעלות לשאלה הזו בתשובה אחת. |
maxFileSize |
מספר הבייטים המקסימלי שמותר לכל קובץ בודד שמעלים לשאלה הזו. |
FileType
סוגי הקבצים שאפשר להעלות לשאלה עם העלאת קבצים.
טיפוסים בני מנייה (enum) | |
---|---|
FILE_TYPE_UNSPECIFIED |
ערך ברירת המחדל. לא בשימוש. |
ANY |
אין הגבלות על סוגים. |
DOCUMENT |
מסמך ב-Google Docs. |
PRESENTATION |
מצגת ב-Google Slides. |
SPREADSHEET |
גיליון אלקטרוני ב-Google Sheets. |
DRAWING |
שרטוט. |
PDF |
קובץ PDF. |
IMAGE |
תמונה. |
VIDEO |
סרטון. |
AUDIO |
קובץ אודיו. |
RowQuestion
הגדרה של שאלה ששייכת לקבוצת שאלות.
ייצוג ב-JSON |
---|
{ "title": string } |
שדות | |
---|---|
title |
חובה. הכותרת של השורה היחידה ב- |
RatingQuestion
שאלה לגבי דירוג. המשתמש יכול לבחור מתוך מגוון סמלים.
ייצוג ב-JSON |
---|
{
"ratingScaleLevel": integer,
"iconType": enum ( |
שדות | |
---|---|
ratingScaleLevel |
חובה. רמת סולם הדירוג של שאלה לדירוג. |
iconType |
חובה. סוג הסמל שרוצים להשתמש בו לדירוג. |
RatingIconType
סוג הסמל שרוצים להשתמש בו לדירוג.
טיפוסים בני מנייה (enum) | |
---|---|
RATING_ICON_TYPE_UNSPECIFIED |
ערך ברירת המחדל. לא בשימוש. |
STAR |
סמל כוכב. |
HEART |
סמל של לב. |
THUMB_UP |
סמל של אגודל כלפי מטה. |
מתן ציון
מתן ציונים לשאלה אחת
ייצוג ב-JSON |
---|
{ "pointValue": integer, "correctAnswers": { object ( |
שדות | |
---|---|
pointValue |
חובה. המספר המקסימלי של נקודות שמשתמש יכול לקבל באופן אוטומטי על תשובה נכונה. הערך לא יכול להיות שלילי. |
correctAnswers |
חובה. מפתח התשובות לשאלה. התשובות ייבדקו באופן אוטומטי על סמך השדה הזה. |
whenRight |
המשוב שמוצג על תשובות נכונות. אפשר להגדיר משוב כזה רק לשאלות אמריקאיות עם תשובות נכונות. |
whenWrong |
המשוב שמוצג על תשובות שגויות. אפשר להגדיר משוב כזה רק לשאלות אמריקאיות עם תשובות נכונות. |
generalFeedback |
המשוב מוצג לגבי כל התשובות. בדרך כלל משתמשים באפשרות הזו בשאלות עם תשובה קצרה, כשבעלי הבוחן רוצים לתת למשתתפים מושג מהיר לגבי התשובה שלהם לפני שהם נותנים להם ציון רשמי. אי אפשר להגדיר משוב כללי לשאלות אמריקאיות שמקבלות ציון באופן אוטומטי. |
CorrectAnswers
מפתח התשובות לשאלה.
ייצוג ב-JSON |
---|
{
"answers": [
{
object ( |
שדות | |
---|---|
answers[] |
רשימה של תשובות נכונות. אפשר לתת ציון אוטומטי לתשובה לבוחן על סמך התשובות האלה. בשאלות עם ערך יחיד, תשובה מסוימת מסומנת כנכונה אם היא תואמת לאחד מהערכים ברשימה הזו (כלומר, יכולות להיות כמה תשובות נכונות). בשאלות עם מספר ערכים ( |
CorrectAnswer
תשובה נכונה אחת לשאלה. בשאלות עם ערכים מרובים (CHECKBOX
), יכול להיות שיהיה צורך בכמה CorrectAnswer
כדי לייצג אפשרות תשובה נכונה אחת.
ייצוג ב-JSON |
---|
{ "value": string } |
שדות | |
---|---|
value |
חובה. הערך של התשובה הנכונה. בתיעוד של |
QuestionGroupItem
הגדרה של שאלה שמכילה כמה שאלות מקובצות יחד.
ייצוג ב-JSON |
---|
{ "questions": [ { object ( |
שדות | |
---|---|
questions[] |
חובה. רשימה של השאלות ששייכות לקבוצת השאלות הזו. כל שאלה יכולה להשתייך רק לקבוצה אחת. |
image |
התמונה שמוצגת בקבוצת השאלות מעל השאלות הספציפיות. |
שדה האיחוד kind . חובה. סוג קבוצת השאלות, שקובע את סוגי השאלות שמותר להציג ואת אופן הצגתן. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
grid |
קבוצת השאלות היא רשת עם שורות של שאלות אמריקאיות שיש להן אותן אפשרויות. כשהערך של |
תצוגת רשת
רשת של אפשרויות (תיבות סימון או לחצני בחירה) שבכל שורה יש שאלה נפרדת. בכל שורה מופיעות אותן אפשרויות, שמוצגות כעמודות.
ייצוג ב-JSON |
---|
{
"columns": {
object ( |
שדות | |
---|---|
columns |
חובה. האפשרויות המשותפות לכל שאלה ברשת. במילים אחרות, הערכים של העמודות. אפשר לבחור רק באפשרויות |
shuffleQuestions |
אם |
PageBreakItem
אין שדות לסוג הזה.
מעבר דף. השם והתיאור של הפריט יוצגו בחלק העליון של הדף החדש.
TextItem
אין שדות לסוג הזה.
פריט טקסט.
ImageItem
פריט שמכיל תמונה.
ייצוג ב-JSON |
---|
{
"image": {
object ( |
שדות | |
---|---|
image |
חובה. התמונה שמוצגת בפריט. |
VideoItem
פריט שמכיל סרטון.
ייצוג ב-JSON |
---|
{
"video": {
object ( |
שדות | |
---|---|
video |
חובה. הסרטון שמוצג בפריט. |
caption |
הטקסט שמוצג מתחת לסרטון. |
וידאו
נתונים שמייצגים סרטון.
ייצוג ב-JSON |
---|
{
"youtubeUri": string,
"properties": {
object ( |
שדות | |
---|---|
youtubeUri |
חובה. מזהה URI של YouTube. |
properties |
המאפיינים של סרטון. |
PublishSettings
הגדרות הפרסום של טופס.
ייצוג ב-JSON |
---|
{
"publishState": {
object ( |
שדות | |
---|---|
publishState |
אופציונלי. מצב הפרסום של טופס. כשמעדכנים את |
PublishState
מצב הפרסום של טופס.
ייצוג ב-JSON |
---|
{ "isPublished": boolean, "isAcceptingResponses": boolean } |
שדות | |
---|---|
isPublished |
חובה. האם הטופס פורסם וגלוש לאחרים. |
isAcceptingResponses |
חובה. אם הטופס מקבל תשובות. אם השדה |
Methods |
|
---|---|
|
שינוי הטופס באמצעות קבוצה של עדכונים. |
|
יוצרים טופס חדש עם השם שצוין בהודעת הטופס שסופקה בבקשה. |
|
פותחים טופס. |
|
עדכון הגדרות הפרסום של טופס. |