Method: labels.delta

تعدِّل تصنيفًا واحدًا من خلال تطبيق مجموعة من طلبات التعديل تؤدي إلى إنشاء مسودة جديدة للمراجعة. يتم تطبيق التعديل المجمّع بالكامل أو لا يتم تطبيقه على الإطلاق: إذا كان أيّ من طلبات التعديل غير صالح، لن يتم تطبيق أي تغييرات. يجب نشر مسودة النسخة السابقة الواردة قبل استخدام التغييرات مع عناصر Drive.

طلب HTTP

POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
name

string

مطلوب. اسم مصدر التصنيف المطلوب تعديله.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
الحقول
writeControl

object (WriteControl)

توفِّر هذه الميزة إمكانية التحكُّم في كيفية تنفيذ طلبات الكتابة.
requests[]

object (Request)

قائمة بالتعديلات المطلوب تطبيقها على التصنيف سيتم تطبيق الطلبات بالترتيب الذي تم تحديده.
useAdminAccess

boolean

يجب ضبط القيمة على true لاستخدام بيانات اعتماد المشرف الخاصة بالمستخدم. سيتحقّق الخادم من أنّ المستخدم مشرف للتصنيف قبل السماح بالوصول إليه.
view

enum (LabelView)

وعند تحديده، سيتم فقط عرض حقول معيّنة تنتمي إلى الملف الشخصي المُشار إليه.
languageCode

string

رمز اللغة وفق معيار BCP-47 المراد استخدامه لتقييم تصنيفات الحقول المترجَمة عندما يكون include_label_in_response هو true.

نص الاستجابة

استجابة لتعديل التصنيف.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
الحقول
responses[]

object (Response)

الرد على التعديلات. ويُربط هذا الربط بين شخصين بالتعديلات، على الرغم من أنّ الردود على بعض الطلبات قد تكون فارغة.
updatedLabel

object (Label)

التصنيف بعد تطبيق التعديلات لا يتم ضبط هذا الإعداد إلا إذا كان [BatchUpdateLabelResponse2.include_label_in_response] يساوي true ولم تحدث أي أخطاء.

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

الطلب

نوع واحد من التعديلات يمكن تطبيقه على تصنيف معيّن.

تمثيل JSON 
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
الحقول
حقل الاتحاد kind. نوع التعديل يجب ملء حقل واحد بالضبط. يمكن أن يكون kind واحدًا فقط مما يلي:
updateLabel

object (UpdateLabelPropertiesRequest)

لتعديل خصائص التصنيف.
createField

object (CreateFieldRequest)

ينشئ حقلاً جديدًا.
updateField

object (UpdateFieldPropertiesRequest)

تعديل الخصائص الأساسية لحقل
updateFieldType

object (UpdateFieldTypeRequest)

تعديل خيارات نوع الحقل و/أو النوع.
enableField

object (EnableFieldRequest)

تفعيل الحقل
disableField

object (DisableFieldRequest)

لإيقاف الحقل.
deleteField

object (DeleteFieldRequest)

لحذف حقل من التصنيف.
createSelectionChoice

object (CreateSelectionChoiceRequest)

يؤدي إلى إنشاء اختيار ضمن حقل اختيار.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

تعديل سمات الخيارات ضمن حقل اختيار
enableSelectionChoice

object (EnableSelectionChoiceRequest)

تفعيل خيار ضمن حقل تحديد
disableSelectionChoice

object (DisableSelectionChoiceRequest)

أوقِف خيارًا ضمن حقل اختيار.
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

حذف خيار ضمن حقل اختيار

UpdateLabelPropertiesRequest

تعديل الخصائص الأساسية لتصنيف

تمثيل JSON 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
الحقول
updateMask

string (FieldMask format)

الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر label_properties ضمني ويجب عدم تحديده. يمكن استخدام * واحد كاختصار لتعديل كل حقل.
properties

object (Properties)

مطلوب. خصائص التصنيف المطلوب تعديلها

CreateFieldRequest

طلب إنشاء حقل داخل تصنيف

تمثيل JSON 
{
  "field": {
    object (Field)
  }
}
الحقول
field

object (Field)

مطلوب. الحقل المطلوب إنشاؤه

UpdateFieldPropertiesRequest

طلب تعديل خصائص الحقل

