- طلب HTTP
- مَعلمات المسار
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- الطلب
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest.
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest.
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- الرد
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse.
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse (الاستجابة للطلب).
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- جرِّبه الآن
تعمل على تعديل تصنيف واحد من خلال تطبيق مجموعة من طلبات التعديل، ما يؤدي إلى إنشاء مسودة جديدة. التحديث المجمّع هو كل شيء أو لا شيء: إذا كان أي من طلبات التعديل غير صالح، فلن يتم تطبيق أي تغييرات. يجب نشر النسخة السابقة من المسودة قبل أن يمكن استخدام التغييرات مع عناصر Drive.
طلب HTTP
POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta
يستخدم عنوان URL بنية تحويل الترميز gRPC.
معلمات المسار
المَعلمات | |
---|---|
name |
مطلوبة. اسم مورد التصنيف المطلوب تحديثه. |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "writeControl": { object ( |
الحقول | |
---|---|
writeControl |
توفر إمكانية التحكم في كيفية تنفيذ طلبات الكتابة. |
requests[] |
قائمة بالتعديلات المطلوب تطبيقها على التصنيف سيتم تطبيق الطلبات بالترتيب الذي تم تحديدها به. |
useAdminAccess |
يمكنك ضبط القيمة على |
view |
عند تحديدها، لن يتم عرض سوى حقول معينة تتعلق بالملف الشخصي المشار إليه. |
languageCode |
رمز اللغة BCP-47 المطلوب استخدامه لتقييم تصنيفات الحقول المترجَمة عندما تكون |
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
ردّ بشأن تعديل التصنيف
تمثيل JSON |
---|
{ "responses": [ { object ( |
الحقول | |
---|---|
responses[] |
الردّ على التعديلات يؤدي هذا إلى الربط بين 1:1 والتعديلات، على الرغم من أنّ الردود على بعض الطلبات قد تكون فارغة. |
updatedLabel |
التصنيف بعد تطبيق التعديلات. يتم ضبط السياسة فقط إذا كانت قيمة [BatchUpdateLabelResponse2.include_label_in_response] هي |
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/drive.labels
https://www.googleapis.com/auth/drive.admin.labels
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
الطلب
هو نوع واحد من التعديلات يتم تطبيقه على التصنيف.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد kind نوع التحديث. يجب ملء حقل واحد فقط. يمكن أن يكون الحقل "kind " واحدًا فقط مما يلي: |
|
updateLabel |
لتعديل خصائص التصنيف. |
createField |
تنشئ حقلاً جديدًا. |
updateField |
تحديث الخصائص الأساسية للحقل. |
updateFieldType |
تعديل نوع الحقل و/أو خيارات النوع. |
enableField |
لتفعيل الحقل. |
disableField |
لإيقاف الحقل. |
deleteField |
لحذف حقل من التصنيف. |
createSelectionChoice |
لإنشاء اختيار داخل حقل "التحديد". |
updateSelectionChoiceProperties |
عدِّل سمات "الاختيار" ضمن حقل اختيار. |
enableSelectionChoice |
تفعيل "اختيار" ضمن حقل "اختيار" |
disableSelectionChoice |
إيقاف اختيار داخل حقل اختيار |
deleteSelectionChoice |
حذف اختيار ضمن حقل اختيار |
UpdateLabelPropertiesRequest
تحدّث الخصائص الأساسية للتصنيف.
تمثيل JSON |
---|
{
"updateMask": string,
"properties": {
object ( |
الحقول | |
---|---|
updateMask |
الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر |
properties |
مطلوبة. خصائص التصنيف المطلوب تعديلها |
CreateFieldRequest
اطلب إنشاء حقل ضمن تصنيف.
تمثيل JSON |
---|
{
"field": {
object ( |
الحقول | |
---|---|
field |
مطلوبة. الحقل المطلوب إنشاؤه |
UpdateFieldPropertiesRequest
اطلب تعديل مواقع "الحقل".
تمثيل JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
الحقول | |
---|---|
updateMask |
الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر |
id |
مطلوبة. الحقل المطلوب تحديثه. |
properties |
مطلوبة. خصائص الحقل الأساسي |
UpdateFieldTypeRequest
اطلب تغيير نوع الحقل.
تمثيل JSON |
---|
{ "updateMask": string, "id": string, // Union field |
الحقول | |
---|---|
updateMask |
الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. إنّ جذر |
id |
مطلوبة. الحقل المطلوب تحديثه. |
حقل الاتحاد يمكن أن يكون الحقل " |
|
textOptions |
تعديل الحقل إلى "نص" |
longTextOptions |
تعديل الحقل إلى نص طويل |
integerOptions |
يُرجى تعديل الحقل إلى عدد صحيح. |
dateOptions |
تعديل الحقل إلى "التاريخ". |
selectionOptions |
تعديل الحقل إلى "الاختيار". |
userOptions |
تعديل الحقل إلى "المستخدم". |
LongTextOptions
خيارات نوع الحقل "نص طويل".
تمثيل JSON |
---|
{ "minLength": integer, "maxLength": integer } |
الحقول | |
---|---|
minLength |
النتائج فقط. تمثّل هذه السمة الحد الأدنى لطول القيم الصالحة في حقل النص. |
maxLength |
النتائج فقط. الحد الأقصى لطول القيم الصالحة لحقل النص. |
EnableFieldRequest
اطلب تفعيل الحقل.
تمثيل JSON |
---|
{ "id": string } |
الحقول | |
---|---|
id |
مطلوبة. رقم تعريف الحقل المطلوب تفعيله. |
DisableFieldRequest
اطلب إيقاف الحقل.
تمثيل JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
الحقول | |
---|---|
updateMask |
الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر |
id |
مطلوبة. مفتاح الحقل الذي تريد إيقافه. |
disabledPolicy |
مطلوبة. سياسة إيقاف الحقل |
DeleteFieldRequest
طلب حذف الحقل.
تمثيل JSON |
---|
{ "id": string } |
الحقول | |
---|---|
id |
مطلوبة. رقم تعريف الحقل المطلوب حذفه. |
CreateSelectionChoiceRequest
اطلب إنشاء أحد خيارات الاختيار.
تمثيل JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
الحقول | |
---|---|
fieldId |
مطلوبة. حقل الاختيار الذي سيتم فيه إنشاء "اختيار" |
choice |
مطلوبة. اختيار إنشاء المحتوى |
UpdateSelectionChoicePropertiesRequest
يمكنك طلب تعديل أحد المواقع الإلكترونية التي اختَرتها.
تمثيل JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
الحقول | |
---|---|
updateMask |
الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر |
fieldId |
مطلوبة. حقل التحديد المطلوب تعديله. |
id |
مطلوبة. خيار تحديث التطبيق: |
properties |
مطلوبة. سمات "الاختيار" المطلوب تعديلها |
EnableSelectionChoiceRequest
طلب تفعيل "اختيار"
تمثيل JSON |
---|
{ "fieldId": string, "id": string } |
الحقول | |
---|---|
fieldId |
مطلوبة. حقل "التحديد" الذي سيتم فيه تفعيل "اختيار". |
id |
مطلوبة. انقر على خيار التفعيل. |
DisableSelectionChoiceRequest
طلب إيقاف "اختيار"
تمثيل JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
الحقول | |
---|---|
updateMask |
الحقول التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر |
fieldId |
مطلوبة. حقل الاختيار الذي سيتم فيه إيقاف "اختيار". |
id |
مطلوبة. خيار الإيقاف. |
disabledPolicy |
مطلوبة. السياسة غير المفعّلة التي سيتم تعديلها. |
DeleteSelectionChoiceRequest
طلب حذف اختيار
تمثيل JSON |
---|
{ "fieldId": string, "id": string } |
الحقول | |
---|---|
fieldId |
مطلوبة. حقل الاختيار الذي سيتم حذف اختيار منه. |
id |
مطلوبة. خيار الحذف. |
الإجابة
رد واحد من التحديث.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد response الاستجابة للطلب المقابل. يمكن أن يكون الحقل "response " واحدًا فقط مما يلي: |
|
updateLabel |
تم تعديل السمات الأساسية لأحد التصنيفات. |
createField |
تنشئ حقلاً جديدًا. |
updateField |
تحديث الخصائص الأساسية للحقل. |
updateFieldType |
تعديل نوع الحقل و/أو خيارات النوع. |
enableField |
يؤدي هذا الإجراء إلى تفعيل الحقل. |
disableField |
لإيقاف الحقل. |
deleteField |
لحذف حقل من التصنيف. |
createSelectionChoice |
تعمل هذه السياسة على إنشاء خيار جديد في قائمة الاختيار لإضافته إلى "حقل تحديد". |
updateSelectionChoiceProperties |
لتعديل اختيار ضمن حقل التحديد |
enableSelectionChoice |
لتفعيل خيار داخل حقل التحديد. |
disableSelectionChoice |
لإيقاف اختيار داخل حقل التحديد. |
deleteSelectionChoice |
لحذف اختيار من حقل التحديد. |
UpdateLabelPropertiesResponse
الرد بعد التعديل على خصائص التصنيف.
CreateFieldResponse
تم إنشاء رد بعد إنشاء الحقل.
تمثيل JSON |
---|
{ "id": string, "priority": integer } |
الحقول | |
---|---|
id |
الحقل الخاص بالحقل الذي تم إنشاؤه. عند ترك هذا الحقل فارغًا في طلب إنشاء، سيتم إنشاء مفتاح تلقائيًا ويمكن تحديده هنا. |
priority |
أولوية الحقل الذي تم إنشاؤه قد تتغير الأولوية عما تم تحديده لضمان أولويات متجاورة بين الحقول (1-n). |
UpdateFieldPropertiesResponse
الرد بعد التعديل على المواقع الإلكترونية في الحقل
تمثيل JSON |
---|
{ "priority": integer } |
الحقول | |
---|---|
priority |
أولوية الحقل المعدَّل. قد تتغير الأولوية عما تم تحديده لضمان أولويات متجاورة بين الحقول (1-n). |
UpdateFieldTypeResponse
الرد بعد التعديل على نوع الحقل.
EnableFieldResponse
تفعيل الحقل التالي للاستجابة
DisableFieldResponse
تم إيقاف الحقل التالي للاستجابة.
DeleteFieldResponse
الرد التالي لحذف الحقل:
CreateSelectionChoiceResponse
تم إنشاء الرد بعد إنشاء خيار الاختيار.
تمثيل JSON |
---|
{ "fieldId": string, "id": string } |
الحقول | |
---|---|
fieldId |
المعرّف الذي أنشأه الخادم للحقل. |
id |
المعرف الذي ينشئه الخادم للخيار الذي تم إنشاؤه داخل الحقل |
UpdateSelectionChoicePropertiesResponse
رد بعد التعديل على سمات "اختيار الاختيار".
تمثيل JSON |
---|
{ "priority": integer } |
الحقول | |
---|---|
priority |
أولوية الخيار المعدّل. قد تتغير الأولوية عما تم تحديده لضمان أولويات متعارضة بين الخيارات (1-n). |
EnableSelectionChoiceResponse
تم تفعيل الرد بعد تفعيل الاختيار.
DisableSelectionChoiceResponse
تم إيقاف الرد التالي "الاختيار".
DeleteSelectionChoiceResponse
الرد بعد حذف الاختيار.