- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- בקשה
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- מיקום
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- תשובה
- CreateItemResponse
- רוצים לנסות?
שינוי הטופס באמצעות חבילת עדכונים.
בקשת HTTP
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
formId |
חובה. מזהה הטופס. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
שדות | |
---|---|
includeFormInResponse |
האם להחזיר גרסה מעודכנת של המודל בתגובה. |
requests[] |
חובה. הבקשות לעדכון של הקבוצה הזו. |
writeControl |
מספק שליטה על אופן הביצוע של בקשות כתיבה. |
גוף התגובה
תגובה ל-BatchUpdateFormRequest.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{ "form": { object ( |
שדות | |
---|---|
form |
על סמך שדה הבקשה הבוליאני |
replies[] |
התשובה לגבי העדכונים. המיפוי יהיה ביחס של 1:1 לבקשות העדכון, למרות שתשובות לחלק מהבקשות יכולות להיות ריקות. |
writeControl |
בקרת הכתיבה המעודכנת לאחר החלת הבקשה. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/forms.body
למידע נוסף, ניתן לעיין במדריך ההרשאות.
בקשה
סוגי בקשות העדכון שניתן לשלוח.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד kind . סוג הבקשה. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
updateFormInfo |
מעדכנים את פרטי הטופס. |
updateSettings |
עדכון ההגדרות של הטופס. |
createItem |
יצירת פריט חדש. |
moveItem |
העברת פריט למיקום ספציפי. |
deleteItem |
מחיקת פריט. |
updateItem |
מעדכנים פריט. |
UpdateFormInfoRequest
מעדכנים את פרטי הטופס.
ייצוג JSON |
---|
{
"info": {
object ( |
שדות | |
---|---|
info |
המידע שצריך לעדכן. |
updateMask |
חובה. רק הערכים שמוזכרים במסכה הזו ישתנו. יש לציין לפחות שדה אחד. ערך השורש זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: |
UpdateSettingsRequest
עדכון FormSettings
בטופס.
ייצוג JSON |
---|
{
"settings": {
object ( |
שדות | |
---|---|
settings |
חובה. ההגדרות שצריך לעדכן לפיהן. |
updateMask |
חובה. רק הערכים שמוזכרים במסכה הזו ישתנו. יש לציין לפחות שדה אחד. ערך השורש זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: |
CreateItemRequest
אפשר ליצור פריט בטופס.
ייצוג JSON |
---|
{ "item": { object ( |
שדות | |
---|---|
item |
חובה. הפריט ליצירה. |
location |
חובה. איפה למקם את הפריט החדש. |
מיקום
מיקום ספציפי בטופס.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד where . חובה. מציינים מיקום בטופס. הערך של where יכול להיות רק אחת מהאפשרויות הבאות: |
|
index |
האינדקס של פריט בטופס. זה חייב להיות בטווח
, כאשר N הוא מספר הפריטים שבטופס. |
MoveItemRequest
העברת פריט בטופס.
ייצוג JSON |
---|
{ "originalLocation": { object ( |
שדות | |
---|---|
originalLocation |
חובה. מיקום הפריט שיש להעביר. |
newLocation |
חובה. המיקום החדש של הפריט. |
DeleteItemRequest
מוחקים פריט בטופס.
ייצוג JSON |
---|
{
"location": {
object ( |
שדות | |
---|---|
location |
חובה. מיקום הפריט למחיקה. |
UpdateItemRequest
מעדכנים פריט בטופס.
ייצוג JSON |
---|
{ "item": { object ( |
שדות | |
---|---|
item |
חובה. ערכים חדשים לפריט. חשוב לשים לב שמזהי הפריטים והשאלות משמשים אם הם סופקו (ומופיעים באנונימיזציה של השדות). אם מזהה ריק (ובמסכת השדות), נוצר מזהה חדש. המשמעות היא שניתן לשנות פריט על ידי הורדת הטופס דרך |
location |
חובה. המיקום שמזהה את הפריט שצריך לעדכן. |
updateMask |
חובה. רק הערכים שמוזכרים במסכה הזו ישתנו. זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: |
WriteControl
מספק שליטה על אופן הביצוע של בקשות כתיבה.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד control . קובעת את הגרסה הקודמת של הטופס שממנה רוצים להחיל את השינויים, ואיך הבקשה צריכה להתנהג אם הגרסה האחרת אינה הגרסה הנוכחית של הטופס. הערך של control יכול להיות רק אחת מהאפשרויות הבאות: |
|
requiredRevisionId |
מזהה הגרסה הקודמת של הטופס שעליו חלה בקשת הכתיבה. אם זו לא הגרסה האחרונה של הטופס, הבקשה לא תעובד ותחזיר את שגיאת הבקשה 400. |
targetRevisionId |
מזהה הגרסה הקודמת של הטופס שעליו חלה בקשת הכתיבה. אם התבצעו שינויים אחרי התיקון הזה, השינויים בבקשת העדכון ישתנו בהתאם. כתוצאה מכך נוצרת גרסה חדשה של הטופס שכוללת גם את השינויים בבקשה וגם את השינויים שביניהם, כאשר השרת יפתור את השינויים הסותרים. ניתן להשתמש במזהה הגרסה של היעד רק כדי לכתוב בגרסאות אחרונות של טופס. אם הגרסה הקודמת של היעד רחוקה מדי מהגרסאות האחרונות, הבקשה לא תעובד ותחזיר שגיאת 400 (שגיאה של בקשה שגויה). ניתן לנסות לשלוח את הבקשה שוב לאחר קריאת הגרסה האחרונה של הטופס. ברוב המקרים, מזהה של גרסה קודמת של יעד נשאר תקף למשך כמה דקות אחרי שהוא נקרא, אבל בטפסים שנערכות בתדירות גבוהה, החלון עשוי להיות קצר יותר. |
תשובה
תשובה אחת מעדכון.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד kind . סוג התגובה. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
createItem |
התוצאה של יצירת פריט. |
CreateItemResponse
התוצאה של יצירת פריט.
ייצוג JSON |
---|
{ "itemId": string, "questionId": [ string ] } |
שדות | |
---|---|
itemId |
המזהה של הפריט שנוצר. |
questionId[] |
המזהה של השאלה שנוצרה כחלק מהפריט הזה. כשמדובר בקבוצת שאלות, הוא מפרט את המזהים של כל השאלות שנוצרו בפריט הזה. |