تمثيل JSON 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
الحقول
updateMask

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر properties ضمنيًا ولا يجب تحديده. يمكن استخدام رمز * واحد كاختصار لتعديل كل حقل.
id

string

مطلوب. الحقل المطلوب تعديله
properties

object (Properties)

مطلوب. خصائص الحقل الأساسية

UpdateFieldTypeRequest

طلب تغيير نوع حقل

تمثيل JSON 
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
الحقول
updateMask

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. جذر type_options ضمني ويجب عدم تحديده. يمكن استخدام * واحد كاختصار لتعديل كل حقل.
id

string

مطلوب. الحقل المطلوب تعديله

حقل الربط type_options

يمكن أن يكون type_options واحدًا فقط مما يلي:
textOptions

object (TextOptions)

عدِّل الحقل إلى "نص".
longTextOptions

object (LongTextOptions)

عدِّل الحقل إلى "نص طويل".
integerOptions

object (IntegerOptions)

عدِّل الحقل إلى عدد صحيح.
dateOptions

object (DateOptions)

عدِّل الحقل إلى "التاريخ".
selectionOptions

object (SelectionOptions)

عدِّل الحقل إلى "اختيار".
userOptions

object (UserOptions)

تعديل الحقل إلى "مستخدِم"

LongTextOptions

تحديد نوع الحقل "نص طويل"

تمثيل JSON 
{
  "minLength": integer,
  "maxLength": integer
}
الحقول
minLength

integer

النتائج فقط. الحد الأدنى لطول قيم حقل النص الصالح.
maxLength

integer

النتائج فقط. الحد الأقصى المسموح به لطول القيم في الحقل النصي

EnableFieldRequest

اطلب تفعيل الحقل.

تمثيل JSON 
{
  "id": string
}
الحقول
id

string

مطلوب. رقم تعريف الحقل المطلوب تفعيله.

DisableFieldRequest

طلب إيقاف الحقل

تمثيل JSON 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
الحقول
updateMask

string (FieldMask format)

الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر disabledPolicy ضمنيًا ولا يجب تحديده. يمكن استخدام رمز * واحد كاختصار لتعديل كل حقل.
id

string

مطلوب. مفتاح الحقل المراد إيقافه.
disabledPolicy

object (DisabledPolicy)

مطلوب. سياسة إيقاف الحقل.

DeleteFieldRequest

طلب حذف الحقل.

تمثيل JSON 
{
  "id": string
}
الحقول
id

string

مطلوب. رقم تعريف الحقل المطلوب حذفه.

CreateSelectionChoiceRequest

طلب إنشاء أحد خيارات التحديد.

تمثيل JSON 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
الحقول
fieldId

string

مطلوب. حقل الاختيار الذي سيتم إنشاء الاختيار فيه.
choice

object (Choice)

مطلوب. اختيار الإنشاء:

UpdateSelectionChoicePropertiesRequest

طلب تعديل سمات Choice

تمثيل JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
الحقول
updateMask

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر properties ضمنيًا ولا يجب تحديده. يمكن استخدام رمز * واحد كاختصار لتعديل كل حقل.
fieldId

string

مطلوب. حقل الاختيار المطلوب تعديله
id

string

مطلوب. اختيار التحديث:
properties

object (Properties)

مطلوب. خصائص الخيارات التي تريد تعديلها

EnableSelectionChoiceRequest

اطلب تفعيل أحد الخيارات.

تمثيل JSON 
{
  "fieldId": string,
  "id": string
}
الحقول
fieldId

string

مطلوب. حقل الاختيار الذي سيتم تفعيل الخيار فيه.
id

string

مطلوب. خيار التفعيل

DisableSelectionChoiceRequest

طلب إيقاف أحد الخيارات

تمثيل JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
الحقول
updateMask

string (FieldMask format)

الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر disabledPolicy ضمنيًا ولا يجب تحديده. يمكن استخدام رمز * واحد كاختصار لتعديل كل حقل.
fieldId

string

مطلوب. حقل الاختيار الذي سيتم إيقاف خيار فيه.
id

string

مطلوب. خيار للإيقاف.
disabledPolicy

object (DisabledPolicy)

مطلوب. تغيير السياسة التي تم إيقافها

DeleteSelectionChoiceRequest

طلب حذف أحد الخيارات

تمثيل JSON 
{
  "fieldId": string,
  "id": string
}
الحقول
fieldId

