- طلب HTTP
- مَعلمات المسار
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- الطلب
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- الموقع الجغرافي
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- الردّ
- إنشاء عنصر استجابة
- جرِّبه الآن
يمكنك تغيير النموذج باستخدام مجموعة من التعديلات.
طلب 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[] |
رقم تعريف السؤال الذي تم إنشاؤه كجزء من هذا العنصر، وبالنسبة إلى مجموعة أسئلة، يسرد معرّفات جميع الأسئلة التي تم إنشاؤها لهذا العنصر. |