ایجاد & یک برچسب منتشر کنید

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

ایجاد برچسب

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

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

• LabelType ).

• title برچسب از طریق متد property .

• برای استفاده از اعتبارنامه‌های مدیر کاربر، useAdminAccess true است. سرور قبل از دادن دسترسی، تأیید می‌کند که کاربر مدیر با امتیاز «مدیریت برچسب‌ها» است.

این مثال یک برچسب استاندارد و مدیریتی با یک عنوان مشخص و یک Field SelectionOptions با دو 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()

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 شود. برای اطلاعات بیشتر، به چرخه حیات برچسب مراجعه کنید.

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

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

• برچسب‌های استاندارد—۱۵۰
• فیلدها در هر برچسب—۱۰
• برچسب‌های اعمال‌شده توسط کاربر برای هر فایل—5

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

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

API برچسب‌ها به شما امکان می‌دهد پس از تکمیل برچسب، آن را منتشر کنید.

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

• یک منبع Label که هر برچسب را نشان می‌دهد. این شامل یک منبع Name و ID است که یک شناسه منحصر به فرد جهانی برای برچسب است.

• برای استفاده از اعتبارنامه‌های مدیر کاربر، useAdminAccess true است. سرور قبل از دادن دسترسی، تأیید می‌کند که کاربر مدیر با امتیاز «مدیریت برچسب‌ها» است.

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

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

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 تغییر کرده است.
  • به‌روزرسانی‌های گزینه‌های اعتبارسنجی فیلد، چیزی را که قبلاً پذیرفته شده بود، رد می‌کند.
  • کاهش حداکثر ورودی‌ها.