این صفحه نحوه ایجاد و انتشار یک برچسب را توضیح می دهد.
یک برچسب ایجاد کنید
برای ایجاد یک برچسب، از متد create
در مجموعه labels
استفاده کنید. برچسب ها می توانند به صورت اختیاری شامل یک یا چند Fields
باشند.
همچنین باید مشخص کنید:
title
برچسب از طریق روشproperty
.useAdminAccess
برای استفاده از اعتبار مدیر کاربرtrue
است. سرور قبل از اجازه دسترسی، تأیید میکند که کاربر یک سرپرست با امتیاز «مدیریت برچسبها» است.
این مثال یک برچسب استاندارد و مدیریت با عنوان مشخص و یک Field
SelectionOptions
با 2 Choices
ایجاد میکند.
پایتون
label_body = {
'label_type': 'ADMIN',
'properties': {
'title': 'TITLE'
},
'fields': [{
'properties': {
'display_name': 'DISPLAY_NAME'
},
'selection_options': {
'list_options': {},
'choices': [{
'properties': {
'display_name': 'CHOICE_1'
}
}, {
'properties': {
'display_name': 'CHOICE_2'
}
}]
}
}]
}
response = service.labels().create(
body=label_body, useAdminAccess=True).execute()
Node.js
var label = {
'label_type': 'ADMIN',
'properties': {
'title': 'TITLE'
},
'fields': [{
'properties': {
'display_name': 'DISPLAY_NAME'
},
'selection_options': {
'list_options': {},
'choices': [{
'properties': {
'display_name': 'CHOICE_1'
}
}, {
'properties': {
'display_name': 'CHOICE_2'
}
}]
}
}]
};
service.labels.create({
'resource': label,
'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
برچسب در State
UNPUBLISHED_DRAFT
ایجاد شده است. برای استفاده در فایل ها و قابل مشاهده بودن برای کاربران باید PUBLISHED
شود. برای اطلاعات بیشتر، چرخه عمر برچسب را ببینید.
محدودیت های برچسب
محدودیت های زیر هنگام ایجاد و اعمال برچسب ها اعمال می شود:
- برچسب های استاندارد - 150
- فیلدها در هر برچسب - 10
- برچسب های اعمال شده توسط کاربر در هر فایل-5
کار با فیلدها در برچسب ها
Field Type | کاری که کاربران می توانند انجام دهند | ملاحظات و محدودیت ها را قالب بندی کنید |
---|---|---|
SelectionOptions | یک یا چند گزینه را از یک لیست انتخاب کنید | حداکثر تعداد گزینه های پشتیبانی شده 200 است حداکثر تعداد انتخاب برای یک فایل 10 است که در ListOptions پیکربندی شده است |
IntegerOptions | یک مقدار عددی وارد کنید | فقط اعداد کامل پشتیبانی می شوند |
DateOptions | تاریخ تقویم را انتخاب کنید | (اختیاری) Date format می توان روی «طولانی: ماه روز، سال، سال» یا «کوتاه: MM/DD/YY» تنظیم کرد |
TextOptions | متن را در یک جعبه متن وارد کنید | حداکثر تعداد کاراکتر پشتیبانی شده 100 است |
UserOptions | یک یا چند کاربر را از مخاطبین Google Workspace انتخاب کنید. | حداکثر تعداد ورودی های کاربر برای یک فایل 10 است که در ListOptions پیکربندی شده است |
یک برچسب منتشر کنید
Labels API به شما امکان می دهد یک برچسب پیش نویس را پس از تکمیل آن منتشر کنید.
برای انتشار یک برچسب، از روش publish
استفاده کنید و مشخص کنید:
یک منبع برچسب که هر برچسب را نشان می دهد. این شامل یک
Name
وID
منبع است که یک شناسه منحصر به فرد جهانی برای برچسب است.useAdminAccess
برای استفاده از اعتبار مدیر کاربرtrue
است. سرور قبل از اجازه دسترسی، تأیید میکند که کاربر یک سرپرست با امتیاز «مدیریت برچسبها» است.
این مثال از ID
برای شناسایی و انتشار برچسب صحیح استفاده می کند.
پایتون
service.labels().publish(
name='labels/ID',
body={
'use_admin_access': True
}).execute()
Node.js
service.labels.publish({
'resource': {
'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
هنگامی که برچسب منتشر شد، برچسب به State
PUBLISHED
منتقل می شود و شناسه بازبینی برچسب افزایش می یابد. سپس این برچسب برای کاربران قابل مشاهده است و می تواند روی فایل ها اعمال شود. برای اطلاعات بیشتر، چرخه عمر برچسب را ببینید.
محدودیت ها هنگام انتشار برچسب ها
پس از انتشار، برچسب نمی تواند به حالت پیش نویس اولیه خود بازگردد. برای اطلاعات بیشتر، چرخه عمر برچسب را ببینید.
انتشار یک برچسب یک ویرایش تازه منتشر شده ایجاد می کند. همه پیشنویسهای قبلی حذف میشوند. ویرایشهای منتشر شده قبلی حفظ میشوند اما در صورت نیاز به صورت خودکار حذف میشوند.
پس از انتشار، برخی از تغییرات دیگر مجاز نیستند. به طور کلی، این بدان معنی است که هر تغییری که باعث بی اعتباری یا ایجاد محدودیتهای جدید در ابردادههای موجود مرتبط با برچسب شود، رد میشود. برای مثال، تغییرات زیر در یک برچسب پس از انتشار برچسب مجاز نیست:
- برچسب مستقیماً حذف می شود. (اول باید غیرفعال شود، سپس حذف شود.)
-
Field.FieldType
تغییر کرده است. - بهروزرسانیهای گزینههای اعتبارسنجی فیلد، چیزی را که قبلاً پذیرفته شده بود رد میکند.
- کاهش در حداکثر ورودی.