- درخواست HTTP
- پارامترهای مسیر
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- درخواست
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- محل
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- واکنش
- CreateItemResponse
- آن را امتحان کنید!
فرم را با دسته ای از به روز رسانی ها تغییر دهید.
درخواست HTTP
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
formId | ضروری. شناسه فرم |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
زمینه های | |
---|---|
includeFormInResponse | آیا برای بازگرداندن نسخه به روز شده از مدل در پاسخ. |
requests[] | ضروری. درخواست های به روز رسانی این دسته |
writeControl | کنترل نحوه اجرای درخواست های نوشتن را فراهم می کند. |
بدن پاسخگو
پاسخ به BatchUpdateFormRequest.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "form": { object ( |
زمینه های | |
---|---|
form | بر اساس فیلد درخواست bool |
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[] | شناسه سؤال ایجاد شده به عنوان بخشی از این مورد، برای یک گروه سؤال، شناسه تمام سؤالات ایجاد شده برای این مورد را فهرست می کند. |