- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התגובה
- היקפי הרשאות
- בקשה
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- מיקום
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- תגובה
- CreateItemResponse
- רוצים לנסות?
שינוי הטופס באמצעות קבוצה של עדכונים.
בקשת HTTP
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
form |
חובה. מזהה הטופס. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
שדות | |
---|---|
include |
האם להחזיר גרסה מעודכנת של המודל בתגובה. |
requests[] |
חובה. בקשות העדכון של האצווה הזו. |
write |
מאפשרת לקבוע איך בקשות הכתיבה יבוצעו. |
גוף התשובה
תשובה לבקשה מסוג BatchUpdateFormRequest.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{ "form": { object ( |
שדות | |
---|---|
form |
בהתאם לשדה הבקשה מסוג bool |
replies[] |
התשובה לעדכונים. התשובות מתאימות לבקשות העדכון ביחס של 1:1, אבל ייתכן שהתשובות לבקשות מסוימות יהיו ריקות. |
write |
אמצעי הבקרה המעודכן של הכתיבה אחרי החלת הבקשה. |
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של 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 יכול להיות רק אחת מהאפשרויות הבאות: |
|
update |
מעדכנים את הפרטים של הטופס. |
update |
מעדכנים את ההגדרות של הטופס. |
create |
יצירת פריט חדש. |
move |
העברת פריט למיקום מסוים. |
delete |
מוחקים פריט. |
update |
מעדכנים פריט. |
UpdateFormInfoRequest
מעדכנים את הפרטים של הטופס.
ייצוג ב-JSON |
---|
{
"info": {
object ( |
שדות | |
---|---|
info |
המידע שרוצים לעדכן. |
update |
חובה. רק ערכים שצוינו במסכה הזו ישתנו. צריך לציין שדה אחד לפחות. השורש זוהי רשימה של שמות שדות מוגדרים במלואם, שמופרדים בפסיקים. דוגמה: |
UpdateSettingsRequest
מעדכנים את השדה FormSettings
בטופס.
ייצוג ב-JSON |
---|
{
"settings": {
object ( |
שדות | |
---|---|
settings |
חובה. ההגדרות שרוצים לעדכן. |
update |
חובה. רק ערכים שצוינו במסכה הזו ישתנו. צריך לציין שדה אחד לפחות. השורש זוהי רשימה של שמות שדות מוגדרים במלואם, שמופרדים בפסיקים. דוגמה: |
CreateItemRequest
יוצרים פריט בטופס.
ייצוג ב-JSON |
---|
{ "item": { object ( |
שדות | |
---|---|
item |
חובה. הפריט שיצרתם. |
location |
חובה. איפה למקם את הפריט החדש. |
מיקום
מיקום ספציפי בטופס.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד where . חובה. מציינים מיקום בטופס. הערך של where יכול להיות רק אחת מהאפשרויות הבאות: |
|
index |
האינדקס של פריט בטופס. הערך חייב להיות בטווח
, כאשר N הוא מספר הפריטים בטופס. |
MoveItemRequest
העברת פריט בטופס.
ייצוג ב-JSON |
---|
{ "originalLocation": { object ( |
שדות | |
---|---|
original |
חובה. המיקום של הפריט שרוצים להעביר. |
new |
חובה. המיקום החדש של הפריט. |
DeleteItemRequest
מחיקת פריט בטופס.
ייצוג ב-JSON |
---|
{
"location": {
object ( |
שדות | |
---|---|
location |
חובה. המיקום של הפריט שרוצים למחוק. |
UpdateItemRequest
עדכון פריט בטופס.
ייצוג ב-JSON |
---|
{ "item": { object ( |
שדות | |
---|---|
item |
חובה. ערכים חדשים של הפריט. הערה: המערכת משתמשת במזהי הפריטים והשאלות אם הם צוינו (והם נמצאים במסכת השדות). אם מזהה ריק (ובמסכת השדה), נוצר מזהה חדש. כלומר, אפשר לשנות פריט על ידי אחזור הטופס באמצעות |
location |
חובה. המיקום שמזהה את הפריט שרוצים לעדכן. |
update |
חובה. רק ערכים שצוינו במסכה הזו ישתנו. זוהי רשימה של שמות שדות מוגדרים במלואם, שמופרדים בפסיקים. דוגמה: |
WriteControl
מאפשרת לקבוע איך בקשות הכתיבה יבוצעו.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד control . קובע את הגרסה של הטופס שממנה יוחלו השינויים, ואת האופן שבו הבקשה תפעל אם הגרסה הזו היא לא הגרסה הנוכחית של הטופס. הערך של control יכול להיות רק אחת מהאפשרויות הבאות: |
|
required |
מזהה הגרסה של הטופס שאליו חלה בקשת הכתיבה. אם זו לא הגרסה האחרונה של הטופס, הבקשה לא תעובד ותוחזר שגיאה 400 (בקשה לא חוקית). |
target |
מזהה הגרסה של היעד של הטופס שאליו חלה בקשת הכתיבה. אם בוצעו שינויים אחרי הגרסה הזו, השינויים בבקשת העדכון הזו יעברו טרנספורמציה בהתאם לשינויים האלה. התוצאה היא גרסה חדשה של הטופס שמשלבת גם את השינויים בבקשה וגם את השינויים שבוצעו בינתיים, והשרת פותר את השינויים המתנגשים. אפשר להשתמש במזהה הגרסה של היעד רק כדי לכתוב בגרסאות האחרונות של טופס. אם גרסת היעד רחוקה מדי מגרסת המקור האחרונה, הבקשה לא תעובד ותוחזר 400 (שגיאת בקשה לא תקינה). אפשר לנסות שוב לשלוח את הבקשה אחרי קריאת הגרסה האחרונה של הטופס. ברוב המקרים, מזהה הגרסה של היעד נשאר בתוקף למשך כמה דקות אחרי שהוא נקרא, אבל בטופס שמתבצעת בו עריכה לעיתים קרובות, חלון הזמן הזה עשוי להיות קצר יותר. |
תשובה
תשובה אחת מעדכון.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . סוג התגובה. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
create |
התוצאה של יצירת פריט. |
CreateItemResponse
התוצאה של יצירת פריט.
ייצוג ב-JSON |
---|
{ "itemId": string, "questionId": [ string ] } |
שדות | |
---|---|
item |
המזהה של הפריט שנוצר. |
question |
המזהה של השאלה שנוצרה כחלק מהפריט הזה. בקבוצת שאלות, מוצגים המזהים של כל השאלות שנוצרו עבור הפריט הזה. |