Method: forms.batchUpdate

فرم را با دسته ای از به روز رسانی ها تغییر دهید.

درخواست HTTP

POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
formId

string

مورد نیاز. شناسه فرم

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "includeFormInResponse": boolean,
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
فیلدها
includeFormInResponse

boolean

آیا برای بازگرداندن نسخه به روز شده از مدل در پاسخ.

requests[]

object ( Request )

مورد نیاز. درخواست های به روز رسانی این دسته

writeControl

object ( WriteControl )

کنترل نحوه اجرای درخواست های نوشتن را فراهم می کند.

بدن پاسخگو

پاسخ به BatchUpdateFormRequest.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "form": {
    object (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
فیلدها
form

object ( Form )

بر اساس فیلد درخواست bool includeFormInResponse ، فرمی با تمام جهش‌ها/به‌روزرسانی‌های اعمال‌شده برگردانده می‌شود یا خیر. این ممکن است دیرتر از شناسه بازبینی ایجاد شده توسط این تغییرات باشد.

replies[]

object ( Response )

پاسخ به روز رسانی ها این نقشه 1:1 با درخواست‌های به‌روزرسانی است، اگرچه ممکن است پاسخ‌ها به برخی از درخواست‌ها خالی باشد.

writeControl

object ( 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 can be only one of the following:
  "updateFormInfo": {
    object (UpdateFormInfoRequest)
  },
  "updateSettings": {
    object (UpdateSettingsRequest)
  },
  "createItem": {
    object (CreateItemRequest)
  },
  "moveItem": {
    object (MoveItemRequest)
  },
  "deleteItem": {
    object (DeleteItemRequest)
  },
  "updateItem": {
    object (UpdateItemRequest)
  }
  // End of list of possible types for union field kind.
}
فیلدها
kind میدان اتحادیه . نوع درخواست. kind می تواند تنها یکی از موارد زیر باشد:
updateFormInfo

object ( UpdateFormInfoRequest )

به روز رسانی اطلاعات فرم

updateSettings

object ( UpdateSettingsRequest )

تنظیمات فرم را به روز می کند.

createItem

object ( CreateItemRequest )

یک مورد جدید ایجاد کنید.

moveItem

object ( MoveItemRequest )

یک مورد را به یک مکان مشخص منتقل کنید.

deleteItem

object ( DeleteItemRequest )

یک مورد را حذف کنید

updateItem

object ( UpdateItemRequest )

یک مورد را به روز کنید

UpdateFormInfoRequest

به روز رسانی اطلاعات فرم

نمایندگی JSON 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
فیلدها
info

object ( Info )

اطلاعات برای به روز رسانی

updateMask

string ( FieldMask format)

مورد نیاز. فقط مقادیر نامگذاری شده در این ماسک تغییر می کنند. حداقل یک فیلد باید مشخص شود. info ریشه به صورت ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد می‌توان از یک "*" به عنوان علامت کوتاه استفاده کرد.

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

UpdateSettingsRequest

FormSettings فرم را به روز کنید.

نمایندگی JSON 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
فیلدها
settings

object ( FormSettings )

مورد نیاز. تنظیمات برای به روز رسانی با.

updateMask

string ( FieldMask format)

مورد نیاز. فقط مقادیر نامگذاری شده در این ماسک تغییر می کنند. حداقل یک فیلد باید مشخص شود. settings ریشه به صورت ضمنی است و نباید مشخص شود. برای به‌روزرسانی هر فیلد می‌توان از یک "*" به عنوان علامت کوتاه استفاده کرد.

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

CreateItemRequest

یک مورد را در یک فرم ایجاد کنید.

نمایندگی JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
فیلدها
item

object ( Item )

مورد نیاز. موردی برای ایجاد

location

object ( Location )

مورد نیاز. محل قرار دادن آیتم جدید

مکان

یک مکان خاص در یک فرم.

نمایندگی JSON 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
فیلدها
میدان اتحادیه where . مورد نیاز. یک مکان را در فرم مشخص کنید. where فقط یکی از موارد زیر می تواند باشد:
index

integer

نمایه یک آیتم در فرم. این باید در محدوده باشد

[0.. N )

، که N تعداد موارد موجود در فرم است.

MoveItemRequest

یک مورد را در یک فرم جابجا کنید.

نمایندگی JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
فیلدها
originalLocation

object ( Location )

مورد نیاز. مکان مورد برای جابجایی

newLocation

object ( Location )

مورد نیاز. مکان جدید مورد

DeleteItemRequest

یک مورد را در یک فرم حذف کنید.

نمایندگی JSON 
{
  "location": {
    object (Location)
  }
}
فیلدها
location

object ( Location )

مورد نیاز. مکان موردی که باید حذف شود.

UpdateItemRequest

یک مورد را در یک فرم به روز کنید.

نمایندگی JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
فیلدها
item

object ( Item )

مورد نیاز. مقادیر جدید برای آیتم توجه داشته باشید که شناسه های آیتم و سوال در صورت ارائه (و در قسمت ماسک) استفاده می شوند. اگر یک شناسه خالی باشد (و در ماسک فیلد) یک شناسه جدید ایجاد می شود. این بدان معناست که می‌توانید یک مورد را با دریافت فرم از طریق forms.get تغییر دهید، کپی محلی خود را از آن مورد تغییر دهید تا آن‌طور که می‌خواهید، و با استفاده از UpdateItemRequest برای بازنویسی آن، با همان شناسه‌ها (یا نه در فیلد) آن را تغییر دهید. ماسک).

location

object ( Location )

مورد نیاز. مکان شناسایی مورد برای به‌روزرسانی.

updateMask

string ( FieldMask format)

مورد نیاز. فقط مقادیر نامگذاری شده در این ماسک تغییر می کنند.

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

WriteControl

کنترل نحوه اجرای درخواست های نوشتن را فراهم می کند.

نمایندگی JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
فیلدها
control میدان اتحادیه بازبینی فرمی را که قرار است تغییرات از آن اعمال شود، تعیین می‌کند و اگر آن بازبینی ویرایش فعلی فرم نباشد، درخواست چگونه باید رفتار کند. control فقط می تواند یکی از موارد زیر باشد:
requiredRevisionId

string

شناسه بازبینی فرمی که درخواست نوشتن روی آن اعمال می شود. اگر این آخرین ویرایش فرم نباشد، درخواست پردازش نمی‌شود و خطای 400 درخواست بد را برمی‌گرداند.

targetRevisionId

string

شناسه بازبینی هدف فرمی که درخواست نوشتن روی آن اعمال می‌شود.

اگر تغییراتی پس از این ویرایش رخ داده باشد، تغییرات در این درخواست به‌روزرسانی در مقابل آن تغییرات تغییر می‌کند. این منجر به تجدیدنظر جدیدی در فرم می شود که هم تغییرات در درخواست و هم تغییرات مداخله ای را در بر می گیرد و سرور تغییرات متناقض را حل می کند.

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

پاسخ

یک پاسخ از یک به روز رسانی.

نمایندگی JSON 
{

  // Union field kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
فیلدها
kind میدان اتحادیه . نوع پاسخ. kind می تواند تنها یکی از موارد زیر باشد:
createItem

object ( CreateItemResponse )

نتیجه ایجاد یک آیتم.

CreateItemResponse

نتیجه ایجاد یک آیتم.

نمایندگی JSON 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
فیلدها
itemId

string

شناسه مورد ایجاد شده

questionId[]

string

شناسه سؤال ایجاد شده به عنوان بخشی از این مورد، برای یک گروه سؤال، شناسه تمام سؤالات ایجاد شده برای این مورد را فهرست می کند.