ایجاد و انتشار برچسب

این سند نحوه ایجاد و انتشار برچسب‌ها را با استفاده از API برچسب‌های گوگل درایو شرح می‌دهد.

ایجاد برچسب

برای ایجاد یک برچسب، از متد create روی منبع labels استفاده کنید. برچسب‌ها می‌توانند به صورت اختیاری شامل یک یا چند شیء Field باشند.

همچنین باید مشخص کنید:

• یک شیء LabelType .

• یک title برچسب از طریق شیء Properties .

• پارامتر پرس‌وجوی useAdminAccess برای استفاده از اعتبارنامه‌های مدیر کاربر، روی true تنظیم شده است. قبل از اجازه دسترسی، سرور تأیید می‌کند که کاربر دارای امتیازات مدیریتی لازم برای مدیریت برچسب‌های طبقه‌بندی است.

نمونه کد زیر نحوه استفاده از متد create را برای ایجاد یک برچسب استاندارد و مدیریتی با یک عنوان مشخص و یک Field SelectionOptions با دو شیء Choice نشان می‌دهد.

پایتون

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()

نود جی اس

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 .

این برچسب در State UNPUBLISHED_DRAFT ایجاد می‌شود. برای اینکه برچسب برای کاربران قابل مشاهده و در فایل‌ها قابل استفاده باشد، باید PUBLISHED شود. برای اطلاعات بیشتر، به چرخه حیات برچسب مراجعه کنید.

محدودیت‌های برچسب

محدودیت‌های زیر هنگام ایجاد و اعمال برچسب‌ها اعمال می‌شوند:

• برچسب‌های استاندارد: ۱۵۰
• فیلدها در هر برچسب: 10

کار با فیلدها در برچسب‌ها

جدول زیر انواع فیلدهایی را که می‌توانید به یک برچسب اضافه کنید، نحوه تعامل کاربران با آنها و ملاحظات و محدودیت‌های قالب‌بندی آنها را شرح می‌دهد:

Field Type	کاربران چه کاری می‌توانند انجام دهند	ملاحظات و محدودیت‌های قالب‌بندی
SelectionOptions	انتخاب یک یا چند گزینه از لیست	حداکثر تعداد گزینه‌های پشتیبانی شده ۲۰۰ است حداکثر تعداد انتخاب‌ها برای یک فایل، همانطور که در ListOptions پیکربندی شده است، 10 است.
IntegerOptions	مقدار عددی را وارد کنید	فقط اعداد صحیح پشتیبانی می‌شوند
DateOptions	انتخاب تاریخ تقویمی	(اختیاری) DateFormat را می‌توان روی «بلند: ماه روز، سال» یا «کوتاه: ماه/روز/سال» تنظیم کرد.
TextOptions	متن را در کادر متن وارد کنید	حداکثر تعداد کاراکتر پشتیبانی شده ۱۰۰ است
UserOptions	یک یا چند کاربر را از مخاطبین Google Workspace انتخاب کنید.	حداکثر تعداد ورودی‌های کاربر برای یک فایل، همانطور که در ListOptions پیکربندی شده است، 10 است.

انتشار یک برچسب

رابط برنامه‌نویسی کاربردی Drive Labels به شما امکان می‌دهد پس از تکمیل برچسب، آن را منتشر کنید. سپس این برچسب برای کاربران قابل مشاهده است و می‌تواند روی فایل‌ها اعمال شود.

برای انتشار یک برچسب، از متد publish روی منبع labels استفاده کنید و موارد زیر را مشخص کنید:

• یک منبع labels که نمایانگر هر برچسب است. این منبع شامل یک name منبع و یک id است که یک شناسه منحصر به فرد جهانی برای برچسب است.

• پارامتر پرس‌وجوی useAdminAccess برای استفاده از اعتبارنامه‌های مدیر کاربر، روی true تنظیم شده است. قبل از اجازه دسترسی، سرور تأیید می‌کند که کاربر دارای امتیازات مدیریتی لازم برای مدیریت برچسب‌های طبقه‌بندی است.

نمونه کد زیر نحوه استفاده از id برچسب برای شناسایی و انتشار برچسب صحیح را نشان می‌دهد.

پایتون

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

نود جی اس

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 شناسه برچسبی که می‌خواهید منتشر کنید را قرار دهید.

پس از انتشار برچسب، آن به State PUBLISHED منتقل می‌شود و شناسه‌ی ویرایش برچسب یک واحد افزایش می‌یابد. سپس برچسب برای کاربران قابل مشاهده است و می‌تواند روی فایل‌ها اعمال شود. برای اطلاعات بیشتر، به چرخه‌ی حیات برچسب مراجعه کنید.

محدودیت‌ها هنگام انتشار برچسب‌ها

هنگام آماده شدن برای انتشار برچسب‌ها، به این محدودیت‌ها توجه داشته باشید:

• پس از انتشار، یک برچسب نمی‌تواند به حالت اولیه‌ی پیش‌نویس خود بازگردد. برای اطلاعات بیشتر، به چرخه‌ی حیات برچسب مراجعه کنید.

• انتشار یک برچسب، یک نسخهٔ جدید منتشر شده ایجاد می‌کند. تمام نسخه‌های پیش‌نویس قبلی حذف می‌شوند. نسخه‌های منتشر شدهٔ قبلی نگه داشته می‌شوند اما در صورت نیاز، به صورت خودکار حذف می‌شوند.

• پس از انتشار، برخی از تغییرات دیگر مجاز نیستند. به‌طورکلی، این بدان معناست که هر تغییری که فراداده‌های موجود مربوط به برچسب را نامعتبر کند یا محدودیت‌های جدیدی ایجاد کند، رد می‌شود. به‌عنوان مثال، تغییرات زیر در یک برچسب پس از انتشار برچسب مجاز نیستند:

  • برچسب مستقیماً حذف می‌شود. (ابتدا باید غیرفعال شود، سپس حذف شود.)
  • Field.FieldType تغییر کرده است.
  • به‌روزرسانی‌های گزینه‌های اعتبارسنجی Field ، چیزی را که قبلاً پذیرفته شده بود، رد می‌کند.
  • کاهش حداکثر ورودی‌ها.