string

مطلوب. حقل الاختيار الذي سيتم حذف خيار منه.
id

string

مطلوب. هناك خيار للحذف.

الرد

رد واحد من تحديث.

تمثيل JSON 
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
الحقول
حقل الاتحاد response. تمثّل هذه السمة الاستجابة للطلب ذي الصلة. يمكن أن يكون response واحدًا فقط مما يلي:
updateLabel

object (UpdateLabelPropertiesResponse)

تم تحديث الخصائص الأساسية للتصنيف.
createField

object (CreateFieldResponse)

ينشئ حقلاً جديدًا.
updateField

object (UpdateFieldPropertiesResponse)

تعديل الخصائص الأساسية لحقل
updateFieldType

object (UpdateFieldTypeResponse)

تعديل خيارات نوع الحقل و/أو النوع.
enableField

object (EnableFieldResponse)

تفعيل الحقل
disableField

object (DisableFieldResponse)

لإيقاف الحقل.
deleteField

object (DeleteFieldResponse)

لحذف حقل من التصنيف.
createSelectionChoice

object (CreateSelectionChoiceResponse)

إنشاء خيار قائمة تحديد جديد لإضافته إلى حقل تحديد
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

لتعديل خيار ضمن حقل اختيار
enableSelectionChoice

object (EnableSelectionChoiceResponse)

تفعيل خيار ضمن حقل تحديد
disableSelectionChoice

object (DisableSelectionChoiceResponse)

لإيقاف خيار ضمن حقل اختيار
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

لحذف خيار من حقل اختيار

UpdateLabelPropertiesResponse

لا يحتوي هذا النوع على أي حقول.

الرد بعد التعديل على خصائص التصنيف.

CreateFieldResponse

الرد بعد إنشاء الحقل

تمثيل JSON 
{
  "id": string,
  "priority": integer
}
الحقول
id

string

حقل الحقل الذي تم إنشاؤه. عند ترك هذا الحقل فارغًا في طلب إنشاء، سيتم إنشاء مفتاح تلقائيًا ويمكن تحديده هنا.
priority

integer

أولوية الحقل الذي تم إنشاؤه قد تتغيّر الأولوية عن ما تم تحديده لضمان الأولويات المتسلسلة بين الحقول (من 1 إلى n).

UpdateFieldPropertiesResponse

الردّ بعد تعديل المواقع الإلكترونية في "الحقل"

تمثيل JSON 
{
  "priority": integer
}
الحقول
priority

integer

أولوية الحقل المعدَّل. قد تتغير الأولوية عما تم تحديده لضمان أولويات متجاورة بين الحقول (1-n).

UpdateFieldTypeResponse

لا يحتوي هذا النوع على أي حقول.

الرد بعد تعديل نوع الحقل

EnableFieldResponse

لا يحتوي هذا النوع على أي حقول.

تفعيل الحقل بعد الردّ عليه

DisableFieldResponse

لا يحتوي هذا النوع على أي حقول.

الاستجابة التي تلي إيقاف الحقل.

DeleteFieldResponse

لا يحتوي هذا النوع على أي حقول.

الاستجابة بعد حذف الحقل

CreateSelectionChoiceResponse

الرد بعد إنشاء خيار الاختيار.

تمثيل JSON 
{
  "fieldId": string,
  "id": string
}
الحقول
fieldId

string

معرّف الحقل الذي ينشئه الخادم.
id

string

المعرِّف الذي ينشئه الخادم للخيار الذي تم إنشاؤه داخل الحقل

UpdateSelectionChoicePropertiesResponse

الرد بعد التعديل على مواقع "اختيار الاختيار".

تمثيل JSON 
{
  "priority": integer
}
الحقول
priority

integer

أولوية الخيار المعدَّل قد تتغير الأولوية عن ما تم تحديده لضمان تسلسل الأولويات بين الخيارات (من 1 إلى n).

EnableSelectionChoiceResponse

لا يحتوي هذا النوع على أي حقول.

يتم تفعيل الرد التالي لخيار "الاختيار".

DisableSelectionChoiceResponse

لا يحتوي هذا النوع على أي حقول.

إيقاف الرد الذي يلي الخيار "اختيار".

DeleteSelectionChoiceResponse

لا يحتوي هذا النوع على أي حقول.

هناك ردّ بعد حذف الإجراء.