إنشاء تصنيف ونشره

يوضّح هذا المستند كيفية إنشاء التصنيفات ونشرها باستخدام Google Drive Labels API.

إنشاء تصنيف

لإنشاء تصنيف، استخدِم طريقة create في مورد labels. يمكن أن تحتوي التصنيفات اختياريًا على عنصر واحد أو أكثر من عناصر Field.

يجب أيضًا تحديد ما يلي:

• وهو يمثّل عنصر LabelType.

• تصنيف title من خلال العنصر Properties

• تم ضبط مَعلمة طلب البحث useAdminAccess على true لاستخدام بيانات اعتماد المشرف الخاصة بالمستخدم. قبل السماح بالوصول، يتأكّد الخادم من أنّ المستخدم لديه امتيازات المشرف المطلوبة إدارة تصنيفات.

يوضّح عينة التعليمات البرمجية التالي كيفية استخدام طريقة create لإنشاء تصنيف إداري عادي يتضمّن عنوانًا محدّدًا وعنصر SelectionOptions واحدًا Field مع عنصرَين من Choice.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

غيِّر القيم في السلسلة على الشكل التالي:

• TITLE: عنوان التصنيف
• ‫DISPLAY_NAME: الاسم المعروض للحقل.
• CHOICE_1: الخيار الأول في الحقل SelectionOptions
• CHOICE_2: تمثّل هذه السمة الخيار الثاني في حقل SelectionOptions.

يتم إنشاء التصنيف في UNPUBLISHED_DRAFT State. يجب أن يكون التصنيف PUBLISHED ليكون مرئيًا للمستخدمين وليتم استخدامه في الملفات. لمزيد من المعلومات، راجِع دورة حياة التصنيف.

حدود التصنيفات

تنطبق الحدود القصوى التالية عند إنشاء التصنيفات وتطبيقها:

• التصنيفات العادية: 150
• الحقول لكل تصنيف: 10

استخدام الحقول في التصنيفات

يوضّح الجدول التالي أنواع الحقول التي يمكنك إضافتها إلى تصنيف، وكيفية تفاعل المستخدمين معها، واعتبارات التنسيق والحدود الخاصة بها:

Field Type	الإجراءات التي يمكن للمستخدمين اتّخاذها	اعتبارات التنسيق والحدود القصوى له
SelectionOptions	تحديد خيار واحد أو أكثر من القائمة	الحد الأقصى لعدد الخيارات المتاحة هو 200 الحد الأقصى لعدد الاختيارات في الملف الواحد هو 10 كما هو موضّح في ListOptions
IntegerOptions	إدخال قيمة رقمية	يمكن استخدام أرقام صحيحة فقط
DateOptions	اختيار تاريخ من التقويم	(اختياري) يمكن ضبط DateFormat على "طويل: الشهر ي ي، س س س س" أو "قصير: ش ش/ي ي/س س"
TextOptions	إدخال نص في مربّع نص	أقصى عدد أحرف مسموح به هو 100.
UserOptions	اختَر مستخدمًا واحدًا أو أكثر من جهات اتصال Google Workspace.	الحد الأقصى لعدد إدخالات المستخدمين لملف هو 10 كما هو موضّح في ListOptions

نشر تصنيف

يتيح لك Drive Labels API نشر مسودة تسمية بعد اكتمالها. بعد ذلك، يصبح التصنيف مرئيًا للمستخدمين ويمكن تطبيقه على الملفات.

لنشر تصنيف، استخدِم طريقة publish في المورد labels وحدِّد ما يلي:

• labels مورد يمثّل كل تصنيف. يتضمّن هذا العنصر مرجعًا name وid، وهو معرّف فريد عالميًا للتصنيف.

• تم ضبط مَعلمة طلب البحث useAdminAccess على true لاستخدام بيانات اعتماد المشرف الخاصة بالمستخدم. قبل السماح بالوصول، يتأكّد الخادم من أنّ المستخدم لديه امتيازات المشرف المطلوبة إدارة تصنيفات.

يوضّح نموذج الرمز البرمجي التالي كيفية استخدام id الخاص بالتصنيف لتحديد التصنيف الصحيح ونشره.

Python

service.labels().publish(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

استبدِل ID بمعرّف التصنيف الذي تريد نشره.

بعد نشر التصنيف، يتم نقله إلى PUBLISHED State ويتم زيادة رقم تعريف مراجعة التصنيف. سيظهر التصنيف بعد ذلك للمستخدمين ويمكن تطبيقه على الملفات. لمزيد من المعلومات، يُرجى الاطّلاع على دورة حياة التصنيف.

القيود عند نشر التصنيفات

عند الاستعداد لنشر التصنيفات، يُرجى الانتباه إلى القيود التالية:

• بعد نشر تصنيف، لا يمكن إعادته إلى حالة المسودة الأصلية. لمزيد من المعلومات، راجِع دورة حياة التصنيف.

• يؤدي نشر تصنيف إلى إنشاء مراجعة منشورة حديثًا. يتم حذف جميع مسودات المراجعات السابقة. يتم الاحتفاظ بالمراجعات المنشورة سابقًا، ولكن يمكن حذفها تلقائيًا حسب الحاجة.

• بعد النشر، لن يُسمح بإجراء بعض التغييرات. وبشكلٍ عام، يعني ذلك أنّه سيتم رفض أي تغيير يؤدي إلى إبطال صحة البيانات الوصفية الحالية المرتبطة بالتصنيف أو فرض قيود جديدة عليها. على سبيل المثال، لا يُسمح بإجراء التغييرات التالية على تصنيف بعد نشره:

  • يتم حذف التصنيف مباشرةً. (يجب إيقافه أولاً، ثم حذفه).
  • تم تغيير Field.FieldType.
  • تؤدي التحديثات على خيارات التحقّق من الصحة في Field إلى رفض محتوى كان مقبولاً في السابق.
  • انخفاض في الحد الأقصى لعدد الإدخالات